SCE Starfield

   Print  Previous  Next

Functions Provided By SCE Starfield

This effect uses the following functions:

This Effect uses the Color Table. Learn more »Using Color Table
This Effect uses the BPM Control. Learn more »Using BPM Control
This Effect uses Look-At Types. Learn more »Using Look-At Types
This Effect uses Shapes. Learn more »Using Shapes

 

Function

Description

void SetLength(int value)

Sets the Length value, which defines how long the trace of the shapes is. Valid values for value range from 1 to 1000.

int GetLength()

Returns the current Length.

void SetCount(int value)

Sets the Count value, which is the number of the displayed shapes. Valid values for value range from 1 to 1000.

int GetCount()

Returns the current Count.

void SetSize(float value)

Sets the Size value, which is the size of the shapes in percent of the matrix size (depending on the look-at type). The Size value means the minimum shape size if the shape size distribution mode is not uniform. Valid values for value range from 0.01 to 1000.

float GetSize()

Returns the current Size of the shapes in percent. The return value means the minimum shape size if the shape size distribution mode is not uniform.

void SetPixelSize(int value)

Sets the size value, which is the size of the shapes, in pixels. The size value means the minimum shape size if the shape size distribution mode is not uniform. Valid values for value range from 1 to ten times the matrix size (depending on the look-at type).

int GetPixelSize()

Returns the current Size of the shapes in pixels. The return value means the minimum shape size, if the shape size distribution mode is not uniform.

void SetSizeMax(float value)

Sets the Maximum Size value, which is the maximum size of the shapes in percent of the matrix size (depending on the look-at type). The Maximum Size value only applies if the shape size distribution mode is not uniform. Valid values for value range from 0.01 to 1000.

float GetSizeMax()

Returns the current Maximum Size of the shapes in percent.

void SetPixelSizeMax(int value)

Sets the Maximum Size value, which is the maximum size of the shapes, in pixels. The Maximum Size value only applies if the shape size distribution mode is not uniform. Valid values for value range from 1 to ten times the matrix size (depending on the look-at type).

int GetPixelSizeMax()

Returns the current Maximum Size of the shapes in pixels.

void SetSizeDistribution(int value)

Sets the Size Distribution value, which defines how the range between the current minimum and the current maximum shape size is applied to the shapes. See »here for a list of constants.

int GetSizeDistribution()

Returns the current Size Distribution of the shapes. See »here for a list of constants.

void SeedRandomSize()

Randomizes the sizes of the shapes. Same as SetSizeDistribution(DIST_RND).

void SetRotation(int value)

Sets the Rotation value, which is the rotation of the flight paths, in degrees. The Rotation value means the minimum rotation if the  rotation distribution is not uniform. Valid values for value range from -3600 to 3600.

int GetRotation()

Returns the current Rotation of the flight paths in degrees. The return value means the minimum rotation if the rotation distribution is not uniform.

void SetRotationMax(int value)

Sets the Maximum Rotation value, which is the maximum rotation of the flight paths, in degrees. The Maximum Rotation value only applies if the rotation distribution is not uniform. Valid values for value range from -3600 to 3600.

int GetRotationMax()

Returns the current Maximum Rotation of the flight paths in degrees.

void SetRotationDistribution(int value)

Sets the Rotation Distribution value, which defines how the range between the current minimum and the current maximum rotation is applied to the flight paths. See »here for a list of constants.

int GetRotationDistribution()

Returns the current Rotation Distribution of the flight paths. See »here for a list of constants.

void SeedRandomRotation()

Randomizes the rotations of the flight paths. Same as SetRotationDistribution(DIST_RND).

void SetDistortion(int value)

Sets the Distortion value, which defines how deep the 3D space appears. Valid values for value range from 1 to 100.

int GetDistortion()

Returns the current Rotation Distribution.

void SetInvert(int value)

Use value TRUE to invert the flight paths, which means that the objects move from near to far. Use value FALSE to use the default setting, which is from far to near.

int GetInvert()

Returns TRUE, if the objects move from near to far, otherwise FALSE.

void ToggleInvert()

Inverts the flight paths or uses the default setting, depending on the current state.

 

MADRIX 2.X To MADRIX 3.X Migration Hints

The following functions and constants are not supported anymore. Please follow the hints to migrate your macros.

Function/Constant

Description

void SetWidth(int width)

Use SetSize(float value) instead.

int GetWidth()

Use GetSize() instead.

void SetDepth(int depth)

Use SetDistortion(int value) instead.

int GetDepth()

Use GetDistortion() instead.

void SetRotation(int rotation)

The unit of the value rotation changed from percent to degrees.

int GetRotation()

The unit of the return value changed from percent to degrees.

DIR_OUTWARDS

SetDirection(int direction) and GetDirection() do not support this special direction anymore. Use SetInvert(FALSE) instead.

DIR_INWARDS

SetDirection(int direction) and GetDirection() do not support this special direction anymore. Use SetInvert(TRUE) instead.

 

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