Package autodesk_toxik :: Module graph :: Class Tool

Class Tool

 object --+    
          |    
Boost.Python.instance --+
              |
             Tool

Contains the description of a plug-in tool which drives tool node instances.

Instance Methods

__cmp__(...)

__init__(...)
Raises an exception This class cannot be instantiated from Python

__reduce__(...)
helper for pickle

str

getCategory(...)
Returns: The tool category string.

str

getDescription(...)
Returns: The tool description string.

str

getId(...)
Returns: The tool uuid string.

dict

getInputSpecs(...)
Returns: A dict of the tool's input socket names to a SocketSpec object.

str

getManufacturer(...)
Returns: The tool manufacturer string.

str

getName(...)
Returns: The name of the tool.

dict

getOutputSpecs(...)
Returns: A dict of the tool's output socket names to a SocketSpec object.

SocketSpec

getPrimaryInput(...)
Returns: A SocketSpec object for the primary input of the tool, if any, and None otherwise.

int

getSchemaNb(...)
Returns: The tool schema number.

dict

getValueSpecs(...)
Returns: A dict of the tool's value names to their value type (ValueType enumeration class).

str

getVersion(...)
Returns: The tool version string.

bool

isActive(...)
Returns: True if the tool is active.

bool

isInternal(...)
Returns: True if the tool is an internal (private) Toxik tool.

Inherited from Boost.Python.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
Inherited from `object`: `__class__`

Method Details

init(...)
(Constructor)

Raises an exception This class cannot be instantiated from Python

Overrides: object.__init__

reduce(...)

helper for pickle

Overrides: object.__reduce__: (inherited documentation)

getCategory(...)

Returns: str: The tool category string.

getDescription(...)

Returns: str: The tool description string.

getId(...)

Returns: str: The tool uuid string.

getInputSpecs(...)

Returns: dict: A dict of the tool's input socket names to a SocketSpec object.

getManufacturer(...)

Returns: str: The tool manufacturer string.

getName(...)

Returns: str: The name of the tool.

getOutputSpecs(...)

Returns: dict: A dict of the tool's output socket names to a SocketSpec object.

getPrimaryInput(...)

Returns: SocketSpec: A SocketSpec object for the primary input of the tool, if any, and None otherwise.

getSchemaNb(...)

Returns: int: The tool schema number. The schema number is an integer representing the version of the tool or it's evolution stage. Tool schema numbers don't necessarily increment linearly.

getValueSpecs(...)

Returns: dict: A dict of the tool's value names to their value type (ValueType enumeration class).

getVersion(...)

Returns: str: The tool version string.

isActive(...)

Returns: bool: True if the tool is active. An active tool is a tool whose plug-in is loaded in memory and that can process its input. Inactive tools also show up with their description, but cannot process their input.

isInternal(...)

Returns: bool: True if the tool is an internal (private) Toxik tool.

Class Tool

__init__(...) (Constructor)

__reduce__(...)

getCategory(...)

getDescription(...)

getId(...)

getInputSpecs(...)

getManufacturer(...)

getName(...)

getOutputSpecs(...)

getPrimaryInput(...)

getSchemaNb(...)

getValueSpecs(...)

getVersion(...)

isActive(...)

isInternal(...)

init(...)
(Constructor)

reduce(...)