|
Functions Provided By M2L Interval Tubes
The following table provides an overview over all functions the effect provides:
Function
|
Description
|
void SetColor(color col)
|
Sets the color of the effect color. Please note that the alpha channel is not used by this effect.
|
color GetColor()
|
Returns the currently set color. Please note that the alpha channel is not used and should be ignored.
|
void SetBpm(int bpm)
|
Sets the speed of the effect in BPM. Valid values range from 0 to 9999 BPM.
|
int GetBpm()
|
Returns the current effect speed in BPM.
|
void SetDirection(int dir)
|
Set the direction for the effect. This effect has two effect specific directions which are described below.
|
int GetDirection()
|
Returns the current direction. The returned values are described below.
|
void SetFade(int fade)
|
Set the fade value for the tubes. Valid values range from 1 to 3000.
|
int GetFade()
|
Returns the current fade value.
|
void SetPixelWidth(int w)
|
Sets the width of the tubes in pixels. Valid values range from 1 to 9999.
|
int GetPixelWidth()
|
Returns the width of the tubes in pixels.
|
void SetVectorWidth(float w)
|
Sets the width of the tubes using relative coordinates between 0 and 1 according to the current matrix size and direction. See below for further details.
|
float GetVectorWidth()
|
Returns the width of the drops as relative value depending on the current matrix size and direction. See below for further details.
|
void SetUseBass(int enable)
|
Disables "use bass" if enable is set to false. Otherwise, it will be enabled.
|
int GetUseBass()
|
Returns true if "use bass" is enabled, otherwise false.
|
This Effect uses the Color Picker. Learn more about Using Colors.
Deprecated Functions
Deprecated functions are outdated functions and should not be used anymore.
Function
|
Description
|
void SetSpeed(int speed)
|
Sets the speed of the effect in FPS. Valid values range from 0 to 166. Please note: This function is deprecated and may be removed in one of the next releases. Use SetBpm instead.
|
float GetSpeed()
|
Returns the current effect speed in FPS. Please note: This function is deprecated and may be removed in one of the next releases. Use GetBpm instead.
|
Setting The Direction
The effect is able to draw vertical or horizontal lines. The direction can be set by SetDirection with the following values as parameter:
Value
|
Description
|
DIR_HORIZONTAL
|
Draws the tubes as horizontal lines.
|
DIR_VERTICAL
|
Draws the tubes as vertical lines.
|
DIR_HV
|
Draws the tubes as vertical and horizontal lines.
|
Using A Relative Width Of Tubes
The width of the tubes may be given in pixels or as a relative value between 0 and 1. The function SetVectorWidth uses such relative coordinates. A value of 0 represents the minimum size and will be increased to 1 pixel. A value of 1 represents the whole size of the matrix.
Furthermore, this value depends on the current direction. If horizontal lines are activated, the value is used in relation to the matrix height. If vertical lines are activated, the value is used in relation to the width of the matrix.
|