declarations.box.macrotool

Defines classes for macro tools, special forms of function boxes that allow the relation constraints in which they’re included to be used as a macros.

class MacroToolBoxDeclaration(name, groupName, typeName)

Bases: fbrelation.declarations.box.function.FunctionBoxDeclaration

Defines the base class for a macro tool box, which may be either an input or an output within some relation constraint.

createNodeDeclaration(nodeName, isSrc)

Overridden to use the MacroToolNodeDeclaration class for nodes that reference macro inputs or outputs.

supportsNode(nodeName)

Overridden to require that no nodeName be specified in the connection declaration, since a macro tool has exactly one input or output node, which is not addressed by name.

isMacroTool(isInput)

Overridden to be pure virtual, since for a generalized macro tool the significance of isInput can not be determined.

class MacroInputBoxDeclaration(name, inputType)

Bases: fbrelation.declarations.box.macrotool.MacroToolBoxDeclaration

Defines the declaration of a macro input box, which has a single output node within some relation constraint.

__init__(name, inputType)

Initializes a macro input box of the specified type, passing the appropriate group and type name to the superclass constructor.

Parameters:inputType – Valid built-in types are “Bool”, “ColorAndAlpha”, “Number”, “Time”, and “Vector”.

isMacroTool(isInput)

Overridden to indicate that this box is an input macro tool.

class MacroOutputBoxDeclaration(name, outputType)

Bases: fbrelation.declarations.box.macrotool.MacroToolBoxDeclaration

Defines the declaration of a macro output box, which has a single input node within some relation constraint.

__init__(name, outputType)

Initializes a macro output box of the specified type, passing the appropriate group and type name to the superclass constructor.

Parameters:outputType – Valid built-in types are “Bool”, “ColorAndAlpha”, “Number”, “Time”, and “Vector”.

isMacroTool(isInput)

Overridden to indicate that this box is an output macro tool.