S2L Shapes

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 SetFade(float value)

Sets the Fade value, which defines how fast the shapes disappear in BPM. Valid values for value range from 1 to 3000.

float GetFade()

Returns the current Fade in BPM.

void SetSize(float value)

Sets the Size value, which is the size of the shapes, in percent of the matrix size (depending on the shape alignment). The size value means the minimum shape size if the shape size distribution mode is not uniform. Valid values for value range from 0.01 to 1000.

float 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 SetPixelSize(int value)

Sets the Size value, which is the size of the shapes, in pixels. The size value means the minimum shape size if the shape size distribution mode is not uniform. Valid values for value range from 1 to ten times the matrix size (depending on the shape alignment).

int GetPixelSize()

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

void SetSizeMax(float value)

Sets the Maximum Size value, which is the maximum size of the shapes, in percent of the matrix size (depending on the shape alignment). The maximum size value only applies if the shape size distribution mode is not uniform. Valid values for value range from 0.01 to 1000.

float GetSizeMax()

Returns the current Maximum Size of the shapes in percent.

void SetPixelSizeMax(int value)

Sets the Maximum Size value, which is the maximum size of the shapes, in pixels. The maximum size value only applies if the shape size distribution mode is not uniform. Valid values for value range from 1 to ten times the matrix size (depending on the shape alignment).

int GetPixelSizeMax()

Returns the current Maximum Size of the shapes in pixels.

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 SetPitch1(float value)

Sets the Pitch 1 value, which is the x-distance of the shapes, in percent of the matrix size. Valid values for value range from 0.01 to 100.

float GetPitch1()

Returns the current Pitch 1 of the shapes in percent.

void SetPixelPitch1(int value)

Sets the Pitch 1 value, which is the x-distance of the shapes, in pixels. Valid values for value range from 1 to the matrix size.

int GetPixelPitch1()

Returns the current Pitch 1 of the shapes in pixels.

void SetPitch2(float value)

Sets the Pitch 2 value, which is the y-distance of the shapes, in percent of the matrix size. Valid values for value range from 0.01 to 100.

float GetPitch2()

Returns the current Pitch 2 of the shapes in percent.

void SetPixelPitch2(int value)

Sets the Pitch 2 value, which is the y-distance of the shapes, in pixels. Valid values for value range from 1 to the matrix size.

int GetPixelPitch2()

Returns the current Pitch 2 of the shapes in pixels.

void SetPitch3(float value)

Sets the Pitch 3 value, which is the z-distance of the shapes, in percent of the matrix size. Valid values for value range from 0.01 to 100.

float GetPitch3()

Returns the current Pitch 3 of the shapes in percent.

void SetPixelPitch3(int value)

Sets the Pitch 3 value, which is the z-distance of the shapes, in pixels. Valid values for value range from 1 to the matrix size.

int GetPixelPitch3()

Returns the current Pitch 3 of the shapes in pixels.

void SetPitch(float x, float y, float z)

Sets the pitches 1, 2 and 3 of the shapes at once, in percent of the matrix size. Valid values for x, y and z range from 0.01 to 100.

void SetPixelPitch(int x, int y, int z)

Sets the pitches 1, 2 and 3 of the shapes at once, in pixels. Valid values for x, y and z range from 1 to the matrix size.

void SetAlphaMix(int value)

Sets the Alpha Mix value, which defines the variance of the shapes' alpha channel, in percent. Valid values for value range from 0 to 100.

int GetAlphaMix()

Returns the current Alpha Mix in percent.

void SetSensitivity(int value)

Sets the Sensitivity value, which controls how much shapes are created by defining a threshold for the incoming audio data, in percent. Valid values for value range from 0 to 100.

int GetSensitivity()

Returns the current Sensitivity in percent.

void SetShift(int value)

Sets the Shift value, which controls the mapping between the incoming audio data and the shapes' positions by defining an offset, in percent. Valid values for value range from 0 to 100.

int GetShift()

Returns the current Shift in percent.

void SetAmplification(int value)

Sets the Amplification value, which controls how much shapes are created by defining a factor for the incoming audio data, in percent. Valid values for value range from 0 to 100.

int GetAmplification()

Returns the current Amplification in percent.

void SetInvert(int value)

Use value 1 (TRUE) to invert the shapes' positions. Use value 0 (FALSE) to use the default setting.

int GetInvert()

Returns 1 (TRUE) if the shapes' positions are inverted, otherwise 0 (FALSE).

void ToggleInvert()

Inverts the shapes' positions or uses the default setting, depending on the current state.

void SetMirror(int value)

Use value 1 (TRUE) to mirror the shapes' positions. Use value 0 (FALSE) to use the default setting.

int GetMirror()

Returns 1 (TRUE) if the shapes' positions are mirrored, otherwise 0 (FALSE).

void ToggleMirror()

Mirrors the shapes' positions or uses the default setting, depending on the current state.