S2L Drops

   Print  Previous  Next

Functions Provided By S2L Drops

This effect uses the following functions:

This Effect uses Directions. Learn more »Using Directions
This Effect uses the Color Table. Learn more »Using Color Table
This Effect uses Shapes. Learn more »Using Shapes
This Effect uses the BPM Control. Learn more »Using BPM Control
This Effect uses the Size Control. Learn more »Using Size Control

 

Function

Description

void SetSpeedVariance(int value)

Sets the Speed Variance value, which means a random value between 0 and 500 percent. This value will multiply with the current BPM value.

int GetSpeedVariance()

Returns the current Speed Variance.

void SetLength(float value)

Sets the Length value, which defines how long the trace of the shapes is, in percent of the matrix size (depending on the direction). Valid values for value range from 0.0 to 100.0.

float GetLength()

Returns the current Length in percent.

void SetPixelLength(int value)

Sets the Length value, which defines how long the trace of the shapes is, in pixels.

int GetPixelLength()

Returns the current Length in pixels.

void SetLengthOffset(float value)

Set the Length Offset value between the shapes of the trace, in percent of the matrix size (depending on the direction). Valid values for value range from 0.0 to 100.0.

float GetLengthOffset()

Returns the current Length Offset in percent.

void SetPixelLengthOffset(int value)

Set the Length Offset value between the shapes of the trace, in pixels.

int GetPixelLengthOffset()

Returns the current Length Offset in pixels.

void SetPitch1(float value)

Sets the Pitch value for axis one (depending on the direction), which is the distance of the shapes, in percent of the matrix size (depending on the direction). Valid values for value range from 0.0 to 100.0.

float GetPitch1()

Returns the current Pitch for axis one in percent.

void SetPixelPitch1(int value)

Sets the Pitch value for axis one (depending on the direction), which is the distance of the shapes, in pixels.

int GetPixelPitch1()

Returns the current Pitch for axis one in pixels.

void SetPitch2(float value)

Sets the Pitch value for axis two (depending on the direction), which is the distance of the shapes, in percent of the matrix size (depending on the direction). Valid values for value range from 0.0 to 100.0.

float GetPitch2()

Returns the current Pitch for axis two in percent.

void SetPixelPitch2(int value)

Sets the Pitch value for axis two (depending on the direction), which is the distance of the shapes, in pixels.

int GetPixelPitch2()

Returns the current Pitch for axis two 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 SetInvert(int value)

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

int GetInvert()

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

void ToggleInvert()

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

void SetMirror(int value)

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

int GetMirror()

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

void ToggleMirror()

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

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

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

int GetGeneratorType()

Returns the current Generator Type. See below for a list of constants.

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 Sensitivity value.

 

 

Generator Type Constants

Constant

Description

int GENERATOR_TYPE_EQ

Sets the generator type to EQ.

int GENERATOR_TYPE_LEVEL_MONO

Sets the generator type to Level Mono.

int GENERATOR_TYPE_LEVEL_STEREO

Sets the generator type to Level Stereo.

 

Deprecated Functions

Deprecated functions are outdated functions and should not be used anymore.

Function/Constant

Description

void SetAmplify(int value)

Use void SetAmplification(int value) instead.

int GetAmplify()

Use int GetAmplification() instead.

 

MADRIX 2.X To MADRIX 3.X Migration Hints

The MADRIX 2.X effect S2L EQ Drops has been renamed to S2L Drops 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 SetPixelWidth(int value)

Use SetPixelSizeX(int value) instead.

int GetPixelWidth()

Use GetPixelSizeX() instead.

void SetStep(int value)

Use SetPixelLengthOffset(int value) instead.

int GetStep()

Use GetPixelLengthOffset() instead.

void SetPitch(int value)

Use SetPixelPitch1(int value) instead.

int GetPitch()

Use GetPixelPitch1() instead

void SetSens()

Use SetSensitivity(int value) instead.

int GetSens()

Use GetSensitivity() instead.

void SetBands(int  value)

Use SetPitch1(float value) and SetPitch2(float value) instead.

If you like to see no gabs or overlapping tubes use SetSize1(float value) and SetSize2(float value) with the same values as the pitch values.

int GetBands()

Use GetPitch1() and GetPitch2() instead.

void SetUseLevel(int  value)

Use SetAlphaMix(int value) with a value of 100 instead.

int GetUseLevel()

Use GetAlphaMix() instead.

 

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