Drag[en]gine Game Engine  1.0
deSynthesizerController Class Reference

Synthesizer controller. More...

#include <deSynthesizerController.h>

Inheritance diagram for deSynthesizerController:

Public Member Functions

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...
decCurveBezierGetCurve ()
 Value curve. More...
const decCurveBezierGetCurve () const
- 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.

Pl├╝ss Roland

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

Clean up animator.

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

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

References decMath::clamp(), and SetClamp().

◆ GetCurve() [1/2]

decCurveBezier& deSynthesizerController::GetCurve ( )

Value curve.

◆ GetCurve() [2/2]

const decCurveBezier& deSynthesizerController::GetCurve ( ) const

◆ GetMaximumValue()

float deSynthesizerController::GetMaximumValue ( ) const

Maximum value.

References SetValueRange().

◆ GetMinimumValue()

float deSynthesizerController::GetMinimumValue ( ) const

Minimum value.

◆ SetClamp()

void deSynthesizerController::SetClamp ( bool  clamp)

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

Referenced by GetClamp().

◆ SetValueRange()

void deSynthesizerController::SetValueRange ( float  minValue,
float  maxValue 

Set value range.

Referenced by GetMaximumValue().

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