Function

Description

void SetPitch(float value)

Sets the Pitch value in percent.

float GetPitch()

Returns the current Pitch value.

void SetScaleX(float value)

Sets the Scale factor regarding X.

float GetScaleX()

Returns the current Scale factor for X.

void SetScaleY(float value)

Sets the Scale factor regarding Y.

float GetScaleY()

Returns the current Scale factor for Y.

void SetScaleZ(float value)

Sets the Scale factor regarding Z.

float GetScaleZ()

Returns the current Scale factor for Z.

void SetScale(float value, float value, float value)

Sets the Scale value for X, Y, and Z.

void SetFadeIn(int value)

Sets the first int value of the Fade slider.

int GetFadeIn()

Returns the current first value of the Fade slider.

void SetFadeOut(int value)

Sets the second int value of the Fade slider.

int GetFadeOut()

Returns the current second value of the Fade slider.

void SetInterpolationIn(int value)

Sets the first int value of the Interpolation slider.

int GetInterpolationIn()

Returns the current first value of the Interpolation slider.

void SetInterpolationOut(int value)

Sets the second int value of the Interpolation slider.

int GetInterpolationOut()

Returns the current second value of the Interpolation slider.

void SetAutoStart(int value)

Sets the AS option for automatic start. Use 1 (TRUE) to activate Autostart. Use 0 (FALSE) to deactivate it.

int GetAutoStart()

Returns 1 (TRUE) if the AS option for automatic start is activated, otherwise 0 (FALSE).

void ToggleAutoStart()

Toggles the AS option for automatic start.

void Start()

Forces a start.

void SetEndMode(int mode)

Sets the mode for the last element. See below for a list of constants.

int GetEndMode()

Returns the current mode for the last element.

void SetTextAlignmentHorizontal(int alignment)

Sets the horizontal text alignment of elements. See below for a list of constants.

int GetTextAlignmentHorizontal()

Returns the current horizontal text alignment of elements.

void SetTextAlignmentVertical(int alignment)

Sets the vertical text alignment of elements. See below for a list of constants.

int GetTextAlignmentVertical()

Returns the current vertical text alignment of elements.

void SetInterpolationType1(int type)

Sets the Interpolation Type 1. See below for a list of constants.

int GetInterpolationType1()

Returns the current Interpolation Type 1.

void SetInterpolationType2(int type)

Sets the Interpolation Type 2. See below for a list of constants.

int GetInterpolationType2()

Returns the current Interpolation Type 2.

void SetRotation(int angle)

Sets the Rotation globally for all elements of the String Table. It is possible to rotate the elements by multiples of 90°. This function is equal to the rotation button provided by the GUI of the effect. Valid values for angle are 0, 90, 180, and 270.

int GetRotation()

Returns the current Rotation value.

void SetFilteringMode(int mode)

Sets the Filtering mode. See below for details.

mode GetFilteringMode()

Returns the Filtering mode.

void SetExtrusion(float value)

Sets the Extrusion value in percent of the matrix size (depending on the current look-at type).

float GetExtrusion()

Returns the current Extrusion value in percent of the matrix size (depending on the current look-at type).

void SetPixelExtrusion(int value)

Sets the Extrusion value in pixels.

int GetPixelExtrusion()

Returns the current Extrusion value in pixels.

Constant

Description

int ENDMODE_MOVE

Sets the Last Element Mode to Move.

int ENDMODE_STAY

Sets the Last Element Mode to Stay.

int ENDMODE_CLEAR

Sets the Last Element Mode to Clear.

Constant

Description

int TEXT_ALIGNMENT_HORIZONTAL_LEFT

Sets the Horizontal Text Alignment to Left.

int TEXT_ALIGNMENT_HORIZONTAL_CENTER

Sets the Horizontal Text Alignment to Center.

int TEXT_ALIGNMENT_HORIZONTAL_RIGHT

Sets the Horizontal Text Alignment to Right.

Constant

Description

int TEXT_ALIGNMENT_VERTICAL_TOP

Sets the Vertical Text Alignment to Top.

int TEXT_ALIGNMENT_VERTICAL_CENTER

Sets the Vertical Text Alignment to Center.

int TEXT_ALIGNMENT_VERTICAL_BOTTOM

Sets the Vertical Text Alignment to Bottom.

Value

Description

int FILTERING_MODE_NEAREST_NEIGHBOR

Sets the Filtering Mode to None (no filtering).

int FILTERING_MODE_LINEAR

Sets the Filtering Mode to Linear (may require additional performance).

Constant

Description

int INTERPOLATION_TYPE_LINEAR

Sets the Interpolation Type to Linear.

int INTERPOLATION_TYPE_EASE_BOUNCE_IN

Sets the Interpolation Type to Ease In Bounce.

int INTERPOLATION_TYPE_EASE_BOUNCE_OUT

Sets the Interpolation Type to Ease Out Bounce.

int INTERPOLATION_TYPE_EASE_BOUNCE_INOUT

Sets the Interpolation Type to Ease In Out Bounce.

int INTERPOLATION_TYPE_EASE_CIRC_IN

Sets the Interpolation Type to Ease In Circular.

int INTERPOLATION_TYPE_EASE_CIRC_OUT

Sets the Interpolation Type to Ease Out Circular.

int INTERPOLATION_TYPE_EASE_CIRC_INOUT

Sets the Interpolation Type to Ease In Out Circular.

int INTERPOLATION_TYPE_EASE_CUBIC_IN

Sets the Interpolation Type to Ease In Cubic.

int INTERPOLATION_TYPE_EASE_CUBIC_OUT

Sets the Interpolation Type to Ease Out Cubic.

int INTERPOLATION_TYPE_EASE_CUBIC_INOUT

Sets the Interpolation Type to Ease In Out Cubic.

int INTERPOLATION_TYPE_EASE_SINE_IN

Sets the Interpolation Type to Ease In Sinusoidal.

int INTERPOLATION_TYPE_EASE_SINE_OUT

Sets the Interpolation Type to Ease Out Sinusoidal.

int INTERPOLATION_TYPE_EASE_SINE_INOUT

Sets the Interpolation Type to Ease In Out Sinusoidal.

int INTERPOLATION_TYPE_EASE_EXPO_IN

Sets the Interpolation Type to Ease In Exponential.

int INTERPOLATION_TYPE_EASE_EXPO_OUT

Sets the Interpolation Type to Ease Out Exponential.

int INTERPOLATION_TYPE_EASE_EXPO_INOUT

Sets the Interpolation Type to Ease In Out Exponential.