deSynthesizerController Class Reference

Synthesizer controller. More...

#include <deSynthesizerController.h>

Inheritance diagram for deSynthesizerController:

Public Types
typedef deTObjectReference< deSynthesizerController >	Ref
	Type holding strong reference. More...
Public Types inherited from deObject
typedef deTObjectReference< deObject >	Ref
	Type holding strong reference. More...

Public Member Functions
Management
const decString &	GetName () const
	Name. More...
void	SetName (const char *name)
	Set name. More...
float	GetMinimumValue () const
	Minimum value. More...
float	GetMaximumValue () const
	Maximum value. More...
void	SetValueRange (float minValue, float maxValue)
	Set value range. More...
bool	GetClamp () const
	Clamp current value to range instead of wrapping around at the end points. More...
void	SetClamp (bool clamp)
	Set if current value is clamped to range instead of wrapping around at the end points. More...
const decCurveBezier &	GetCurve () const
	Value curve. More...
void	SetCurve (const decCurveBezier &curve)
	Set value curve. More...
Operators
deSynthesizerController &	operator= (const deSynthesizerController &controller)
	Copy controller parameters. More...
Public Member Functions inherited from deObject
int	GetRefCount () const
	Reference count. More...
void	AddReference ()
	Add reference increasing reference count by 1. More...
void	FreeReference ()
	Decrease reference count by one and delete object if count reaches 0. More...
	deObject ()
	Create object with reference count of 1. More...

Constructors and Destructors
	deSynthesizerController ()
	Create controller. More...
	deSynthesizerController (const deSynthesizerController &controller)
	Create copy of controller. More...
virtual	~deSynthesizerController ()
	Clean up animator. More...

Additional Inherited Members
Protected Member Functions inherited from deObject
virtual	~deObject ()
	Clean up object. More...

Detailed Description

Synthesizer controller.

Controllers provide the user with control over how the individual sounds of a synthesizer produce the final sound. Controllers are written in a way that you can use them without having to do scaling or transformation on your own. You can provide a minimum and maximum value matching your setup. The controller takes care of transforming the current value into the proper 0 to 1 range required for sounds to work with. The current value is calculated using an value curve set by the user. The play position is used to sample the curve producing the controller values over time.

Member Typedef Documentation

Ref

typedef deTObjectReference<deSynthesizerController> deSynthesizerController::Ref

Type holding strong reference.

Constructor & Destructor Documentation

deSynthesizerController() [1/2]

deSynthesizerController::deSynthesizerController

(

)

Create controller.

deSynthesizerController() [2/2]

deSynthesizerController::deSynthesizerController

(

const deSynthesizerController &

controller

)

Create copy of controller.

~deSynthesizerController()

virtual deSynthesizerController::~deSynthesizerController ( )

protectedvirtual

Clean up animator.

Note

Subclasses should set their destructor protected too to avoid users accidently deleting a reference counted object through the object pointer. Only FreeReference() is allowed to delete the object.

Member Function Documentation

GetClamp()

bool deSynthesizerController::GetClamp ( ) const

inline

Clamp current value to range instead of wrapping around at the end points.

GetCurve()

const decCurveBezier& deSynthesizerController::GetCurve ( ) const

inline

Value curve.

GetMaximumValue()

float deSynthesizerController::GetMaximumValue ( ) const

inline

Maximum value.

GetMinimumValue()

float deSynthesizerController::GetMinimumValue ( ) const

inline

Minimum value.

GetName()

const decString& deSynthesizerController::GetName ( ) const

inline

Name.

operator=()

deSynthesizerController& deSynthesizerController::operator=

(

const deSynthesizerController &

controller

)

Copy controller parameters.

SetClamp()

void deSynthesizerController::SetClamp

(

bool

clamp

)

Set if current value is clamped to range instead of wrapping around at the end points.

SetCurve()

void deSynthesizerController::SetCurve

(

const decCurveBezier &

curve

)

Set value curve.

SetName()

void deSynthesizerController::SetName

(

const char *

name

)

Set name.

SetValueRange()

void deSynthesizerController::SetValueRange	(	float	minValue,
		float	maxValue
	)

Set value range.

---

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

• deSynthesizerController.h