Drag[en]gine Game Engine  1.0
deSynthesizerSource Class Reference

Synthesizer source. More...

#include <deSynthesizerSource.h>

Inheritance diagram for deSynthesizerSource:
deObject deSynthesizerSourceChain deSynthesizerSourceGroup deSynthesizerSourceSound deSynthesizerSourceSynthesizer deSynthesizerSourceWave

Public Types

enum  eMixModes { emmBlend, emmAdd }
 Mixing modes. More...
 

Public Member Functions

Management
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
 
Effects
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...
 
Visiting
virtual void Visit (deSynthesizerSourceVisitor &visitor)
 Visit 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

 deSynthesizerSource ()
 Create synthesizer source. More...
 
virtual ~deSynthesizerSource ()
 Clean up synthesizer source. More...
 

Additional Inherited Members

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

Detailed Description

Synthesizer source.

Author
Pl├╝ss Roland
Version
1.0
Date
2015

Member Enumeration Documentation

◆ eMixModes

Mixing modes.

Enumerator
emmBlend 

Blend sound output of this source over the previous sound.

emmAdd 

Add sound output to the previous sounds clipping if too loud.

Constructor & Destructor Documentation

◆ deSynthesizerSource()

deSynthesizerSource::deSynthesizerSource ( )

Create synthesizer source.

◆ ~deSynthesizerSource()

virtual deSynthesizerSource::~deSynthesizerSource ( )
protectedvirtual

Clean up synthesizer 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

◆ AddEffect()

void deSynthesizerSource::AddEffect ( deSynthesizerEffect effect)

Add effect.

Referenced by GetTargetPanning().

◆ GetBlendFactor()

float deSynthesizerSource::GetBlendFactor ( ) const
inline

Blend factor.

References SetBlendFactor().

◆ GetEffectAt()

deSynthesizerEffect* deSynthesizerSource::GetEffectAt ( int  index) const

Effect at index.

Referenced by GetTargetPanning().

◆ GetEffectCount()

int deSynthesizerSource::GetEffectCount ( ) const

Number of effects.

Referenced by GetTargetPanning().

◆ GetEnabled()

bool deSynthesizerSource::GetEnabled ( ) const
inline

Source is enabled.

References SetEnabled().

◆ GetMaxPanning()

float deSynthesizerSource::GetMaxPanning ( ) const
inline

Maximum panning in the range from -1(left) to 1(right).

References SetMaxPanning().

◆ GetMaxVolume()

float deSynthesizerSource::GetMaxVolume ( ) const
inline

Maximum volume relative to speaker volume in the range from 0 to 1.

References SetMaxVolume().

◆ GetMinPanning()

float deSynthesizerSource::GetMinPanning ( ) const
inline

Minimum panning in the range from -1(left) to 1(right).

References SetMinPanning().

◆ GetMinVolume()

float deSynthesizerSource::GetMinVolume ( ) const
inline

Volume minimum relative to speaker volume in the range from 0 to 1.

References SetMinVolume().

◆ GetMixMode()

eMixModes deSynthesizerSource::GetMixMode ( ) const
inline

Mixing mode.

References SetMixMode().

◆ GetSynthesizer()

deSynthesizer* deSynthesizerSource::GetSynthesizer ( ) const
inline

Parent synthesizer.

References SetSynthesizer().

◆ GetTargetBlendFactor() [1/2]

deSynthesizerControllerTarget& deSynthesizerSource::GetTargetBlendFactor ( )
inline

Blend factor target.

◆ GetTargetBlendFactor() [2/2]

const deSynthesizerControllerTarget& deSynthesizerSource::GetTargetBlendFactor ( ) const
inline

◆ GetTargetPanning() [1/2]

deSynthesizerControllerTarget& deSynthesizerSource::GetTargetPanning ( )
inline

Panning target.

◆ GetTargetPanning() [2/2]

const deSynthesizerControllerTarget& deSynthesizerSource::GetTargetPanning ( ) const
inline

◆ GetTargetVolume() [1/2]

deSynthesizerControllerTarget& deSynthesizerSource::GetTargetVolume ( )
inline

Volume target.

◆ GetTargetVolume() [2/2]

const deSynthesizerControllerTarget& deSynthesizerSource::GetTargetVolume ( ) const
inline

◆ RemoveAllEffects()

void deSynthesizerSource::RemoveAllEffects ( )

Remove all effects.

Referenced by GetTargetPanning().

◆ RemoveEffect()

void deSynthesizerSource::RemoveEffect ( deSynthesizerEffect effect)

Remove effect.

Referenced by GetTargetPanning().

◆ SetBlendFactor()

void deSynthesizerSource::SetBlendFactor ( float  factor)

Set blend factor.

Referenced by GetBlendFactor().

◆ SetEnabled()

void deSynthesizerSource::SetEnabled ( bool  enabled)

Set if source is enabled.

Referenced by GetEnabled().

◆ SetMaxPanning()

void deSynthesizerSource::SetMaxPanning ( float  panning)

Set maximum panning in the range from -1(left) to 1(right).

Referenced by GetMaxPanning().

◆ SetMaxVolume()

void deSynthesizerSource::SetMaxVolume ( float  volume)

Set maximum volume relative to speaker volume in the range from 0 to 1.

Referenced by GetMaxVolume().

◆ SetMinPanning()

void deSynthesizerSource::SetMinPanning ( float  panning)

Set minimum panning in the range from -1(left) to 1(right).

Referenced by GetMinPanning().

◆ SetMinVolume()

void deSynthesizerSource::SetMinVolume ( float  volume)

Set minimum volume relative to speaker volume in the range from 0 to 1.

Referenced by GetMinVolume().

◆ SetMixMode()

void deSynthesizerSource::SetMixMode ( eMixModes  mode)

Set mixing mode.

Referenced by GetMixMode().

◆ SetSynthesizer()

void deSynthesizerSource::SetSynthesizer ( deSynthesizer synthesizer)

Set parent synthesizer.

This function has to be used only by the deSynthesizer class to assign itself as a parent. Do not call this function directly.

Referenced by GetSynthesizer().

◆ Visit()

virtual void deSynthesizerSource::Visit ( deSynthesizerSourceVisitor visitor)
virtual

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