Synthesizer wave function source. More...

#include <deSynthesizerSourceWave.h>

Inheritance diagram for deSynthesizerSourceWave:

Public Types
enum	eWaveType { ewtSine , ewtSquare , ewtSawTooth , ewtTriangle }
	Wave type. More...

typedef deTObjectReference< deSynthesizerSourceWave >	Ref
	Type holding strong reference. More...

Public Types inherited from deSynthesizerSource
enum	eMixModes { emmBlend , emmAdd }
	Mixing modes. More...

typedef deTObjectReference< deSynthesizerSource >	Ref
	Type holding strong reference. More...

Public Types inherited from deObject
typedef deTObjectReference< deObject >	Ref
	Type holding strong reference. 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...

deSynthesizerControllerTarget &	GetTargetFrequency ()
	Play frequency target. More...

const deSynthesizerControllerTarget &	GetTargetFrequency () const

Visiting
virtual void	Visit (deSynthesizerSourceVisitor &visitor)
	Visit source. More...

Public Member Functions inherited from deSynthesizerSource
deSynthesizer *	GetSynthesizer () 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...

deSynthesizerControllerTarget &	GetTargetBlendFactor ()
	Blend factor target. More...

const deSynthesizerControllerTarget &	GetTargetBlendFactor () const

deSynthesizerControllerTarget &	GetTargetVolume ()
	Volume target. More...

const deSynthesizerControllerTarget &	GetTargetVolume () const

deSynthesizerControllerTarget &	GetTargetPanning ()
	Panning target. More...

const deSynthesizerControllerTarget &	GetTargetPanning () const

int	GetEffectCount () const
	Number of effects. More...

deSynthesizerEffect *	GetEffectAt (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.

Member Typedef Documentation

◆ Ref

typedef deTObjectReference<deSynthesizerSourceWave> deSynthesizerSourceWave::Ref

Type holding strong reference.

Member Enumeration Documentation

◆ eWaveType

enum deSynthesizerSourceWave::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.

◆ GetMinFrequency()

float deSynthesizerSourceWave::GetMinFrequency ( ) const

inline

Minimum play frequency in Hz.

◆ GetTargetFrequency() [1/2]

deSynthesizerControllerTarget& deSynthesizerSourceWave::GetTargetFrequency ( )

inline

Play frequency target.

◆ GetTargetFrequency() [2/2]

const deSynthesizerControllerTarget& deSynthesizerSourceWave::GetTargetFrequency ( ) const

inline

◆ GetType()

eWaveType deSynthesizerSourceWave::GetType ( ) const

inline

Wave type.

◆ SetMaxFrequency()

void deSynthesizerSourceWave::SetMaxFrequency ( float frequency )

Set maximum frequency in Hz.

◆ SetMinFrequency()

void deSynthesizerSourceWave::SetMinFrequency ( float frequency )

Set minimum frequency in Hz.

◆ SetType()

void deSynthesizerSourceWave::SetType ( eWaveType type )

Set wave type.

◆ Visit()

virtual void deSynthesizerSourceWave::Visit ( deSynthesizerSourceVisitor & visitor )

virtual

Visit source.

Reimplemented from deSynthesizerSource.

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

deSynthesizerSourceWave.h

Public Types

Public Member Functions

Constructors and Destructors

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Ref

Member Enumeration Documentation

◆ eWaveType

Constructor & Destructor Documentation

◆ deSynthesizerSourceWave()

◆ ~deSynthesizerSourceWave()

Member Function Documentation

◆ GetMaxFrequency()

◆ GetMinFrequency()

◆ GetTargetFrequency() [1/2]

◆ GetTargetFrequency() [2/2]

◆ GetType()

◆ SetMaxFrequency()

◆ SetMinFrequency()

◆ SetType()

◆ Visit()