Name

Type : Description

LINKID_DataType

string : specifies the type of data produced and used by the control.

A control which expects or outputs an image would use type "Image" while a slider would use "Number". Valid values include: Image, Number, Point, Text.

LINK_Main

integer : specifies the priority or order of LINK style controls. This is used when calculating auto connection of tools in the flow. For example, a tool with two inputs would specify values of 1 and 2 for LINK_Main. The

input with a value of 1 would have a higher priority than the control with a value of 2.

INPID_InputControl

string : This attribute uses a string to describe the type of control. Valid values include: ButtonControl, CheckboxControl, ColorControl, ComboControl, ComboIDControl, FileControl, FontFileControl,

GradientControl, LabelControl, MultiButtonControl, MultiButtonIDControl, OffsetControl, RangeControl, ScrewControl, SliderControl

INPID_PreviewControl

string : If present this attribute uses a string to describe the type of on screen control displayed for the control. For example a Point type control would set this attribute to "TransformControl" if a set of crosshairs should be displayed in the views when the tool is selected.

Valid values include: AngleControl, CrossHairControl, ImgOverlayControl, RectangleControl, PointControl, TransformControl

INP_Default

numeric : This attribute is used to set the default value of a control. Typically this will be an integer value.

INP_MinScale

numeric : This attribute is used to set the minimum value displayed by the control. Typically this attribute is applied to sliders and range controls. This does not specify the absolute minimum value of the input, only the highest value presented by the control when it is initially constructed. It would still be possible to enter lower values, up to the value specified by INP_MinAllowed.

INP_MaxScale

numeric : This attribute is used to set the maximum value displayed by the control. Typically this attribute is applied to sliders and range controls. This does not specify the absolute maximum value of the input, only the highest value presented by the control when it is initially constructed. It would still be possible to enter higher values, up to the value specified by INP_MaxAllowed.

INP_MinAllowed

numeric : This attribute specifies the minimum allowable value for the input.

INP_MaxAllowed

numeric : This attribute specifies the maximum allowable value for the input.

INP_Required

boolean : This attribute specifies whether the input is required. If this is set to false the tool will not fail if the inp is nil. Typically used for non required image inputs - like the foreground of a Merge tool. Defaults to True

Name

Type : Description

IC_ControlGroup

numeric : All inputs with the same IC_ControlGroup will be part of an overall group of controls. For example, the Red, Green and Blue sliders of a Color Control would all share the same IC_ControlGroup.

IC_ControlID

numeric : A unique identifier for an individual input within a control group defined by IC_ControlGroup. For example, the Red slider in a color control with IC_ControlGroup = 1 would have the IC_ControlID of 0, while the Green slider would have an IC_ControlID of 1, and so on.

IC_Visible

boolean : This attribute specifies whether an input is visible. Set it to false to hide the input. Defaults to true.

ICD_Center

numeric : This attribute will set the default of a slider to the center, regardless of scale. This creates a non-linear slider, with the default value centered regardless of the MinScale and MaxScale attributes.

ICD_Width

numeric : This attribute specifies the width of the input, where a value of

1.0 is the full width of the control page.

PC_Visible

boolean : This attribute specifies whether the PreviewControl associated with an input is currently visible. Defaults to true.

PC_GrabPriority

numeric : A numeric value that specifies the grab priority of a preview control input. The input with the highest PC_GrabPriority will be selected first. Used when two controls overlap - for example the Angle and Rectangle preview control found in a Merge or Transform tool.

PC_ControlGroup

numeric : All inputs with the same PC_ControlGroup will share the same preview control. For example, the Width and Height sliders of a Rectangle mask will have the same PC_ControlGroup.

PC_ControlID

numeric : A unique identifier for an individual input within a preview control group defined by PC_ControlGroup. For example, a Width slider for a RectangleControl would have a PC_ControlGroup of 0, while the Height slider would be set to 1.

PC_HideWhileDragging

boolean : A true or false value which specifies whether the preview control is visible while it is being dragged.