VTK/Wrappers/Command Line Arguments: Difference between revisions
From KitwarePublic
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 12: | Line 12: | ||
|- | |- | ||
| -o <file> | | -o <file> | ||
| the output file | | the output file <font color='green'>(new for VTK 6.0)</font> | ||
|- | |- | ||
| -I <dir> | | -I <dir> | ||
| add an include directory | | add an include directory <font color='green'>(new for VTK 5.8)</font> | ||
|- | |- | ||
| -D <macro[=definition]> | | -D <macro[=definition]> | ||
| define a macro (the definition is optional) | | define a macro (the definition is optional) <font color='green'>(new for VTK 5.8)</font> | ||
|- | |- | ||
| -U <macro> | | -U <macro> | ||
| undefine a macro | | undefine a macro <font color='green'>(new for VTK 5.8)</font> | ||
|- | |- | ||
| @<file> | | @<file> | ||
| read command-line arguments from the specified file | | read command-line arguments from the specified file <font color='green'>(new for VTK 6.0)</font> | ||
|- | |- | ||
| --hints <file> | | --hints <file> | ||
| hints file, usually called "hints" | | hints file, usually called "hints" <font color='green'>(new for VTK 5.8)</font> | ||
|- | |- | ||
| --types <file> | | --types <file> | ||
| type hierarchy file, usually ends in "Hierarchy.txt" | | type hierarchy file, usually ends in "Hierarchy.txt" <font color='green'>(new for VTK 5.8)</font> | ||
|- | |- | ||
| --version | | --version | ||
| print the VTK version number of the tool | | print the VTK version number of the tool <font color='green'>(new for VTK 5.10)</font> | ||
|- | |- | ||
| --help | | --help | ||
| print a short help message | | print a short help message <font color='green'>(new for VTK 5.10)</font> | ||
|- | |||
|} | |||
The "@file" option allows one or more of the command-line arguments to be stored in a "response file". If the file that appears after the "@" does not exist, then "@file" will, itself, be treated as a command-line argument. This behavior was chosen for consistency with gcc, which also supports response files. | |||
Four options that were available in VTK 5.8 and 5.10 have been deprecated in VTK 6. As of VTK 6, the wrappers will automatically detect abstract classes: | |||
{| class="wikitable" | |||
|- | |||
! option | |||
! description | |||
|- | |- | ||
| --concrete | | --concrete | ||
| force the wrappers to wrap the input as a concrete class | | force the wrappers to wrap the input as a concrete class <font color='green'>(VTK 5.8, 5.10 only)</font> | ||
|- | |- | ||
| --abstract | | --abstract | ||
| force the wrappers to wrap the input as an abstract class | | force the wrappers to wrap the input as an abstract class <font color='green'>(VTK 5.8, 5.10 only)</font> | ||
|- | |- | ||
| --vtkobject | | --vtkobject | ||
| inform the wrappers that the class is derived from vtkObjectBase | | inform the wrappers that the class is derived from vtkObjectBase <font color='green'>(VTK 5.8, 5.10 only)</font> | ||
|- | |- | ||
| --special | | --special | ||
| inform the wrappers that the class is not derived from vtkObjectBase | | inform the wrappers that the class is not derived from vtkObjectBase <font color='green'>(VTK 5.8, 5.10 only)</font> | ||
|- | |- | ||
|} | |} | ||
Latest revision as of 16:25, 7 November 2012
As of VTK 6, the wrapper command-line tools are used as follows:
vtkWrapPython [options] class.h
Many of the options are similar to those of the unix "cc" compiler. The available options are as follows:
| option | description |
|---|---|
| -o <file> | the output file (new for VTK 6.0) |
| -I <dir> | add an include directory (new for VTK 5.8) |
| -D <macro[=definition]> | define a macro (the definition is optional) (new for VTK 5.8) |
| -U <macro> | undefine a macro (new for VTK 5.8) |
| @<file> | read command-line arguments from the specified file (new for VTK 6.0) |
| --hints <file> | hints file, usually called "hints" (new for VTK 5.8) |
| --types <file> | type hierarchy file, usually ends in "Hierarchy.txt" (new for VTK 5.8) |
| --version | print the VTK version number of the tool (new for VTK 5.10) |
| --help | print a short help message (new for VTK 5.10) |
The "@file" option allows one or more of the command-line arguments to be stored in a "response file". If the file that appears after the "@" does not exist, then "@file" will, itself, be treated as a command-line argument. This behavior was chosen for consistency with gcc, which also supports response files.
Four options that were available in VTK 5.8 and 5.10 have been deprecated in VTK 6. As of VTK 6, the wrappers will automatically detect abstract classes:
| option | description |
|---|---|
| --concrete | force the wrappers to wrap the input as a concrete class (VTK 5.8, 5.10 only) |
| --abstract | force the wrappers to wrap the input as an abstract class (VTK 5.8, 5.10 only) |
| --vtkobject | inform the wrappers that the class is derived from vtkObjectBase (VTK 5.8, 5.10 only) |
| --special | inform the wrappers that the class is not derived from vtkObjectBase (VTK 5.8, 5.10 only) |
