Fuse SDK

Common Classes Reference

Object

The base class for most Classes in the FusionSDK.

Parameter

Parameters are passed around from Operator to Operator via Inputs and Outputs.

Number

Parameter subclass for floating point numbers.

PropertyTypeDescription
ValueNumbervalue
Number(number value)

Create a new Number Parameter

Point

Parameter subclass for normalized cartesian coordinates.

PropertyTypeDescription
XNumberX coordinate
YNumberY coordinate
Point(number X, number Y)

Create a new Point Parameter

Text

Parameter subclass for strings.

PropertyTypeDescription
ValueStringvalue
Text(string value)

Create a new Text Parameter

Image

Parameter subclass for Images.

PropertyTypeDescription
WidthNumberNominal width of the Image in Pixels.
HeightNumberNominal height of the Image in Pixels.
OriginalWidthNumberWidth before proxy scaling.
OriginalHeightNumberHeight before proxy scaling.
DataWindowNumber[4]Region of defined Image data {left, bottom, right, top}
Image(table tags)

Create a new Image Parameter

FuIDParam

Parameter subclass for well-known strings.

PropertyTypeDescription
ValueStringvalue
FuIDParam(string value)

Create a new FuIDParam Parameter

Any connection between Operators.

PropertyTypeDescription
IDStringScripting Identifier
NameStringUser Interface Name

Input

Inputs are how Operators accept Parameters. Inputs are created via helper methods.

boolean Link:IsAnimated()

Returns true if any external source (connection, expression, etc) is driving this Input.

Output

Outputs give Parameters to other Operator's Inputs. Outputs are created via helper methods.

Operator

Objects that exist in the flow of Parameters. They have Inputs and Outputs. Operators include Tools and Modifiers.