SCE Wave / Radial

   Print  Previous  Next

Functions Provided By SCE Wave/Radial

This effect uses the following functions:

This Effect uses Directions. Learn more »Using Direction
This Effect uses Shapes. Learn more »Using Shapes
This Effect uses the BPM Control. Learn more »Using BPM Control
This Effect uses the Color Controls. Learn more »Using Color Controls
This Effect uses the Center Control. Learn more »Using Center Control

 

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(float value)

Sets the Peak value of the wave.

float 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

Description

void SetDisplacement(float value)

Sets the Displacement value. Valid values range from 0.0 to 100.0.

float GetDisplacement()

Returns the current Displacement.

void SetDisplacementSpeed(float value)

Sets the Displacement Speed value. Valid values range from 0.0 to 100.0.

float GetDisplacementSpeed()

Returns the current Displacement Speed.

void SetDisplacementDistribution(int mode)

Sets the Displacement Distribution. See »here for a list of constants (not all apply).

int GetDisplacementDistribution()

Returns the current Displacement Distribution.

 

MADRIX 3.X To MADRIX 5.X Migration Hints

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

Function

Description

All functions of the Position Control

Use the Center Control instead.

 

MADRIX Version: 5.1b | Script Version: 3.10
[Ctrl & +/-] = Zoom In/Out | [Ctrl & 0] = 100%
Print   Previous   Next