Function

Description

Height

void SetHeight(float value)

Sets the Height value, which is the height of the shapes in percent of the matrix size (depending on the lookat type). The Height value means the minimum shape height if the shape height distribution is not uniform. Valid values for value range from 0.01 to 100.

float GetHeight()

Returns the current Height of the shapes in percent. The return value means the minimum shape height if the shape height distribution is not uniform.

void SetPixelHeight(int value)

Sets the Height value, which is the height of the shapes, in pixels. The Height value means the minimum shape height if the shape height distribution is not uniform. Valid values for value range from 1 to the matrix size (depending on the lookat type).

int GetPixelHeight()

Returns the current Height of the shapes in pixels. The return value means the minimum shape height if the shape height distribution is not uniform.

void SetHeightMax(float value)

Sets the Maximum Height value, which is the maximum height of the shapes, in percent of the matrix size (depending on the lookat type). The Maximum Height value only applies if the shape height distribution is not uniform. Valid values for value range from 0.01 to 100.

float GetHeightMax()

Returns the current Maximum Height of the shapes in percent.

void SetPixelHeightMax(int value)

Sets the Maximum Height value, which is the maximum height of the shapes, in pixels. The maximum height value only applies if the shape height distribution is not uniform. Valid values for value range from 1 to the matrix size (depending on the lookat type).

int GetPixelHeightMax()

Returns the current Maximum Height of the shapes in pixels.

void SetHeightDistribution(int value)

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

int GetHeightDistribution()

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

void SeedRandomHeight()

Randomizes the heights of the shapes. Same as SetHeightDistribution(DIST_RND).

Width/Depth

void SetWidth(float value, int register)

Sets the Width value for register reg, which is the width of the shapes, in percent of the matrix size (depending on the lookat type). The Width value means the minimum shape width if the shape width distribution is not uniform. Valid values for value range from 0.01 to 100. Valid values for reg are REGISTER_X1 or REGISTER_Z1. The width value for register REGISTER_Z1 actually controls the depth of the shapes.

float GetWidth(int register)

Returns the current Width of the shapes for register reg in percent. The return value means the minimum shape width if the shape width distribution is not uniform. Valid values for reg are REGISTER_X1 or REGISTER_Z1. The return value for register REGISTER_Z1 actually represents the depth of the shapes.

void SetPixelWidth(int value, int register)

Sets the Width value for register reg, which is the width of the shapes, in pixels. The Width value means the minimum shape width if the shape width distribution is not uniform. Valid values for value range from 1 to the matrix size (depending on the lookat type). Valid values for reg are REGISTER_X1 or REGISTER_Z1. The width value for register REGISTER_Z1 actually controls the depth of the shapes.

int GetPixelWidth(int reg)

Returns the current Width of the shapes for register reg in pixels. The return value means the minimum shape width if the shape width distribution is not uniform. Valid values for reg are REGISTER_X1 or REGISTER_Z1. The return value for register REGISTER_Z1 actually represents the depth of the shapes.

void SetWidthMax(float value, int register)

Sets the Maximum Width value for register reg, which is the maximum width of the shapes, in percent of the matrix size (depending on the lookat type). The Maximum Width value only applies if the shape width distribution is not uniform. Valid values for value range from 0.01 to 100. Valid values for reg are REGISTER_X1 or REGISTER_Z1. The maximum width value for register REGISTER_Z1 actually controls the maximum depth of the shapes.

float GetWidthMax(int register)

Returns the current Maximum Width of the shapes for register reg in percent. Valid values for reg are REGISTER_X1 or REGISTER_Z1. The return value for register REGISTER_Z1 actually represents the maximum depth of the shapes.

void SetPixelWidthMax(int value, int register)

Sets the Maximum Width value for register reg, which is the maximum width of the shapes, in pixels. The maximum width value only applies if the shape width distribution is not uniform. Valid values for value range from 1 to the matrix size (depending on the lookat type). Valid values for reg are REGISTER_X1 or REGISTER_Z1. The maximum width value for register REGISTER_Z1 actually controls the maximum depth of the shapes.

int GetPixelWidthMax(int register)

Returns the current Maximum Width of the shapes for register reg in pixels. Valid values for reg are REGISTER_X1 or REGISTER_Z1. The return value for register REGISTER_Z1 actually represents the maximum depth of the shapes.

void SetWidthDistribution(int value, int register)

Sets the width Distribution value for register reg, which defines how the range between the current minimum and the current maximum shape width is applied to the shapes. See »here for a list of constants. Valid values for reg are REGISTER_X1 and REGISTER_Z1. The width distribution value for register REGISTER_Z1 actually controls the depth distribution of the shapes.

int GetWidthDistribution(int register)

Returns the current width Distribution of the shapes for register reg. See »here for a list of constants. Valid values for reg are REGISTER_X1 or REGISTER_Z1. The return value for register REGISTER_Z1 actually represents the depth distribution of the shapes.

void SeedRandomWidth(int register)

Randomizes the widths of the shapes for register reg. Is the same as SetWidthDistribution(DIST_RND, reg). Valid values for reg are REGISTER_X1 or REGISTER_Z1.

Pitch

void SetPitch(float value, int register)

Sets the Pitch value for register reg, which is the distance of the shapes, in percent of the matrix size (depending on the lookat type). The pitch value means the minimum pitch if the pitch distribution is not uniform. Valid values for value range from 0.01 to 100. Valid values for reg are REGISTER_X1, for which the Pitch value controls the Xdistance, and REGISTER_Z1 for the Zdistance.

float GetPitch(int register)

Returns the current Pitch of the shapes for register reg in percent. The return value means the minimum pitch if the pitch distribution is not uniform. Valid values for reg are REGISTER_X1, for which the return value represents the Xdistance, and REGISTER_Z1 for the Zdistance.

void SetPixelPitch(int value, int register)

Sets the Pitch value for register reg, which is the distance of the shapes, in pixels. The pitch value means the minimum pitch if the pitch distribution is not uniform. Valid values for value range from 1 to the matrix size (depending on the lookat type). Valid values for reg are REGISTER_X1, for which the Pitch value controls the Xdistance, and REGISTER_Z1 for the Zdistance.

int GetPixelPitch(int register)

Returns the current Pitch of the shapes for register reg in pixels. The return value means the minimum pitch if the pitch distribution is not uniform. Valid values for reg are REGISTER_X1, for which the return value represents the Xdistance, and REGISTER_Z1 for the Zdistance.

void SetPitchMax(float value, int register)

Sets the Maximum Pitch value for register reg, which is the maximum distance of the shapes, in percent of the matrix size (depending on the lookat type). The maximum pitch value only applies if the pitch distribution is not uniform. Valid values for value range from 0.01 to 100. Valid values for reg are REGISTER_X1, for which the maximum pitch value controls the maximum Xdistance, and REGISTER_Z1 for the maximum Zdistance.

float GetPitchMax(int register)

Returns the current Maximum Pitch of the shapes for register reg in percent. Valid values for reg are REGISTER_X1, for which the return value represents the maximum Xdistance, and REGISTER_Z1 for the maximum Zdistance.

void SetPixelPitchMax(int value, int register)

Sets the Maximum Pitch value for register reg, which is the maximum distance of the shapes, in pixels. The maximum pitch value only applies if the pitch distribution is not uniform. Valid values for value range from 1 to the matrix size (depending on the lookat type). Valid values for reg are REGISTER_X1, for which the maximum pitch value controls the maximum Xdistance, and REGISTER_Z1 for the maximum Zdistance.

int GetPixelPitchMax(int register)

Returns the current Maximum Pitch of the shapes for register reg in pixels. Valid values for reg are REGISTER_X1, for which the return value represents the maximum Xdistance, and REGISTER_Z1 for the maximum Zdistance.

void SetPitchDistribution(int value, int register)

Sets the Pitch Distribution value for register reg, which defines how the range between the current minimum and the current maximum pitch is applied to the shapes. See »here for a list of constants. Valid values for reg are REGISTER_X1, for which the pitch distribution value controls the Xdistance distribution, and REGISTER_Z1 for the Zdistance distribution.

int GetPitchDistribution(int register)

Returns the current Pitch Distribution of the shapes for register reg. See »here for a list of constants. Valid values for reg are REGISTER_X1, for which the return value represents the Xdistance distribution, and REGISTER_Z1 for the Zdistance distribution.

void SeedRandomPitch(int register)

Randomizes the pitches of the shapes for register reg. Is the same as SetPitchDistribution(DIST_RND, reg). Valid values for reg are REGISTER_X1 or REGISTER_Z1.

Functional Parameters

void SetFrequency(float value, int register)

Sets the Frequency value for register reg, which defines the number of periods of the graph function. The frequency value means the minimum frequency if the frequency distribution is not uniform. Valid values for value range from 0 to 100. See below for a list of register constants.

float GetFrequency(int register)

Returns the current Frequency for register reg. The return value means the minimum frequency if the frequency distribution is not uniform. See below for a list of register constants.

void SetFrequencyMax(float value, int register)

Sets the Maximum Frequency value for register reg, which defines the maximum number of periods of the graph function. The maximum frequency value only applies if the frequency distribution is not uniform. Valid values for value range from 0 to 100. See below for a list of register constants.

float GetFrequencyMax(int register)

Returns the current Maximum Frequency for register reg. See below for a list of register constants.

void SetFrequencyDistribution(int value, int register)

Sets the Frequency Distribution value for register reg, which defines how the range between the current minimum and the current maximum frequency is applied to the shapes. See »here for a list of constants. See below for a list of register constants.

int GetFrequencyDistribution(int register)

Returns the current Frequency Distribution for register reg. See »here for a list of constants. See below for a list of register constants.

void SeedRandomFrequency(int register)

Randomizes the frequencies for register reg. Same as SetFrequencyDistribution(DIST_RND, reg). See below for a list of register constants.

void SetAmplitude(float value, int register)

Sets the Amplitude value for register reg, which defines how wide the shapes oscillate, in percent of the matrix size (depending on the lookat type). The amplitude value means the minimum amplitude if the amplitude distribution is not uniform. Valid values for value range from 1000 to 1000. See below for a list of register constants.

float GetAmplitude(int register)

Returns the current Amplitude for register reg in percent. The return value means the minimum amplitude if the amplitude distribution is not uniform. See below for a list of register constants.

void SetPixelAmplitude(int value, int register)

Sets the Amplitude value for register reg, which defines how wide the shapes oscillate, in pixels. The amplitude value means the minimum amplitude if the amplitude distribution is not uniform. Valid values for value range between  and + ten times the matrix size (depending on the lookat type). See below for a list of register constants.

int GetPixelAmplitude(int register)

Returns the current Amplitude for register reg in pixels. The return value means the minimum amplitude if the amplitude distribution is not uniform. See below for a list of register constants.

void SetAmplitudeMax(float value, int register)

Sets the Maximum Amplitude value for register reg, which defines how wide the shapes oscillate, in percent of the matrix size (depending on the lookat type). The maximum amplitude value only applies if the amplitude distribution is not uniform. Valid values for value range from 1000 to 1000. See below for a list of register constants.

float GetAmplitudeMax(int register)

Returns the current Maximum Amplitude for register reg in percent. See below for a list of register constants.

void SetPixelAmplitudeMax(int value, int register)

Sets the Maximum Amplitude value for register reg, which defines how wide the shapes oscillate, in pixels. The maximum amplitude value only applies if the amplitude distribution is not uniform. Valid values for value range between  and + ten times the matrix size (depending on the lookat type). See below for a list of register constants.

int GetPixelAmplitudeMax(int register)

Returns the current Maximum Amplitude for register reg in pixels. See below for a list of register constants.

void SetAmplitudeDistribution(int value, int register)

Sets the Amplitude Distribution value for register reg, which defines how the range between the current minimum and the current maximum amplitude is applied to the shapes. See »here for a list of constants. See below for a list of register constants.

int GetAmplitudeDistribution(int register)

Returns the current Amplitude Distribution for register reg. See »here for a list of constants. See below for a list of register constants.

void SeedRandomAmplitude(int register)

Randomizes the amplitudes for register reg. Is the same as SetAmplitudeDistribution(DIST_RND, reg). See below for a list of register constants.

void SetPhase(float value, int register)

Sets the Phase value for register reg, which defines an offset for the graph function, in percent of the wavelength. Valid values for value range from 0 to 100. See below for a list of register constants.

float GetPhase(int register)

Returns the current Phase for register reg in percent. See below for a list of register constants.

void SetPeak(float value, int register)

Sets the Peak value for register reg, which defines a threshold for the graph function, in percent of the wavelength. This only applies to the Triangle and the Square function type. Valid values for value range from 0 to 100. See below for a list of register constants.

float GetPeak(int register)

Returns the current Peak for register reg in percent. See below for a list of register constants.

void SetFunctionType(int value, int register)

Sets the Function Type value for register reg, which defines the base function for the graph. See »here for a list of constants. See below for a list of register constants.

int GetFunctionType(int register)

Returns the current Function Type for register reg. See »here for a list of constants. See below for a list of register constants.

Others

void ClearRegister(int register)

Sets all functional parameters for register reg to their defaults. See below for a list of register constants.
