Eyeon:Script/Reference/Applications/Fuse/Classes/Input/Attributes

From VFXPedia

Jump to: navigation, search

Attributes: Input

Note: These attributes are used by Inputs in Fuses. Attributes for scripts may have different names.

See Also: Attributes for Link, Object

attribute name

type

description

INPID_InputControl

string

The ID of the type of tool window control used by the input.

INPID_PreviewControl

string

The ID of the type of display view control used by the input.

INPID_AddModifier

string

A tool of this type ID should be automatically created and connected to this input, at creation time.

INPID_DefaultID

string

Inputs of datatype "FuID" should use this ID as their default value.

INPS_DefaultText

string

Inputs of datatype "Text" should use this string as their default.

INPS_StatusText

string

The text shown on the status bar on mouse hover.

INP_External

boolean

Whether this input can be animated or connected to a tool or modifier.

INP_Active

boolean

This input's value is used in rendering.

INP_Required

boolean

The tool's result requires a valid Parameter from this input.

INP_Connected

boolean

The input is connected to another tool's Output.

INP_Priority

integer

Used to determine the order in which the tool's inputs are fetched.

INP_Disabled

boolean

The input will not accept new values.

INP_DoNotifyChanged

boolean

The tool is notified of changes to the value of the input.

INP_Integer

boolean

The input rounds all numbers to the nearest integer.

INP_NumSlots

integer

The number of values from different times that this input can fetch at once.

INP_ForceNotify

boolean

The tool is notified whenever a new parameter arrives, even if it is the same value.

INP_InitialNotify

boolean

The tool is notified at creation time of the initial value of the input.

INP_Passive

boolean

The value of this input will not affect the rendered result, and does not create an Undo event if changed.

INP_InteractivePassive

boolean

The value of this input will not affect the rendered result, but it can be Undone if changed.

INP_AcceptTransform

boolean

This input will also accept TransformMatrix parameters.

INP_AcceptsMasks

boolean

This input will also accept Mask images.

INP_AcceptsGLImages

boolean

This input will also accept Images with attached OpenGL textures.

INP_MinAllowed

number

Minimum allowed value - any numbers lower than this value are clipped.

INP_MaxAllowed

number

Maximum allowed value - any numbers higher than this value are clipped.

INP_MinScale

number

The lowest value that the input's control will normally display.

INP_MaxScale

number

The highest value that the input's control will normally display.

INP_Default

string

Inputs of datatype "Number" should default to this value.

INP_DefaultX

string

Inputs of datatype "Point" should use this as their default X value.

INP_DefaultY

string

Inputs of datatype "Point" should use this as their default Y value.


Tips for Attributes (edit)

  • INP_InitialNotify defaults to true and is only done if INP_DoNotifyChanged is also true.
  • There are no attributes called INPS_Name or INPS_ID like in the eyeonscript API. Use LINKS_Name and LINKID_ID instead, to get the name or script ID of an input.
  • INP_SendRequest, which isn't listed here, defaults to true and controls whether the input will be requested before Process() is called. If you set this to false on image inputs, for example, you can prevent Fusion from rendering connected branches before you have decided if you need them or not. In this case, you cannot use Input:GetValue(req) to get the input's value. Use Input:GetSource(time) instead. Also, if you use INP_SendRequest = false on the main image input, the Fuse will fail if you don't take care of PreCalcProcess() yourself (or set INP_Required = false).
  • INP_AcceptsDoD, available in since Fusion 6.31, can be set to false to turn off RoI for an image input. Fusion will in this case always request the full image window just as if the Fuse was a non-DoD tool.
  • INP_AcceptTransform will allow an image input to receive a transformation matrix instead of an image from an upstream transform tool that concatenates. However, it seems like you can't do anything with this object as of Fusion 6.31...
  • IC_DisplayedPrecision defines how many floating point digits are displayed for controls (e.g. sliders). A value of 2, for example, would display a value of 0.523203 as 0.52, even though the precise value is still used internally (and returned if the input is queried). Print will also return .52.
  • IC_Steps defines how far a slider will move if you click to the left or to the right of its knob. By default, this value is derived from the minimum and maximum values that are displayed.
  • INP_Disabled prevents the user from changing the input's values or moving its preview control widget in the viewer. However, it also prevents calls to Input:SetSource(). If your code has to change such a disabled input you need to temporarily set INP_Disabled to false by calling Input:SetAttrs({INP_Disabled = false})
  • INP_DelayDefault, if set to true, allows you to define a default value for an input in the OnAddToFlow() function. Available since Fusion 6.1.4. This is useful if a slider's default value should depend on the composition's frame format or time range as these information isn't available in the Create() function yet. See an example here.
Retrieved from "http://96.0.243.189/index.php?title=Eyeon:Script/Reference/Applications/Fuse/Classes/Input/Attributes"