Drag[en]gine Game Engine  1.0
deSynthesizerSourceWave Class Reference

Synthesizer wave function source. More...

#include <deSynthesizerSourceWave.h>

Inheritance diagram for deSynthesizerSourceWave:
deSynthesizerSource deObject

Public Types

enum  eWaveType { ewtSine, ewtSquare, ewtSawTooth, ewtTriangle }
 Wave type. More...
 
- Public Types inherited from deSynthesizerSource
enum  eMixModes { emmBlend, emmAdd }
 Mixing modes. More...
 

Public Member Functions

Management
eWaveType GetType () const
 Wave type. More...
 
void SetType (eWaveType type)
 Set wave type. More...
 
float GetMinFrequency () const
 Minimum play frequency in Hz. More...
 
void SetMinFrequency (float frequency)
 Set minimum frequency in Hz. More...
 
float GetMaxFrequency () const
 Maximum frequency in Hz. More...
 
void SetMaxFrequency (float frequency)
 Set maximum frequency in Hz. More...
 
deSynthesizerControllerTargetGetTargetFrequency ()
 Play frequency target. More...
 
const deSynthesizerControllerTargetGetTargetFrequency () const
 
Visiting
virtual void Visit (deSynthesizerSourceVisitor &visitor)
 Visit source. More...
 
- Public Member Functions inherited from deSynthesizerSource
deSynthesizerGetSynthesizer () const
 Parent synthesizer. More...
 
void SetSynthesizer (deSynthesizer *synthesizer)
 Set parent synthesizer. More...
 
bool GetEnabled () const
 Source is enabled. More...
 
void SetEnabled (bool enabled)
 Set if source is enabled. More...
 
eMixModes GetMixMode () const
 Mixing mode. More...
 
void SetMixMode (eMixModes mode)
 Set mixing mode. More...
 
float GetBlendFactor () const
 Blend factor. More...
 
void SetBlendFactor (float factor)
 Set blend factor. More...
 
float GetMinVolume () const
 Volume minimum relative to speaker volume in the range from 0 to 1. More...
 
void SetMinVolume (float volume)
 Set minimum volume relative to speaker volume in the range from 0 to 1. More...
 
float GetMaxVolume () const
 Maximum volume relative to speaker volume in the range from 0 to 1. More...
 
void SetMaxVolume (float volume)
 Set maximum volume relative to speaker volume in the range from 0 to 1. More...
 
float GetMinPanning () const
 Minimum panning in the range from -1(left) to 1(right). More...
 
void SetMinPanning (float panning)
 Set minimum panning in the range from -1(left) to 1(right). More...
 
float GetMaxPanning () const
 Maximum panning in the range from -1(left) to 1(right). More...
 
void SetMaxPanning (float panning)
 Set maximum panning in the range from -1(left) to 1(right). More...
 
deSynthesizerControllerTargetGetTargetBlendFactor ()
 Blend factor target. More...
 
const deSynthesizerControllerTargetGetTargetBlendFactor () const
 
deSynthesizerControllerTargetGetTargetVolume ()
 Volume target. More...
 
const deSynthesizerControllerTargetGetTargetVolume () const
 
deSynthesizerControllerTargetGetTargetPanning ()
 Panning target. More...
 
const deSynthesizerControllerTargetGetTargetPanning () const
 
int GetEffectCount () const
 Number of effects. More...
 
deSynthesizerEffectGetEffectAt (int index) const
 Effect at index. More...
 
void AddEffect (deSynthesizerEffect *effect)
 Add effect. More...
 
void RemoveEffect (deSynthesizerEffect *effect)
 Remove effect. More...
 
void RemoveAllEffects ()
 Remove all effects. More...
 
 deSynthesizerSource ()
 Create synthesizer source. 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

 deSynthesizerSourceWave ()
 Create synthesizer wave generator source. More...
 
virtual ~deSynthesizerSourceWave ()
 Clean up synthesizer wave generator source. More...
 

Additional Inherited Members

- Protected Member Functions inherited from deSynthesizerSource
virtual ~deSynthesizerSource ()
 Clean up synthesizer source. More...
 
- Protected Member Functions inherited from deObject
virtual ~deObject ()
 Clean up object. More...
 

Detailed Description

Synthesizer wave function source.

Author
Pl├╝ss Roland
Version
1.0
Date
2015

Member Enumeration Documentation

◆ eWaveType

Wave type.

Enumerator
ewtSine 

Sine wave.

ewtSquare 

Square wave.

ewtSawTooth 

Saw-tooth wave.

ewtTriangle 

Triangle wave.

Constructor & Destructor Documentation

◆ deSynthesizerSourceWave()

deSynthesizerSourceWave::deSynthesizerSourceWave ( )

Create synthesizer wave generator source.

◆ ~deSynthesizerSourceWave()

virtual deSynthesizerSourceWave::~deSynthesizerSourceWave ( )
protectedvirtual

Clean up synthesizer wave generator source.

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

◆ GetMaxFrequency()

float deSynthesizerSourceWave::GetMaxFrequency ( ) const
inline

Maximum frequency in Hz.

References SetMaxFrequency().

◆ GetMinFrequency()

float deSynthesizerSourceWave::GetMinFrequency ( ) const
inline

Minimum play frequency in Hz.

References SetMinFrequency().

◆ GetTargetFrequency() [1/2]

deSynthesizerControllerTarget& deSynthesizerSourceWave::GetTargetFrequency ( )
inline

Play frequency target.

◆ GetTargetFrequency() [2/2]

const deSynthesizerControllerTarget& deSynthesizerSourceWave::GetTargetFrequency ( ) const
inline

References Visit().

◆ GetType()

eWaveType deSynthesizerSourceWave::GetType ( ) const
inline

Wave type.

References SetType().

◆ SetMaxFrequency()

void deSynthesizerSourceWave::SetMaxFrequency ( float  frequency)

Set maximum frequency in Hz.

Referenced by GetMaxFrequency().

◆ SetMinFrequency()

void deSynthesizerSourceWave::SetMinFrequency ( float  frequency)

Set minimum frequency in Hz.

Referenced by GetMinFrequency().

◆ SetType()

void deSynthesizerSourceWave::SetType ( eWaveType  type)

Set wave type.

Referenced by GetType().

◆ Visit()

virtual void deSynthesizerSourceWave::Visit ( deSynthesizerSourceVisitor visitor)
virtual

Visit source.

Reimplemented from deSynthesizerSource.

Referenced by GetTargetFrequency().


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