star-3dut

Generate meshes of simple geometric shapes
git clone git://git.meso-star.fr/star-3dut.git
Log | Files | Refs | README | LICENSE

README.md (2348B)

      1 # Star-3DUtilityToolkit
      2 
      3 The Star-3DUT library generates the triangular mesh of 3D geometric
      4 shapes. See the `s3dut.h` header file for the list of supported
      5 geometries.
      6 
      7 ## Requirements
      8 
      9 - C compiler
     10 - POSIX make
     11 - pkg-config
     12 - [RSys](https://gitlab.com/vaplv/rsys/)
     13 
     14 ## Installation
     15 
     16 Edit config.mk as needed, then run:
     17 
     18     make clean install
     19 
     20 ## Release notes
     21 
     22 ### Version 0.4
     23 
     24 - Replace CMake by Makefile as build system.
     25 - Update compiler and linker flags to increase the security and
     26   robustness of generated binaries.
     27 - Provide a pkg-config file to link the library as an external
     28   dependency.
     29 
     30 ### Version 0.3.3
     31 
     32 - Sets the CMake minimum version to 3.1: since CMake 3.20, version 2.8
     33   has become obsolete.
     34 
     35 ### Version 0.3.2
     36 
     37 - Make the `s3dut.h` header compatible with C++.
     38 
     39 ### Version 0.3.1
     40 
     41 - Update the version of the RSys dependency to 0.6: replace the
     42   deprecated `[N]CHECK` macros by the new macro `CHK`.
     43 
     44 ### Version 0.3
     45 
     46 - Add the `s3dut_create_thin_cylinder` function that creates a
     47   triangulated cylinder. Both ends can be closed or left open.
     48 - Add the `s3dut_create_thick_cylinder` function that creates a thick
     49   triangulated cylinder. Both ends can be closed or left open.
     50 - Add the `s3dut_create_truncated_sphere` function that creates a
     51   triangulated UV sphere (possibly) truncated along the Z axis.
     52   Truncated ends can be closed or left open.
     53 - Add the `s3dut_create_thick_truncated_sphere` function that creates a
     54   thick triangulated UV sphere (possibly) truncated along the Z axis.
     55   Truncated ends can be closed or left open.
     56 - Add the `s3dut_create_super_shape` function that creates a
     57   triangulated super shape.
     58 - Add the `s3dut_create_thick_truncated_super_shape` function that
     59   creates a thick triangulated super shape (possibly) truncated along
     60   the Z axis. Truncated ends can be closed or left open.
     61 - Increase min number of slices for `s3dut_create_hemisphere` from 2 to
     62   3.
     63 
     64 ### Version 0.2
     65 
     66 - Add the `s3dut_create_hemisphere` function that creates a triangulated
     67   UV hemisphere oriented along the positive Z axis.
     68 
     69 ## License
     70 
     71 Copyright (C) 2016, 2017, 2020, 2021, 2023 |Méso|Star> (contact@meso-star.com)
     72 
     73 Star-3DUT is free software released under GPL v3+ license: GNU GPL
     74 version 3 or later. You are welcome to redistribute it under certain
     75 conditions; refer to the COPYING file for details.