Previous topic

declarations.box.base

Next topic

declarations.box.macrotool

This Page

declarations.box.function

Defines base classes for box declarations that represent function boxes.

class FunctionBoxDeclaration(name, groupName, typeName)[source]

Bases: fbrelation.declarations.box.base.BoxDeclaration

Base class for function boxes, which are created from a pool of box types types organized into groups. Group and box type names can not be know until runtime, nor can the names of the nodes of any given box type.

__init__(name, groupName, typeName)[source]

Initializes a new function box declaration representing a instance of the given box type from the given group.

execute(constraint, relationComponents)[source]

Executes the box declaration by creating function box of the appropriate type in the given constraint.

Returns:the newly created FBBox.
Raises :an ExecutionError if MotionBuilder does not recognize the group or type name.