VTK/Wrappers/Command Line Arguments

From KitwarePublic
< VTK‎ | Wrappers
Jump to navigationJump to search

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)