IG Data Creation Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== How to run IG.Model.Processor ======

The program is run via the command line. The main syntax is:

<code bash>
./IG_Model_Processor --model <MODEL> --file <PATH> [options]
</code>

===== Main Options =====
  * **--model {SOLID, FLAT, EXTRUSION, REVOLUTION}**
    Select the model to be processed. Model names are case-insensitive (e.g., SOLID, solid, Solid).\\
    Default: ''SOLID''\\
    Example: ''--model SOLID''
    
  * **--file <path>**
    Specify the absolute path of the file to be processed. The file format depends on the selected model (e.g., JSON for SOLID).\\
    Default: empty\\
    Example: ''--file C:/path/to/your/file/test.json''
    
  * **--output {obj, stl, step, all, ctm, obj+ctm}**
    Specify the output format(s). Case-insensitive.\\
    Default: ''obj''\\
    Example: ''--output obj''
    
  * **--out <path>**
    Optional. Specify the output folder for generated models.\\
    Default: ''c:/tmp''\\
    Example: ''--out C:/path/to/your/folder/''
    
  * **--no-uvs**
    Disable UV generation for the ''.obj'' output.\\
    If specified, no UV coordinates will be included.\\
    Additionally, no post-processing of mesh shading will be performed; the mesh will be outputted with flat shading.

  * **--quality**
    Overwrite JSON quality parameters.
    
  * **--help**
    Display the help message and exit.

===== Example Command =====

To process a flat panel JSON file and generate an OBJ output:

<code bash>
./IG_Model_Processor --model flat --file flatPanel-104-triangle.json --output OBJ
</code>

====== Recommendations for First-Time Users ======

Use one of the sample JSON files as an example. There are also ''.bat'' files (Windows) with corresponding names for each sample. You can run them if the BAT file and JSON are in the same directory as the IG.Model.Processor executable.

Change a parameter and observe how the geometry behaves. Each parameter’s meaning can be found in the spec sheets for each model, also referenced in this documentation. Example commands will work if your JSON file is placed in the same directory as the IG.Model.Processor executable and your terminal is pointing to root of Model.Processor, for both Linux and Windows.

===== Extrusion Sample command and file list. =====

**Model Flag:**
  --extrusion

  * **extrusion-101-min1.4.json**
    Example commands:
    
    **Linux:**
<code bash>
./IG_Model_Processor --model extrusion --file extrusion-101-min1.4.json --output OBJ
</code>
    
    **Windows:**
<code bash>
IG.Model.Processor.exe --model extrusion --file extrusion-101-min1.4.json --output OBJ
</code>

Sample File List:
  extrusion-101-min1.4.json


-----

===== Flat / FlatPanel Sample command and file list. =====

**Model Flag:**
  --flat or --flatpanel

  * **flatPanel-101-horizontal-min1.4.json**
    Example commands:
    
    **Linux:**
<code bash>
./IG_Model_Processor --model flatpanel --file flatPanel-101-horizontal-min1.4.json --output OBJ
</code>
    
    **Windows:**
<code bash>
IG.Model.Processor.exe --model flatpanel --file flatPanel-101-horizontal-min1.4.json --output OBJ
</code>
		
Sample File List:
  flatPanel-101-horizontal-min1.4.json
  flatPanel-102-vertical-min1.4.json
  flatPanel-103-solid-min1.4.json
  flatPanel-104-triangle-min1.4.json
  flatPanel-111-horizontal-raised-min1.4.json
  flatPanel-112-vertical-raised-min1.4.json
  flatPanel-113-solid-raised-min1.4.json
  flatPanel-114-triangle-raised-min1.4.json
  flatPanel-115-vertical-arched-panel-min1.4.json


-----

===== Solid Sample command and file list. =====

**Model Flag:**
  --solid

  * **solid-101-min1.4.json**
    Example commands:
    
    **Linux:**
<code bash>
./IG_Model_Processor --model solid --file solid-101-min1.4.json --output OBJ
</code>
    
    **Windows:**
<code bash>
IG.Model.Processor.exe --model solid --file solid-101-min1.4.json --output OBJ
</code>
		
Sample File List:
  solid-101-min1.4.json
  solid-102-min1.4.json
  solid-103-min1.4.json
  solid-104-min1.4.json
  solid-111-min1.4.json
  solid-112-min1.4.json
  solid-113-min1.4.json
  solid-114-default-min1.4.json
  solid-114-min1.4.json
  solid-131-square-path-min1.4.json
  solid-132-beveled-path-min1.4.json
  solid-134-arched-panel-min1.4.json
  solid-135-square-with-profile-min1.4.json


-----

===== Revolution Sample command and file list. =====

**Model Flag:**
  --revolution

  * **revolution-101.json**
    Example commands:
    
    **Linux:**
<code bash>
./IG_Model_Processor --model revolution --file revolution-101.json --output OBJ
</code>
    
    **Windows:**
<code bash>
IG.Model.Processor.exe --model revolution --file revolution-101.json --output OBJ
</code>
		
Sample File List:
  revolution-101.json