Function
|
Description
|
Effect Functions (Incl. All Layers)
|
float GetSpeedMaster()
|
Retrieves the value of the Speed Master.
|
void SetSpeedMaster(float value)
|
Sets the value for the Speed Master. Valid values range from -10.0 to 10.0.
|
int GetPause()
|
Retrieves the status of the Pause function.
|
void SetPause(int state)
|
Sets the Storage Place to Pause mode or not. Valid values are PAUSE or NOPAUSE. »Description
|
void TogglePause()
|
Toggles the status of the Pause function.
|
string GetDescription()
|
Retrieves the currently used Description of the Storage Place.
|
void SetDescription(string text)
|
Allows to name the Storage Place. The string variable text must be set in quotation marks. E.g. SetDescription("Storage Place 1");
|
int GetSubMaster()
|
Retrieves the current value of the Submaster.
|
void SetSubMaster(int value)
|
Sets the Submaster value. Valid values range from 0 to 255.
|
void SetSpeedPitch(float value)
|
Sets the Pitch value, which defines an additional multiplicative factor for the speed of the Storage. Valid values for value range from -10 to 10. Setting value lower than 0 lets most effects run backwards.
|
float GetSpeedPitch()
|
Returns the current Pitch.
|
int GetPlaceTime()
|
Returns the number of milliseconds that have passed since the Storage Place has been started.
|
Layer Functions (For Single Layers)
|
int GetLayerCount()
|
Retrieves the currently used number of Layers.
|
int LayerGetBlind(int number)
|
Retrieves if the specified Layer is used in Blind Mode. »Description
Layer indexing (number) starts with 0.
|
void LayerSetBlind(int number, int value)
|
Sets Blind Mode for a specified Layer. »Description
Layer indexing (number) starts with 0.
|
void LayerToggleBlind(int number)
|
Toggles Blind Mode for a specified Layer. »Description
Layer indexing (number) starts with 0.
|
int LayerGetSolo(int number)
|
Retrieves if the specified Layer is used in Solo Mode. »Description
Layer indexing (number) starts with 0.
|
void LayerSetSolo(int number, int value)
|
Sets Solo Mode for a specified Layer. »Description
Layer indexing (number) starts with 0.
|
void LayerToggleSolo(int number)
|
Toggles Solo Mode for a specified Layer. »Description
Layer indexing (number) starts with 0.
|
int LayerGetSubMaster(int number)
|
Retrieves the value of the Submaster of a specified Layer. Layer indexing (number) starts with 0.
|
void LayerSetSubMaster(int number, int value)
|
Sets the value of the Submaster of a specified Layer. Layer indexing (number) starts with 0.
|
int LayerGetOpacity(int number)
|
Retrieves the Opacity of the specified Layer. Layer indexing (number) starts with 0.
|
void LayerSetOpacity(int number, int value)
|
Sets the Opacity value of the specified Layer. Layer indexing (number) starts with 0.
|
int LayerGetMixMode(int number)
|
Retrieves the currently used Mix Mode of the specified Layer. Valid values are described »here. Layer indexing (number) starts with 0.
|
void LayerSetMixMode(int number, int value)
|
Sets the Mix Mode for the specified Layer. Valid values are described »here. Layer indexing (number) starts with 0.
|
int LayerGetLink(int number)
|
Retrieves if Link Mode is enabled for the specified Layer. Layer indexing (number) starts with 0.
|
void LayerSetLink(int number, int value)
|
Enables Link Mode for the specified Layer. Layer indexing (number) starts with 0.
|
void LayerToggleLink(int number)
|
Toggles Link Mode for the specified Layer. Layer indexing (number) starts with 0.
|
int LayerGetFilter(int number)
|
Returns which Filter (FX) is applied to the specified Layer. Layer indexing (number) starts with 0.
|
void LayerSetFilter(int number, int value)
|
Applies a Filter (FX) to the specified Layer. Layer indexing (number) starts with 0. Valid values for filter are »Filters
|
int LayerGetStep(int number)
|
Retrieves if the specified Layer uses stepped rendering. »Description
Layer indexing (number) starts with 0.
|
void LayerSetStep(int number, int value)
|
Sets the stepped rendering mode for the specified Layer. »Description
Layer indexing (number) starts with 0.
|
void LayerToggleStep(int number)
|
Toggles the stepped rendering mode for the specified Layer. »Description
Layer indexing (number) starts with 0.
|
int LayerGetAsync(int number)
|
Retrieves if the specified Layer uses asynchronous rendering. »Description
Layer indexing (number) starts with 0.
|
void LayerSetAsync(int number, int value)
|
Sets the asynchronous rendering mode for the specified Layer. »Description
Layer indexing (number) starts with 0..
|
void LayerToggleAsync(int number)
|
Toggles the asynchronous rendering mode for the specified Layer. »Description
Layer indexing (number) starts with 0.
|
float LayerGetFrameId(int number)
|
Returns the Frame ID of the current frame for the specified Layer. »Description
Layer indexing (number) starts with 0.
|
void LayerSetFrameId(int number, float value)
|
Sets the Frame ID of the current frame for the specified Layer. »Description
Layer indexing (number) starts with 0.
|
float LayerGetFrameSteps(int number)
|
Returns the number of frames which are between this and the last call of the specified Layer. »Description
Layer indexing (number) starts with 0.
|
float LayerGetFrameCount(int number)
|
Retrieves the number of frames used by the specified Layer. Layer indexing (number) starts with 0.
|
Mapping Functions (For Single Layers)
|
int LayerMapDlgIsMapped(int number)
|
Retrieves if the specified Layer is mapped. Layer indexing (number) starts with 0.
|
void LayerMapDlgSetMapVector(int number, float x, float y, float w, float h)
|
Maps the effect of the specified Layer to a certain area of the matrix using relative values. Layer indexing (number) starts with 0. x and y describe the coordinates. w and h describe width and height, respectively.
|
void LayerMapDlgSetMapVector3D(int number, float x, float y, float z, float w, float h, float d)
|
Maps the effect of the specified Layer to a certain area of the matrix in 3D using relative values. Layer indexing (number) starts with 0. x, y, and z describe the coordinates. w, h, and d describe width, height, and depth.
|
void LayerMapDlgSetMapPixel(int number, int x, int y, int w, int h);
|
Maps the effect of the specified Layer to a certain area of the matrix using pixel values. Layer indexing (number) starts with 0. x and y describe the coordinates. w and h describe width and height, respectively.
|
void LayerMapDlgSetMapPixel3D(int number, int x, int y, int z, int w, int h, int d);
|
Maps the effect of the specified Layer to a certain area of the matrix in 3D using pixel values. Layer indexing (number) starts with 0. x, y, and z describe the coordinates. w, h, and d describe width, height, and depth.
|
void LayerMapDlgGetMapVector(int number, float map[])
|
Retrieves the map settings for a specified Layer using relative values. Layer indexing (number) starts with 0. The values are saved in an array (map[]).
▪map[0] = X-coordinate (Position X)
▪map[1] = Y-coordinate (Position Y)
▪map[2] = width (Size X)
▪map[3] = height (Size Y) |
void LayerMapDlgGetMapVector3D(int number, float map[])
|
Retrieves the map settings for a specified Layer in 3D using relative values. Layer indexing (number) starts with 0. The values are saved in an array (map[]).
▪map[0] = X-coordinate (Position X)
▪map[1] = Y-coordinate (Position Y)
▪map[2] = Z-coordinate (Position Z)
▪map[3] = width (Size X)
▪map[4] = height (Size Y)
▪map[5] = depth (Size Z) |
void LayerMapDlgGetMapPixel(int number, int map[])
|
Retrieves the map settings for a specified Layer using pixel values. Layer indexing (number) starts with 0. The values are saved in an array (map[]).
▪map[0] = X-coordinate (Position X)
▪map[1] = Y-coordinate (Position Y)
▪map[2] = width (Size X)
▪map[3] = height (Size Y) |
void LayerMapDlgGetMapPixel3D(int number, int map[])
|
Retrieves the map settings for a specified Layer in 3D using pixel values. Layer indexing (number) starts with 0. The values are saved in an array (map[]).
▪map[0] = X-coordinate (Position X)
▪map[1] = Y-coordinate (Position Y)
▪map[2] = Z-coordinate (Position Z)
▪map[3] = width (Size X)
▪map[4] = height (Size Y)
▪map[5] = depth (Size Z) |
void LayerMapDlgSetTileVector(int number, float x, float y, float w, float h)
|
Tiles the effect of the specified Layer to a certain area using relative values. Layer indexing (number) starts with 0. x and y describe the coordinates. w and h describe width and height, respectively.
|
void LayerMapDlgSetTileVector3D(int number, float x, float y, float z, float w, float h, float d)
|
Tiles the effect of the specified Layer in a certain area in 3D using relative values. Layer indexing (number) starts with 0. x, y, and z describe the coordinates. w, h, and d describe width, height, and depth.
|
void LayerMapDlgSetTilePixel(int number, int x, int y, int w, int h)
|
Tiles the effect of the specified Layer in a certain area using pixel values. Layer indexing (number) starts with 0. x and y describe the coordinates. w and h describe width and height, respectively.
|
void LayerMapDlgSetTilePixel3D(int number, int x, int y, int z, int w, int h, int d)
|
Tiles the effect of the specified Layer in a certain area using pixel values. Layer indexing (number) starts with 0. x, y and z describe the coordinates. w, h, and d describe width, height, and depth.
|
void LayerMapDlgGetTileVector(int number, float tile[])
|
Retrieves the Tiling settings for a specified Layer using relative values. Layer indexing (number) starts with 0. The values are saved in an array (tile[]).
▪tile[0] = X-coordinate (Position X)
▪tile[1] = Y-coordinate (Position Y)
▪tile[2] = width (Size X)
▪tile[3] = height (Size Y) |
void LayerMapDlgGetTileVector3D(int number, float tile[])
|
Retrieves the Tiling settings for a specified Layer in 3D using relative values. Layer indexing (number) starts with 0. The values are saved in an array (tile[]).
▪tile[0] = X-coordinate (Position X)
▪tile[1] = Y-coordinate (Position Y)
▪tile[2] = Z-coordinate (Position Z)
▪tile[3] = width (Size X)
▪tile[4] = height (Size Y)
▪tile[5] = depth (Size Z) |
void LayerMapDlgGetTilePixel(int number, int tile[])
|
Retrieves the Tiling settings for a specified Layer using pixel values. Layer indexing (number) starts with 0. The values are saved in an array (tile[]).
▪tile[0] = X-coordinate (Position X)
▪tile[1] = Y-coordinate (Position Y)
▪tile[2] = width (Size X)
▪tile[3] = height (Size Y) |
void LayerMapDlgGetTilePixel3D(int number, int tile[])
|
Retrieves the Tiling settings for a specified Layer in 3D using pixel values. Layer indexing (number) starts with 0. The values are saved in an array (tile[]).
▪tile[0] = X-coordinate (Position X)
▪tile[1] = Y-coordinate (Position Y)
▪tile[2] = Z-coordinate (Position Z)
▪tile[3] = width (Size X)
▪tile[4] = height (Size Y)
▪tile[5] = depth (Size Z) |
void LayerMapDlgSetMapMode(int number, int mode)
|
Sets the Map Mirror Mode of the specified Layer. Layer indexing (number) starts with 0. See below for a list of constants.
|
void LayerMapDlgSetTileMode(int number, int mode)
|
Sets the Tile Mode of the specified Layer. Layer indexing (number) starts with 0. See below for a list of Tile Mode constants.
|
int LayerMapDlgGetMapMode(int number)
|
Retrieves the currently used Map Mirror Mode of the specified Layer. Layer indexing (number) starts with 0. See below for a list of constants.
|
int LayerMapDlgGetTileMode(int number)
|
Retrieves the currently used Tile Mode of the specified Layer. Layer indexing (number) starts with 0. See below for a list of Tile Mode constants.
|
void LayerMapDlgSetTileOffsetVector(int number, float x, float y)
|
Sets the Tiling Offset of the specified Layer using relative values. Layer indexing (number) starts with 0. x describes Offset X, while y represents Offset Y.
|
void LayerMapDlgSetTileOffsetVector3D(int number, float x, float y, float z)
|
Sets the Tiling Offset of the specified Layer in 3D using relative values. Layer indexing (number) starts with 0. x describes Offset X, y describes Offset Y, while z represents Offset Z.
|
void LayerMapDlgSetTileOffsetPixel(int number, int x, int y)
|
Sets the Tiling Offset of the specified Layer using pixel values. Layer indexing (number) starts with 0. x describes Offset X, while y represents Offset Y.
|
void LayerMapDlgSetTileOffsetPixel3D(int number, int x, int y, int z)
|
Sets the Tiling Offset of the specified Layer in 3D using pixel values. Layer indexing (number) starts with 0. x describes Offset X, y describes Offset Y, while z represents Offset Z.
|
void LayerMapDlgGetTileOffsetVector(int number, float offset[])
|
Retrieves the Tiling Offset of the specified Layer using relative values. Layer indexing (number) starts with 0. The values are saved in an array (offset[]).
▪offset[0] = X-coordinate (Offset X)
▪offset[1] = Y-coordinate (Offset Y) |
void LayerMapDlgGetTileOffsetVector3D(int number, float offset[])
|
Retrieves the Tiling Offset of the specified Layer in 3D using relative values. Layer indexing (number) starts with 0. The values are saved in an array (offset[]).
▪offset[0] = X-coordinate (Offset X)
▪offset[1] = Y-coordinate (Offset Y)
▪offset[2] = Z-coordinate (Offset Z) |
void LayerMapDlgGetTileOffsetPixel(int number, int offset[])
|
Retrieves the Tiling Offset of the specified Layer using pixel values. Layer indexing (number) starts with 0. The values are saved in an array (offset[]).
▪offset[0] = X-coordinate (Offset X)
▪offset[1] = Y-coordinate (Offset Y) |
void LayerMapDlgGetTileOffsetPixel3D(int number, int offset[])
|
Retrieves the Tiling Offset of the specified Layer in 3D using pixel values. Layer indexing (number) starts with 0. The values are saved in an array (offset[]).
▪offset[0] = X-coordinate (Offset X)
▪offset[1] = Y-coordinate (Offset Y)
▪offset[2] = Z-coordinate (Offset Z) |
void LayerMapDlgSetRotationXVector(int number, float value)
|
Sets the Rotation value for the X-axis of the specified Layer using relative values. Layer indexing (number) starts with 0.
|
void LayerMapDlgSetRotationXDegree(int number int value)
|
Sets the Rotation value for the X-axis of the specified Layer using degree values. Layer indexing (number) starts with 0.
|
float LayerMapDlgGetRotationXVector(int number)
|
Retrieves the Rotation for the X-axis of the specified Layer using relative values. Layer indexing (number) starts with 0.
|
int LayerMapDlgGetRotationXDegree(int number)
|
Retrieves the Rotation for the X-axis of the specified Layer using degree values. Layer indexing (number) starts with 0.
|
void LayerMapDlgSetRotationXMode(int number, int mode)
|
Sets the Rotation mode for the X-axis of the specified Layer. Layer indexing (number) starts with 0. See below for a list of rotation mode constants.
|
int LayerMapDlgGetRotationXMode(int number)
|
Retrieves the Rotation mode for the X-axis of the specified Layer. Layer indexing (number) starts with 0. See below for a list of rotation mode constants.
|
void LayerMapDlgSetRotationYVector(int number, float value)
|
Sets the Rotation value for the Y-axis of the specified Layer using relative values. Layer indexing (number) starts with 0.
|
void LayerMapDlgSetRotationYDegree(int number int value)
|
Sets the Rotation value for the Y-axis of the specified Layer using degree values. Layer indexing (number) starts with 0.
|
float LayerMapDlgGetRotationYVector(int number)
|
Retrieves the Rotation for the Y-axis of the specified Layer using relative values. Layer indexing (number) starts with 0.
|
int LayerMapDlgGetRotationYDegree(int number)
|
Retrieves the Rotation for the Y-axis of the specified Layer using degree values. Layer indexing (number) starts with 0.
|
void LayerMapDlgSetRotationYMode(int number, int mode)
|
Sets the Rotation mode for the Y-axis of the specified Layer. Layer indexing (number) starts with 0. See below for a list of rotation mode constants.
|
int LayerMapDlgGetRotationYMode(int number)
|
Retrieves the Rotation mode for the Y-axis of the specified Layer. Layer indexing (number) starts with 0. See belowfor a list of rotation mode constants.
|
void LayerMapDlgSetRotationZVector(int number, float value)
|
Sets the Rotation value for the Z-axis of the specified Layer using relative values. Layer indexing (number) starts with 0.
|
void LayerMapDlgSetRotationZDegree(int number int value)
|
Sets the Rotation value for the Z-axis of the specified Layer using degree values. Layer indexing (number) starts with 0.
|
float LayerMapDlgGetRotationZVector(int number)
|
Retrieves the Rotation value for the Z-axis of the specified Layer using relative values. Layer indexing (number) starts with 0.
|
int LayerMapDlgGetRotationZDegree(int number)
|
Retrieves the Rotation value for the Z-axis of the specified Layer using degree values. Layer indexing (number) starts with 0.
|
void LayerMapDlgSetRotationZMode(int number, int mode)
|
Sets the Rotation mode for the Z-axis of the specified Layer. Layer indexing (number) starts with 0. See below for a list of rotation mode constants.
|
int LayerMapDlgGetRotationZMode(int number)
|
Retrieves the Rotation mode for the Z-axis of the specified Layer. Layer indexing (number) starts with 0. See below for a list of rotation mode constants.
|
void LayerMapDlgSetRotationVector(int number, float x, float y, float z)
|
Sets the Rotation values for axes x, y, and z of the specified Layer using relative values. Layer indexing (number) starts with 0.
|
void LayerMapDlgSetRotationDegree(int number, int x, int y, int z)
|
Sets the Rotation values for axes x, y, and z of the specified Layer using degree values. Layer indexing (number) starts with 0.
|
void LayerMapDlgGetRotationVector(int number, float rot[])
|
Retrieves the Rotation values for axes x, y, and z of the specified Layer using relative values. Layer indexing (number) starts with 0. The values are saved in an array (rot[]).
▪rot[0] = X-coordinate (X-Axis)
▪rot[1] = Y-coordinate (Y-Axis)
▪rot[2] = Z-coordinate (Z-Axis) |
void LayerMapDlgGetRotationDegree(int number, int rot[])
|
Retrieves the Rotation values for axes x, y, and z of the specified Layer using degree values. Layer indexing (number) starts with 0. The values are saved in an array (rot[]).
▪rot[0] = X-coordinate (X-Axis)
▪rot[1] = Y-coordinate (Y-Axis)
▪rot[2] = Z-coordinate (Z-Axis) |
void LayerMapDlgSetRotationMode(int number, int x, int y, int z)
|
Sets the Rotation mode for axes x, y, and z of the specified Layer. Layer indexing (number) starts with 0. See below for a list of rotation mode constants.
|
void LayerMapDlgGetRotationMode(int number, int mode[])
|
Retrieves the Rotation mode for axes x, y, and z of the specified Layer. Layer indexing (number) starts with 0. See below for a list tile rotation mode constants. The values are saved in an array (mode[]).
▪mode[0] = X-coordinate (X-Axis)
▪mode[1] = Y-coordinate (Y-Axis)
▪mode[2] = Z-coordinate (Z-Axis) |
void LayerMapDlgSetAntiAliasing(int number, int aaLevel)
|
Sets the Anti-Aliasing mode of the specified Layer. Layer indexing (number) starts with 0. See below for a list of anti-aliasing mode constants.
|
int LayerMapDlgGetAntiAliasing(int number)
|
Retrieves the Anti-Aliasing mode of the specified Layer. Layer indexing (number) starts with 0. See below for a list of anti-aliasing mode constants.
|