M2L Shapes

   Print  Previous  Next

Functions Provided By M2L Shapes

This effect uses the following functions:

This Effect uses the Color Table. Learn more »Using Color Table
This Effect uses Shapes. Learn more »Using Shapes

 

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

Sets the Border value, which is the line width of the shapes, in percent of the shape size. Valid values for value range from 0.01 to 100.

float GetBorder()

Returns the current Border of the shapes in percent.

void SetPixelBorder(int value)

Sets the Border value, which is the line width of the shapes, in pixels. Valid values for value range from 1 to the shape size.

int GetPixelBorder()

Returns the current Border of the shapes in pixels.

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

Use value TRUE to invert the shapes' positions. Use value FALSE to use the default setting.

int GetInvert()

Returns TRUE, if the shapes' positions are inverted, otherwise FALSE.

void ToggleInvert()

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

void SetMirror(int value)

Use value TRUE to mirror the shapes' positions. Use value FALSE to use the default setting.

int GetMirror()

Returns TRUE, if the shapes' positions are mirrored, otherwise FALSE.

void ToggleMirror()

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

Function

Description

void SetToneRangeMin(int index)

Sets the minimum Tone Range for the effect with the help of 128 MIDI notes. Valid values for index range from 0 to 127.  »Valid parameters (Notes)

int GetToneRangeMin()

Returns the currently set minimum Tone Range.

void SetToneRangeMax(int index)

Sets the maximum Tone Range for the effect with the help of 128 MIDI notes. Valid values for index range from 0 to 127.  »Valid parameters (Notes)

int GetToneRangeMax()

Returns the currently set maximum Tone Range.

 

MADRIX 2.X To MADRIX 3.X Migration Hints

The MADRIX 2.X effect M2L Single Tone Shapes has been renamed to M2L Shapes in MADRIX 3.X. The following functions and constants are not supported anymore. Please follow the hints to migrate your macros.

Function/Constant

Description

void SetVectorWidth(float vWidth)

Use SetSize(float value) instead. Note that the unit of vWidth changed from normalized values to percent.

float GetVectorWidth()

Use GetSize() instead. Note that the unit of the return value changed from normalized values to percent.

void SetPixelWidth(int iWidth)

Use SetPixelSize(int value) instead.

int GetPixelWidth()

Use GetPixelSize() instead.

void SetVectorBorder(float vBorder)

Use SetBorder(float value) instead. Note that the unit of vBorder changed from normalized values to percent.

float GetVectorBorder()

Use GetBorder() instead. Note that the unit of the return value changed from normalized values to percent.

void SetVectorPitch(float vPitch)

Use SetPitch1(float value), SetPitch2(float value) and SetPitch3(float value) instead (the x-, y- and z-distance of the shapes are independent from each other now). Please note that the unit of vPitch changed from normalized value to percent.

float GetVectorPitch()

Use GetPitch1(), GetPitch2() and GetPitch3() instead (the x-, y- and z-distance of the shapes are independent from each other now). Please note that the unit of the return value changed from normalized value to percent.

void SetPixelPitch(int iPitch)

Use SetPixelPitch1(int value), SetPixelPitch2(int value) and SetPixelPitch3(int value) instead (the x-, y- and z-distance of the shapes are independent from each other now).

int GetPixelPitch()

Use GetPixelPitch1(), GetPixelPitch2() and GetPixelPitch3() instead (the x-, y- and z-distance of the shapes are independent from each other now).

void SetSens(int sens)

Use SetSensitivity(int value) instead. Please note that the interpretation of sens is inverted now (0 corresponds to 100 and vice versa).

int GetSens()

Use GetSensitivity() instead. Please note that the interpretation of the return value is inverted now (0 corresponds to 100 and vice versa).

 

MADRIX Version: 3.6g | Script Version: 2.21
[Ctrl & +/-] = Zoom In/Out | [Ctrl & 0] = 100%
Print   Previous   Next