Function

Description

void SetBorder(float value)

Sets the Border of objects. Valid values range from 0.01 to 100.

float GetBorder()

Returns the currently set Border.

void SetPixelBorder(int value)

Sets the Border of objects in pixels based on the object size.

int GetPixelBorder()

Returns the currently set Border in pixels.

void SetOuterGlow(float value)

Sets the Outer Glow of objects. Valid values range from 0.00 to 100.

float GetOuterGlow()

Returns the currently set Outer Glow.

void SetPixelOuterGlow(int value)

Sets the Outer Glow of objects in pixels based on the object size.

int GetPixelOuterGlow()

Returns the currently set Outer Glow in pixels.

void SetInnerGlow(float value)

Sets the Inner Glow of objects. Valid values range from 0.00 to 100.

float GetInnerGlow()

Returns the currently set Inner Glow.

void SetPixelInnerGlow(int value)

Sets the Inner Glow of objects in pixels based on the object size.

int GetPixelInnerGlow()

Returns the currently set Inner Glow in pixels.

Function

Description

void SetColorMix(int value)

Use value 1 (TRUE) to activate the Color Mix. When Color Mix is activated, every shape has its own color depending on the »Color Table Mode. Use value 0 (FALSE) to use the default setting.

int GetColorMix()

Returns 1 (TRUE) if the Color Mix is enabled, otherwise 0 (FALSE).

void ToggleColorMix()

Enables or disables the Color Mix depending on the current state.

void SetFillTime(float value)

Sets the Fill Time value which defines how long is takes to fill the whole matrix with shapes.

float GetFillTime()

Returns the current Fill Time.

void SetDuration(float value)

Sets the Duration value which defines how long the completely filled matrix is displayed.

float GetDuration()

Returns the current Duration.

void SetPitchX(float value)

Sets the Pitch X value in percent which defines the X-aligned distance between shapes.

float GetPitchX()

Returns the current Pitch X in percent.

void SetPitchY(float value)

Sets the Pitch Y value in percent which defines the Y-aligned distance between shapes.

float GetPitchY()

Returns the current Pitch Y in percent.

void SetPitchZ(float value)

Sets the Pitch Z value in percent which defines the Z-aligned distance between shapes.

float GetPitchZ()

Returns the current Pitch Z in percent.

void SetPitch(float value, float value, float value)

Sets the Pitch X, Y, Z values in percent which define the distances between shapes.

void SetPixelPitchX(int value)

Sets the Pitch X value in pixels, which defines the X-aligned distance between shapes.

int GetPixelPitchX()

Returns the current Pitch X in pixels.

void SetPixelPitchY(int value)

Sets the Pitch Y value in pixels, which defines the Y-aligned distance between shapes.

int GetPixelPitchY()

Returns the current Pitch Y in pixels.

void SetPixelPitchZ(int value)

Sets the Pitch Z pixel in pixels, which defines the Z-aligned distance between shapes.

int GetPixelPitchZ()

Returns the current Pitch Z in pixels.

void SetPixelPitch(int value, int value, int value)

Sets the Pitch X, Y, Z values in pixels which define the distances between shapes.

void SetStartCorner(int mode)

Sets the Start Corner. See below for a list of constants.

int GetStartCorner()

Returns the Start Corner. See below for a list of constants.

void SetOrientation(int mode)

Sets the Orientation Mode. See below for a list of constants.

int GetOrientation()

Returns the Orientation Mode. See below for a list of constants.

void SetCircle(int enable)        

Use value 1 (TRUE) to activate the Circle Mode. Use value 0 (FALSE) to use the default setting.

int GetCircle()        

Returns 1 (TRUE) if the Circle Mode is enabled, otherwise 0 (FALSE).

void ToggleCircle()

Enables or disables the Circle Mode depending on the current state.

void SetCenter(int enable)        

Use value 1 (TRUE) to activate the Center Mode. Use value 0 (FALSE) to use the default setting.

int GetCenter()        

Returns 1 (TRUE) if the Center Mode is enabled, otherwise 0 (FALSE).

void ToggleCenter()        

Enables or disables the Center Mode depending on the current state.

void SetMirror(int enable)        

Use value 1 (TRUE) to activate the Mirror Mode. Use value 0 (FALSE) to use the default setting.

int GetMirror()        

Returns 1 (TRUE) if the Mirror Mode is enabled, otherwise 0 (FALSE).

void ToggleMirror()

Enables or disables the Mirror Mode depending on the current state.

void SetBlendingMode(int value)

Sets the Blending Mode for the effect. See below for details.

int GetBlendingMode()

Returns the currently set Blending Mode for the effect. See below for details.

void SetFlush()

Use value 0 (False) to deactivate Flush. Use value 1 (TRUE) to use the default setting.

int GetFlush()

Returns 1 (TRUE) if Flush is enabled, otherwise 0 (FALSE).

Constant

Description

int BLENDING_MODE_ALPHA

Sets the blending mode to Alpha Blending.

int BLENDING_MODE_SUBSTITUTION

Sets the blending mode to Substitution.

Constant

Description

int START_CORNER_FRONT_TOP_LEFT

Sets the Start Corner to Front Top Left.

int START_CORNER_FRONT_TOP_RIGHT

Sets the Start Corner to Front Top Right.

int START_CORNER_FRONT_BOTTOM_LEFT

Sets the Start Corner to Front Bottom Left.

int START_CORNER_FRONT_BOTTOM_RIGHT

Sets the Start Corner to Front Bottom Left.

int START_CORNER_BACK_TOP_LEFT

Sets the Start Corner to Back Top Left.

int START_CORNER_BACK_TOP_RIGHT

Sets the Start Corner to Back Top Right.

int START_CORNER_BACK_BOTTOM_LEFT

Sets the Start Corner to Back Bottom Left.

int START_CORNER_BACK_BOTTOM_RIGHT

Sets the Start Corner to Back Bottom Right.

Constant

Description

int ORIENTATION_XYZ

Sets the Orientation Mode to XYZ Orientation.

int ORIENTATION_XZY

Sets the Orientation Mode to XZY Orientation.

int ORIENTATION_YXZ

Sets the Orientation Mode to YXZ Orientation.

int ORIENTATION_YZX

Sets the Orientation Mode to YZX Orientation.

int ORIENTATION_ZYX

Sets the Orientation Mode to ZYX Orientation.

int ORIENTATION_ZXY

Sets the Orientation Mode to ZXY Orientation.