Dragengine.Scenery.SynthesizerController Class Reference

Synthesizer or synthesizer instance controller. More...

Inheritance diagram for Dragengine.Scenery.SynthesizerController:

Public Member Functions
Management
Synthesizer	getSynthesizer ()
	Owner synthesizer or null if not owned by synthesizer. More...
SynthesizerInstance	getSynthesizerInstance ()
	Onwer synthesizer instance or null if not owned by synthesizer instance. More...
int	getControllerIndex ()
	Controller index. More...
Controllers
String	getName ()
	Name. More...
void	setName (String name)
	Set name. More...
float	getLower ()
	Lower limit. More...
float	getUpper ()
	Upper limit. More...
void	setRange (float lower, float upper)
	Set value range. More...
CurveBezier	getCurve ()
	Curve. More...
void	setCurve (CurveBezier curve)
	Set curve. More...
void	setCurveConstant (float value)
	Set curve of controller to a constant value. More...
void	setCurveTime ()
	Set curve of controller to linear curve along play time. More...
bool	getClamp ()
	Controller value is clamped instead of wrapped around if outside range. More...
void	setClamp (bool clamp)
	Set if controller value is clamped instead of wrapped around if outside range. More...
void	setCurveFrom (SynthesizerInstance instance)
	Set controller curve from another controller. More...
void	setAllFrom (SynthesizerInstance instance)
	Set entire controller configuration from another controller. More...

Detailed Description

Synthesizer or synthesizer instance controller.

Wraps a synthesizer or synthesizer instance controller by controller index. Valid only as long as the wrapped synthesizer or synthesizer instance does not change controller layout.

If wrapping a synthesizer instance controller any changes to a controller triggers an update in the game engine.

If wrapping a synthesizer controller the user is responsible to call Synthesizer.contentChanged() after changing one or more controllers. Synthesizer controllers should not be changed if possible after being used in synthesizer instances.

This is a native class.

Member Function Documentation

getClamp()

bool Dragengine.Scenery.SynthesizerController.getClamp

(

)

Controller value is clamped instead of wrapped around if outside range.

getControllerIndex()

int Dragengine.Scenery.SynthesizerController.getControllerIndex

(

)

Controller index.

getCurve()

CurveBezier Dragengine.Scenery.SynthesizerController.getCurve

(

)

Curve.

getLower()

float Dragengine.Scenery.SynthesizerController.getLower

(

)

Lower limit.

getName()

String Dragengine.Scenery.SynthesizerController.getName

(

)

Name.

getSynthesizer()

Synthesizer Dragengine.Scenery.SynthesizerController.getSynthesizer

(

)

Owner synthesizer or null if not owned by synthesizer.

getSynthesizerInstance()

SynthesizerInstance Dragengine.Scenery.SynthesizerController.getSynthesizerInstance

(

)

Onwer synthesizer instance or null if not owned by synthesizer instance.

getUpper()

float Dragengine.Scenery.SynthesizerController.getUpper

(

)

Upper limit.

setAllFrom()

void Dragengine.Scenery.SynthesizerController.setAllFrom

(

SynthesizerInstance

instance

)

Set entire controller configuration from another controller.

setClamp()

void Dragengine.Scenery.SynthesizerController.setClamp

(

bool

clamp

)

Set if controller value is clamped instead of wrapped around if outside range.

setCurve()

void Dragengine.Scenery.SynthesizerController.setCurve

(

CurveBezier

curve

)

Set curve.

setCurveConstant()

void Dragengine.Scenery.SynthesizerController.setCurveConstant

(

float

value

)

Set curve of controller to a constant value.

Helper method to set curve to constant interpolation with point (0,value).

setCurveFrom()

void Dragengine.Scenery.SynthesizerController.setCurveFrom

(

SynthesizerInstance

instance

)

Set controller curve from another controller.

setCurveTime()

void Dragengine.Scenery.SynthesizerController.setCurveTime

(

)

Set curve of controller to linear curve along play time.

Helper method to set curve to linear curve from (0,minval) to (playtime,maxval).

setName()

void Dragengine.Scenery.SynthesizerController.setName

(

String

name

)

Set name.

setRange()

void Dragengine.Scenery.SynthesizerController.setRange	(	float	lower,
		float	upper
	)

Set value range.

---

The documentation for this class was generated from the following file:

• SynthesizerController.ds