Function

Description

void SetCount(int value)

Sets the Count of shapes.

int GetCount()

Retrieves the current Count of shapes.

void SetSize(int value)

Sets the Size value, which is the size of the shapes in percent of the matrix size (depending on the look-at type). The Size value means the minimum shape size if the shape size distribution mode is not uniform.

int GetSize()

Returns the current Size of the shapes in percent. The return value means the minimum shape size if the shape size distribution mode is not uniform.

void SetSizeMin(int value)

Is the same as SetSize.

int GetSizeMin()

Is the same as GetSize.

void SetSizeMax(int value)

Sets the Maximum Size value, which is the maximum size of the shapes in percent of the matrix size (depending on the look-at type). The Maximum Size value only applies if the shape size distribution mode is not uniform.

int GetSizeMax()

Returns the current Maximum Size of the shapes in percent.

void SetSizeScale(float value)

Sets the Size Scale factor of the shapes. This feature is only supported when the size distribution mode is DIST_RND.

float GetSizeScale()

Retrieves the current Size Scale factor.

void SetSizeDistribution(int value)

Sets the Size Distribution value which defines how the range between the current minimum and the current maximum shape size is applied to the shapes. See »here for a list of constants.

int GetSizeDistribution()

Returns the current Size Distribution of the shapes. See »here for a list of constants.

void SeedRandomSize()

Randomizes the sizes of the shapes. Is the same as SetSizeDistribution(DIST_RND).

void SetOuterGlow(int value)

Sets the value for the Outer Glow of shapes. This feature is only supported by specific shape types.

int GetOuterGlow()

Returns the value of the Outer Glow of shapes.

void SetInnerGlow(int value)

Sets the value for the Inner Glow of shapes. This feature is only supported by specific shape types.

int GetInnerGlow()

Returns the value of the Inner Glow of shapes.

void SetBorder(int value)

Sets the Border size of shapes. This feature is only supported by specific shape types.

int GetBorder()

Returns the Border size of shapes.

void SetColorMixingMode(int value)

Sets the Color Mixing Mode. This feature is only supported when the color table includes more then one color or when the color table is in random mode. Furthermore the color mixing link must be disabled. See below for a list of constants.

int GetColorMixingMode()

Returns the current Color Mixing Mode.

void SetColorMixingSharpness(int value)

Sets the Color Mixing Sharpness. This feature is only supported when the color table includes more then one color or when the color table is in random mode. See below for a list of constants.

int GetColorMixingSharpness()

Returns the current Color Mixing Sharpness.

void SetColorMixingLink(int value)

Use value TRUE to activate the Color Mixing Link. When Color Mixing Link is activated, the auto adjustment for the color mixing mode is enabled. Use value FALSE to use the default setting.

int GetColorMixingLink()

Returns TRUE if the Color Mixing Link is enabled, otherwise FALSE.

void ToggleColorMixingLink()

Enables or disables the Color Mixing Link, depending on the current state.

SetMotionType(int value)

Sets the Motion Type. See below for a list of constants.

int GetMotionType()

Returns the current Motion Type.

void SetInfluence(float value)

Sets the Influence value. This feature is only supported by the motion type MOTION_TYPE_SWARM.

float GetInfluence()

Returns the current Influence value.

void SetSeparation(float value)

Sets the Separation value. This feature is only supported by the motion type MOTION_TYPE_SWARM.

float GetSeparation()

Returns the current Separation value.

Constant

Description

int COLOR_MIXING_MODE_CIRCLE

Sets the color mixing mode to Circle.

int COLOR_MIXING_MODE_SQUARE

Sets the color mixing mode to Square.

int COLOR_MIXING_MODE_DIAMOND

Sets the color mixing mode to Diamond.

Constant

Description

int COLOR_MIXING_SHARPNESS_VERY_BLURRY

Sets the color mixing sharpness to Very Blurry.

int COLOR_MIXING_SHARPNESS_BLURRY

Sets the color mixing sharpness to Blurry.

int COLOR_MIXING_SHARPNESS_SLIGHTLY_BLURRY

Sets the color mixing sharpness to Slightly Blurry.

int COLOR_MIXING_SHARPNESS_MEDIUM

Sets the color mixing sharpness to Medium.

int COLOR_MIXING_SHARPNESS_SLIGHTLY_CLEAR

Sets the color mixing sharpness to Slightly Clear.

int COLOR_MIXING_SHARPNESS_CLEAR

Sets the color mixing sharpness to Clear.

int COLOR_MIXING_SHARPNESS_VERY_CLEAR

Sets the color mixing sharpness to Very Clear.

Constant

Description

int MOTION_TYPE_RANDOM

Sets the motion type to Random.

int MOTION_TYPE_SWARM

Sets the motion type to Swarm.

Function/Constant

Description

void SetMaxSize(int value)        

Use SetSizeMax(int value) instead.

int GetMaxSize()

Use GetSizeMax() instead.

void SetMode(int mode)

Use SetSizeDistribution(int distribution) instead.

MODE_UNIFORM

Use DIST_UNIFORM instead.

MODE_LINEAR

Use DIST_LINEAR instead.

MODE_QUADRATIC

Use DIST_QUADRATIC instead.

MODE_SQRT

Use DIST_SQRT instead.

MODE_CUBIC

Use DIST_CUBIC instead.

MODE_RANDOM

Use DIST_RND instead.

int GetMode()        

Use GetSizeDistribution() instead.

void SetScale(float value)        

Use SetSizeScale(float value) instead.

float GetScale()        

Use GetSizeScale() instead.

void SetColorMix(int colormix)

Use SetColorMixingMode(int mixingmode) instead.

MODE_CIRCLE

Use COLOR_MIXING_MODE_CIRCLE instead.

MODE_RECTANGLE

Use COLOR_MIXING_MODE_SQUARE instead.

MODE_DIAMOND

Use COLOR_MIXING_MODE_DIAMOND instead.

int GetColorMix()

Use GetColorMixingMode() instead.

void SetSharpness(int sharpness)

Use SetColorMixingSharpness(int sharpness) instead.

MODE_VERY_BLURRY

Use COLOR_MIXING_SHARPNESS_VERY_BLURRY instead.

MODE_BLURRY

Use COLOR_MIXING_SHARPNESS_BLURRY instead.

MODE_SLIGHTLY_BLURRY

Use COLOR_MIXING_SHARPNESS_SLIGHTLY_BLURRY instead.

MODE_MEDIUM

Use COLOR_MIXING_SHARPNESS_MEDIUM instead.

MODE_SLIGHTLY_CLEAR

Use COLOR_MIXING_SHARPNESS_SLIGHTLY_CLEAR instead.

MODE_CLEAR

Use COLOR_MIXING_SHARPNESS_CLEAR instead.

MODE_VERY_CLEAR

Use COLOR_MIXING_SHARPNESS_VERY_CLEAR instead.

int GetSharpness()        

Use GetColorMixingSharpness() instead.

void SetColorMixLink(int value)

Use SetColorMixingLink(int value) instead.

int GetColorMixLink()

Use GetColorMixingLink() instead.

void SeedRandom()

Use SeedRandomSize() instead.