Function
|
Description
|
void SetColorMode(color colmode)
|
Sets the effect color mode. See the color mode table below for further details.
|
color GetColorMode()
|
Returns the current color mode. See the color mode 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 shapes of the objects. See below for details.
|
void SetCount(int fade)
|
Sets the number of shapes which shall be created.
|
int GetCount()
|
Returns the number of shapes currently used.
|
void SetVectorWidth(float vWidth)
|
Sets the size of the shapes in percent in relation to the matrix size. A value of 0.01 means a width of 1%, whereas 1.0 means 100%. Valid values range from 0.01 to 99.99. The given value is related to the smaller dimension of the matrix. So, if there is a matrix with a size of 5x20 pixels, 5 is used. And 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 as percentage. See SetVectorWidth for further details.
|
void SetPixelWidth(int iWidth)
|
Sets the size of the objects in pixels. Valid values range from 1 to 9999.
|
int GetPixelWidth()
|
Returns the size of the objects in pixels.
|
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 gets a width of 5 pixels. Valid values range from 0.01 to 99.99. 1.0 represents 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.
|
void SetColor(int idx, color c)
|
Sets the color with the specified index to the given color value. 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.
|
int GetColorCount()
|
Returns the current 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.
|