< Previous | Contents | Next >
PlainInput
class PlainInput
Parent class: Link
Represents an Input.
PlainInput Attributes
Attribute Name | Type | Description |
INPS_Name | string | The full name of this input. |
INPS_ID | string | The script ID of this input. |
INPS_DataType | string | The type of Parameter (e.g. Number, Point, Text, Image) this input accepts. |
INPS_StatusText | string | The text shown on the status bar on mouse hover. |
INPB_External | boolean | Whether this input can be animated or connected to a tool or modifier. |
INPB_Active | boolean | This input’s value is used in rendering. |
INPB_Required | boolean | The tool’s result requires a valid Parameter from this input. |
INPB_Connected | boolean | The input is connected to another tool’s Output. |
INPI_Priority | integer | Used to determine the order in which the tool’s inputs are fetched. |
INPID_InputControl | string | The ID of the type of tool window control used by the input. |
![]()
Attribute Name | Type | Description |
INPID_PreviewControl | string | The ID of the type of display view control used by the input. |
INPB_Disabled | boolean | The input will not accept new values. |
INPB_DoNotifyChanged | boolean | The tool is notified of changes to the value of the input. |
INPB_Integer | boolean | The input rounds all numbers to the nearest integer. |
INPI_NumSlots | integer | The number of values from different times that this input can fetch at once. |
INPB_ForceNotify | boolean | The tool is notified whenever a new parameter arrives, even if it is the same value. |
INPB_InitialNotify | boolean | The tool is notified at creation time of the initial value of the input. |
INPB_Passive | boolean | The value of this input will not affect the rendered result, and does not create an Undo event if changed. |
INPB_InteractivePassive | boolean | The value of this input will not affect the rendered result, but it can be Undone if changed. |
INPN_MinAllowed | number | Minimum allowed value - any numbers lower than this value are clipped. |
INPN_MaxAllowed | number | Maximum allowed value - any numbers higher than this value are clipped. |
INPN_MinScale | number | The lowest value that the input’s control will normally display. |
INPN_MaxScale | number | The highest value that the input’s control will normally display. |
INPI_IC_ControlPage | integer | Determines which tab of a tool’s control window that the input’s control is displayed on. |
INPI_IC_ControlGroup | integer | When multiple inputs share a single compound window control, they must all have the same Control Group value. |
INPI_IC_ControlID | integer | When multiple inputs share a single compound window control, they must all have different Control ID values. |
![]()