Skip to content

Commit

Permalink
v1.50 update
Browse files Browse the repository at this point in the history
  • Loading branch information
soonjokwon committed Aug 5, 2024
1 parent bee882a commit d856131
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 18 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,19 @@
The NIST [STEP to X3D Translator](https://www.nist.gov/services-resources/software/step-x3d-translator) is an open-source software that translates a STEP (ISO 10303) Part 21 file (.stp or .step) to an X3D (ISO/IEC 19776) file (.x3d) or [X3DOM](https://www.x3dom.org/) file (.html). Developed at the National Institute of Standards and Technology (NIST), the software is based on the [Open CASCADE STEP Processor](https://dev.opencascade.org/doc/overview/html/occt_user_guides__step.html) and written in C++.

## Prerequisites
- [Open CASCADE Technology](https://www.opencascade.com/content/latest-release) (OCCT) 7.7.0 or higher
- You must [rebuild the OCCT solution](https://dev.opencascade.org/doc/occt-7.7.0/overview/html/build_upgrade__building_occt.html) to regenerate DLL files.
- [Open CASCADE Technology](https://www.opencascade.com/content/latest-release) (OCCT) 7.8.0 or higher
- You must [rebuild the OCCT solution](https://dev.opencascade.org/doc/overview/html/build_upgrade__building_occt.html) to regenerate DLL files.
- vc14 or higher (x64) should be selected.
- The complete set of DLL files required for STP2X3D to run is as follows.
- OCCT related: freetype.dll, TKBO.dll, TKBRep.dll, TKCAF.dll, TKCDF.dll, TKernel.dll, TKG2d.dll, TKG3d.dll, TKGeomAlgo.dll, TKGeomBase.dll, TKHLR.dll, TKLCAF.dll. TKMath.dll, TKMesh.dll, TKPrim.dll, TKService.dll, TKShHealing.dll, TKSTEP.dll, TKSTEP209.dll, TKSTEPAttr.dll, TKSTEPBase.dll, TKTopAlgo.dll, TKV3d.dll, TKVCAF.dll, TKXCAF.dll, TKXDE.dll, TKXDESTEP.dll, TKXSBase.dll
- OCCT related: freetype.dll, jemalloc.dll, TKBO.dll, TKBRep.dll, TKCAF.dll, TKCDF.dll, TKDE.dll, TKDESTEP.dll, TKernel.dll, TKG2d.dll, TKG3d.dll, TKGeomAlgo.dll, TKGeomBase.dll, TKHLR.dll, TKLCAF.dll. TKMath.dll, TKMesh.dll, TKPrim.dll, TKService.dll, TKShHealing.dll, TKTopAlgo.dll, TKV3d.dll, TKVCAF.dll, TKXCAF.dll, TKXSBase.dll
- The list of DLL files has been updated since OCCT 7.8.0 especially STEP-related DLL files.
- [jemalloc.dll should be built](https://jemalloc.net/) and included if the memory manager is set to JeMalloc.
- VC++ related: msvcp140.dll, vcruntime140.dll (vcruntime140_1.dll will also be required when vc141 or higher was used to build.)

## Build the STEP to X3D Translator

### Windows
- Use [CMake](https://cmake.org/) 3.12.2 or higher to build the software.
- Use [CMake](https://cmake.org/) 3.18.4 or higher to build the software.
- vc14 or higher (x64) should be selected for the generator.
- You can also create a new project, include source files, and build the project in Visual Studio.
- Be sure to use Visual Studio 2015 or 2017 due to [std::experimental::filesystem](https://docs.microsoft.com/en-us/cpp/standard-library/filesystem?view=msvc-150). This should be updated later.
Expand All @@ -35,7 +37,7 @@ The NIST [STEP to X3D Translator](https://www.nist.gov/services-resources/softwa
- NIST STP2X3D is a command line software. Please check out the [Usage guide](USAGE.md).

## Work In Progress
- Determination of appropriate tessellation parameters per each body.
- Support of AP242 Domain Model XML format as input

## Contact Information
- Soonjo Kwon, soonjo.kwon@kumoh.ac.kr
Expand All @@ -48,7 +50,7 @@ The NIST [STEP to X3D Translator](https://www.nist.gov/services-resources/softwa
- R. R. Lipman, S. Kwon, 2021, [**STEP File Analyzer and Viewer User Guide (Update 7)**](https://nvlpubs.nist.gov/nistpubs/ams/NIST.AMS.200-12.pdf), *NIST Advanced Manufacturing Series*, 200-12.

## Version
1.21
1.50

## Disclaimers
[NIST Disclaimer](https://www.nist.gov/disclaimer)
2 changes: 1 addition & 1 deletion STP2X3D/S2X_Option.h
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ class S2X_Option
bool TessSolid(void) const { return m_tessSolid; }

// Software version (as of June 2023)
const wstring Version(void) const { return L"1.30"; }
const wstring Version(void) const { return L"1.50"; }

private:
wstring m_input; // Input file path
Expand Down
24 changes: 13 additions & 11 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,19 @@ The following information describes how to use the software. Running the executi
- STP2X3D.exe option1 value1 option2 value2 ..

## Options
- --input: Input STEP file path
- --normal: Normal vector (1:yes, 0:no) default=0
- --color: Color (1:yes, 0:no) default=1
- --edge: Boundary edges (1:yes, 0:no) default=0
- --sketch: Sketch geometry (1:yes, 0:no) default=1
- --html: Output file type (1:html, 0:x3d) default=0
- --quality Mesh quality (1-low to 10-high) default=5
- --gdt Geometric elements related to GD&T (1:yes, 0:no) default=0
- --tess Adaptive tessellation per each body (1:yes, 0:no) default=0
- --rosette Rosette used for Composite Design (1:yes, 0:no) default=0
- --batch Processing multiple STEP files (1:include sub-directories, 0:current dir). Followed by a folder path (e.g. --batch 0 c:\\)
- --input Input STEP file path
- --normal Normal vector (1:yes, 0:no) default=0
- --color Color (1:yes, 0:no) default=1
- --edge Boundary edges (1:yes, 0:no) default=0
- --sketch Sketch geometry (1:yes, 0:no) default=1
- --html Output file type (1:html, 0:x3d) default=0
- --quality Mesh quality (1-low to 10-high) default=5
- --gdt Geometric elements related to GD&T (1:yes, 0:no) default=0
- --tess Adaptive tessellation per each body (1:yes, 0:no) default=0
- --rosette Rosette used for Composite Design (1:yes, 0:no) default=0
- --cap Cap geometries for sections (1:yes, 0:no) default=0
- --tsolid Tessellated solids (1:yes, 0:no) default=1
- --batch Processing multiple STEP files (1:include sub-directories, 0:current dir). Followed by a folder path (e.g. --batch 0 c:\\)

## Examples
- STP2X3D.exe --input Model.stp --edge 1 --quality 7
Expand Down

0 comments on commit d856131

Please sign in to comment.