Eyeon:Script/Reference/Applications/Fuse/Functions/FuRegisterClass/Attributes
From VFXPedia
FuRegisterClass Attributes
The following attributes are valid for the FuRegisterClass function.
| Attribute Name | Description |
|---|---|
| REGS_Category Required | A string value which sets the category a tool will appear in.
For example, REGS_Category = "Script" will place the tool in the Scripts category of the tool menu. If the category does not exist, it will be created to hold the tool. Nested Categories can be defined using a \ character as a seperator. For example, REGS_Category = "Script\\Color" will create a Color category under the Script category of the tool menu. Remember to use \\ instead of \ in a regular string, as \ is considered an escape character unless the [[]] syntax is used. |
| REGS_Name Optional | An optional 'friendly' name for the tool, which allows spaces. |
| REGS_OpIconString Required | A string value that defines the abbrieviation of the tools name. This is used in the toolbar menu and by the bins. |
| REGS_OpDescription Required | A short description of the tool, used in the various parts of the Fusion interface. |
| REG_OpNoMask Optional | A boolean value (true/false) that determines if the tool provides an input for masks on the flow. Defaults to false. |
| REG_NoAutoProxy Optional | A boolean value that determines used to prevent the tool from processing lower resolution versions of the image when auto proxy is enabled. Defaults to false. |
| REG_NoBlendCtrls Optional | A boolean value (true/false) that determines if the tool provides the common Blend slider. Defaults to false. |
| REG_NoObjMatCtrls Optional | A boolean value (true/false) that determines if the tool provides the common Matte Control options. Set this to true to prevent the mask controls from appearing. Defaults to false. |
| REG_NoMotionBlurCtrls Optional | A boolean value (true/false) that determines if the tool provides the common Motion Blur controls. Set this to true to prevent the Motion Blur controls from appearing. Defaults to false. |
| REG_Source_GlobalCtrls Optional | A boolean value (true/false) that determines if the tool provides the controls for Global In and Out. Set to false to prevent these controls from appearing. Applies to Creator tools (ClassID = CT_SourceTool) only. |
| REG_Source_SizeCtrls Optional | A boolean value (true/false) that determines if the tool provides the standard controls for image width and height. Set to false to prevent these controls from appearing. Applies to Creator tools (ClassID = CT_SourceTool) only. |
| REG_Source_AspectCtrls Optional | A boolean value (true/false) that determines if the tool provides the standard controls for image aspect. Set to false to prevent these controls from appearing. Applies to Creator tools (ClassID = CT_SourceTool) only. |
| REG_Source_DepthCtrls Optional | A boolean value (true/false) that determines if the tool provides the standard controls for setting the images color depth. Set to false to prevent these controls from appearing. Applies to Creator tools (ClassID = CT_SourceTool) only. |
| REG_TimeVariant Optional | A boolean value. No idea - So far seen on source tools only |
| REG_Fuse_NoEdit Optional | A boolean value (true/false) that determines if the tool displays the Edit button shown at the top of most Fuses. Defaults to false. |
| REG_Fuse_NoReload Optional | A boolean value (true/false) that determines if the tool displays the Reload button shown at the top of most Fuses. Defaults to false. |
| REG_Fuse_TilePic Optional | A Fusepic table that contains a description and string information used to create a tool icon for the Fuse.
A Fusepic table can be created by saving a 160x120 image as a "Fuse Pic" file (*.fusepic in Saver). This will create a text file containing the Fusepic table. Paste the contents of the text file into the top of the Fuse, before the FuRegisterClass() function. |
