Function
|
Description
|
void SetColorMode(color colmode)
|
Sets the color mode for the effect. See the table below for further details.
|
color GetColorMode()
|
Returns the currently set color mode. See the table below for further details.
|
void SetShape(int shape)
|
Sets the shape of the objects. See below for details.
|
int GetShape()
|
Returns the currently used shape of objects. See below for details.
|
void SetFade(int fade)
|
Sets the fade value in BPM. Valid values range from 1 to 3000.
|
int GetFade()
|
Returns the current fade value.
|
void SetSens(int sens)
|
Sets the "Sensitivity" value of the effect. Valid values range from 0 to 100.
|
int GetSens()
|
Returns the current "Sensitivity" value of the effect.
|
void SetVectorWidth(float vWidth)
|
Sets the size of the shapes in percent relative to the matrix size. Valid values range from 0.01 to 99.99. The given value is related to the smaller dimension of the matrix. If there is a matrix with size of 5x20 pixels for example, the given value means n% of 5. Whereas 1.0 means 100%. As you can see, it is possible to set a much greater value then the smaller dimension.
|
float GetVectorWidth()
|
Returns the width of the shapes in percent. See SetVectorWidth for further details.
|
void SetPixelWidth(int iWidth)
|
Sets the size of the figures in pixels. Valid values range from 1 to 9999.
|
int GetPixelWidth()
|
Returns the size of the objects in pixels.
|
void SetVectorPitch(float vPitch)
|
Sets the pitch of the shapes in percent in relation to the matrix size. Valid values range from 0.01 to 99.99. The given value is related to the smaller dimension of the matrix. E.g. if there is a matrix with a size of 5x20 pixels, the given value means n% of 5. A value of 1.0 means 100%. As you can see, it is possible to set a much greater value then the smaller dimension.
|
float GetVectorPitch()
|
Returns the pitch of the shapes in percent. See SetVectorPitch for further details.
|
void SetPixelPitch(int iPitch)
|
Sets the pitch between two shapes in pixels. Valid values range from 1 to 9999.
|
int GetPixelPitch()
|
Returns the currently set pitch.
|
void SetVectorBorder(float vBorder)
|
Sets the border width of the shapes in percent. This value relates to the current width of the shapes. E.g. if the current width of the shapes is 10 pixels, a value of 0.5 would mean that the border is drawn with a width of 5 pixels. Valid values range from 0.01 to 99.99. A value of 1.0 means 100% of the shapes width.
|
float GetVectorBorder()
|
Returns the border width of the shapes in percent relative to the shapes width. See SetVectorBorder for further details.
|
void SetPixelBorder(int iBorder)
|
Sets the current border thickness of the shapes in pixels.
|
int GetPixelBorder()
|
Returns the current border thickness of the shapes in pixels.
|
int GetColorCount()
|
Returns the number of colors in the color table.
|
void AddColor(int idx, color c)
|
Adds another color to the color table at the specified index position. If the index is lower or equal to 0, the new color is added to the first position. If the index is greater than the current number of colors, the new color is added at the end.
|
void RemoveColor(int idx)
|
Removes the color located at the specified index. If the given index is out of range, nothing happens. The Color Table of this effect needs to include at least 1 entry.
|
void SetColor(int idx, color c)
|
Sets the color with the specified index in the Color Table to the given color. If the index is out of range, nothing happens.
|
color GetColor(int idx)
|
Returns the color with the specified index in the Color Table. If the index is out of range, black is returned.
|