< Previous | Contents | Next >
Operator
class Operator
Parent class: Object
Base class for all Tools, Modifiers etc.
Operator Attributes
Attribute Name | Type | Description |
TOOLS_Name | string | The full name of this tool |
TOOLS_Name | string | The full name of this tool |
TOOLB_Visible | integer | Indicates if this tool is visible on the flow, or a non-visible tool, such as a modifier. |
TOOLB_Locked | boolean | Indicates if this tool is locked. |
TOOLB_PassThrough | boolean | Indicates if this tool is set to pass-through. |
TOOLB_HoldOutput | boolean | Indicates if this tool is set to hold its output (not update). |
TOOLB_CtrlWZoom | integer | Indicates if this tool’s control window is open or closed. |
Attribute Name | Type | Description |
TOOLB_NameSet | boolean | Indicates if this tool’s name has been set (by the user) or is the default name. |
TOOLB_CacheToDisk | integer | Indicates if this tool is set to cache itself to disk. |
TOOLS_RegID | string | The RegID of this tool. |
TOOLH_GroupParent | group userdata | The associated group object |
TOOLNT_EnabledRegion_Start | number | The point (frame) at which this tool is enabled, and will start to take effect. |
TOOLNT_EnabledRegion_End | number | The point (frame) at which this tool is disabled, and will cease to have an effect.. |
TOOLNT_Region_Start | number | The point at which this tool can start providing results. |
TOOLNT_Region_End | composition userdata | The point at which this tool stops providing results. |
TOOLN_LastFrameTime | number | The amount of time (in seconds) taken to process the most recently rendered frame by this tool. |
TOOLI_Number_o_Inputs | number | Useful for determining the number of inputs a tool has (implemented for 3D merges). |
TOOLI_ImageWidth | integer | For image-based tools, these represent the format of the image most recently processed by this tool. |
TOOLI_ImageHeight | integer | |
TOOLI_ImageField | integer | |
TOOLI_ImageDepth | integer | |
TOOLN_ImageAspectX | number | |
TOOLN_ImageAspectY | number | |
TOOLST_Clip_Name | string | For clip-based tools (Loader and Saver), one or more entries for these may be present in tables to define information on the clip(s) currently selected into this tool. Note that these attributes actually return a table of values of the type indicated in parenthesis. Each index in the table represents a clip in the cliplist. |
Attribute Name | Type | Description |
TOOLIT_Clip_Width | integer | |
TOOLIT_Clip_Height | integer | |
TOOLIT_Clip_StartFrame | integer | |
TOOLIT_Clip_Length | integer | |
TOOLBT_Clip_IsMultiFrame | boolean | |
TOOLST_Clip_FormatName | string | |
TOOLST_Clip_FormatID | string | |
TOOLNT_Clip_Start | number | |
TOOLNT_Clip_End | number | |
TOOLBT_Clip_Reverse | boolean | |
TOOLBT_Clip_Saving | boolean | |
TOOLBT_Clip_Loop | boolean | |
TOOLIT_Clip_TrimIn | integer | |
TOOLIT_Clip_TrimOut | integer | |
TOOLIT_Clip_ExtendFirst | integer | |
TOOLIT_Clip_ExtendLast | integer | |
TOOLIT_Clip_ImportMode | integer | |
TOOLIT_Clip_PullOffset | integer | |
TOOLIT_Clip_InitialFrame | integer | |
TOOLIT_Clip_AspectMode | integer | |
TOOLIT_Clip_TimeCode | integer | |
TOOLST_Clip_KeyCode | string | |
TOOLST_AltClip_Name | string | |
TOOLIT_AltClip_Width | integer | |
TOOLIT_AltClip_Height | integer | |
TOOLIT_AltClip_StartFrame | integer | |
TOOLIT_AltClip_Length | integer | |
TOOLBT_AltClip_IsMultiFrame | boolean | |
TOOLST_AltClip_FormatName | string | |
TOOLST_AltClip_FormatID | string |
