void SetLength(int value)

Sets the Length of the wave/radial, which is the wavelength in percent of the matrix size (depending on the current direction and the current shape).

int GetLength()

Returns the current Length of the wave/radial.

void SetWidth(int value)

Sets the Width of the wave/radial, which stretches or compresses the periodic part of the wave function in percent of the wavelength.

int GetWidth()

Returns the current Width of the wave/radial.

void SetCount(int value)

Sets the Count of tails. This feature is only supported by shape type SHAPE_TYPE_WAVE_RADAR and SHAPE_TYPE_WAVE_HELIX.

int GetCount()

Returns the current Count of tails.

void SetFactor(int value)

Sets the distortion Factor of the wave.

int GetFactor()

Returns the current distortion Factor of the wave.

void SetAmplitude(int value)

Sets the Amplitude value of the distortion factor. This feature is only supported when the distortion factor is higher than 0.

int GetAmplitude()

Return the current Amplitude of the distortion factor.

void SetPeak(int value)

Sets the Peak value of the wave. This feature is only supported by wave type WAVE_TYPE_TRIANGLE.

int GetPeak()

Returns the Peak value of the wave.

void SetWaveType(int wavetype)

Sets the Wave Type. See »here for a list of constants.

int GetWaveType()

Returns the current Wave Type. See »here for a list of constants.

void SetPhaseMode(int phasemode)

Use value PHASE_MODE_ON to activate Phase Mode. When Phase Mode is activated the color's green and blue color values will  be phase-shifted. Use value PHASE_MODE_OFF to use the default settings.

int GetPhaseMode()

Returns PHASE_MODE_ON if Phase Mode is enabled, otherwise PHASE_MODE_OFF.

void TogglePhaseMode()

Enables or disables the Phase Mode depending on the current state.

void SetGoingInDirection(int direction)

Use value GOING_IN_DIRECTION to activate Going In Direction. Use value GOING_OUT_DIRECTION to use the default settings. This feature is supported for all shape types, except for SHAPE_TYPE_WAVE_LINEAR.

int GetGoingInDirection()

Returns GOING_IN_DIRECTION if Going In Direction is enabled, otherwise GOING_OUT_DIRECTION.

void ToggleGoingInDirection()

Enables or disables the Going In Direction depending on the current state.

void SetClockwiseRotation(int rotation)

Use value CLOCKWISE_ROTATION to activate Clockwise Rotation. Use value COUNTER_CLOCKWISE_ROTATION to use the default settings. This feature is only supported by shape type SHAPE_TYPE_WAVE_RADAR and SHAPE_TYPE_WAVE_HELIX.

int GetClockwiseRotation()

Returns CLOCKWISE_ROTATION if Clockwise Rotation is enabled, otherwise COUNTER_CLOCKWISE_ROTATION.

void ToggleClockwiseRotation()

Enables or disables Clockwise Rotation depending on the current state.

Function / Constant

Description

void SetVectorCenter(float x, float y)

Use SetPosition(float x, float y, float z) instead. The new values x, y and z are in percent.

float GetVectorCenterX()

Use GetPositionX() instead. The new return value is in percent.

float GetVectorCenterY()

Use GetPositionY() instead. The new return value is in percent.

void SetEffectMode(int mode)

Use SetShapeType(int shapetype) instead.

EFFECT_CIRCLE

Use SHAPE_TYPE_WAVE_CIRCLE instead.

EFFECT_RADAR

Use SHAPE_TYPE_WAVE_RADAR instead.

EFFECT_HELIX

Use SHAPE_TYPE_WAVE_HELIX instead.

int GetEffectMode()

Use GetShapeType() instead.

void SetMonochrome()

Use SetPhaseMode(int phasemode) with phase mode PHASE_MODE_ON instead.

int GetMonochrome()

Use GetPhaseMode() instead.

void SetPhase()        

Use SetPhaseMode(int phasemode) with phase mode PHASE_MODE_OFF instead.

int GetPhase()

Use GetPhaseMode() instead.

void SetCurveMode(int curvemode)

Use SetWaveType(int wavetype) instead.

CURVE_SIN / EFFECT_SINE_WAVE

Use WAVE_TYPE_SINE instead.

CURVE_ABSSIN / EFFECT_ABS_SINE

Use WAVE_TYPE_SINE_ABSOLUTE instead.

CURVE_SAWTOOTH_DOWN / EFFECT_SAWTOOTH_DOWN

Use WAVE_TYPE_SAWTOOTH_DOWNWARDS instead.

CURVE_SAWTOOTH_UP / EFFECT_SAWTOOTH_UP

Use WAVE_TYPE_SAWTOOTH_UPWARDS instead.

CURVE_TRIANGLE / EFFECT_TRIANGLE

Use WAVE_TYPE_TRIANGLE instead.

CURVE_PHASE

Use SetPhaseMode(int phasemode) with phasemode PHASE_MODE_ON instead.

int GetCurveMode()

Use GetWaveType() instead.

void SetRotation(int clockwise)

Use SetClockwiseRotation(int clockwise) instead.

ROTATION_CW

Use CLOCKWISE_ROTATION instead.

ROTATION_CCW

Use COUNTER_CLOCKWISE_ROTATION instead.

int GetRotation()

Use GetClockwiseRotation() instead.

void SetVectorLength(int value)

Use SetLength(int value) instead. The new value is in percent.

int GetVectorLength()        

Use GetLength() instead. The new return value is in percent.

void SetDirection(int direction)

Used to cover multiple uses for SCE Wave and SCE Radial. SetDirection() can still be used to change the direction of the effect. See »here for a list of constants. Use SetGoingInDirection(int direction) to change the going in or going out direction.

DIR_OUTWARDS

Use GOING_OUT_DIRECTION instead.

DIR_INWARDS

Use GOING_IN_DIRECTION instead.