deSynthesizerSourceSynthesizer Class Reference

Synthesizer source using another synthesizer. More...

#include <deSynthesizerSourceSynthesizer.h>

Inheritance diagram for deSynthesizerSourceSynthesizer:

Public Types
typedef deTObjectReference< deSynthesizerSourceSynthesizer >	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
deSynthesizer *	GetSynthesizer () const
	Synthesizer or NULL if silent. More...
void	SetSynthesizer (deSynthesizer *synthesizer)
	Set synthesizer or NULL if silent. More...
void	UpdateConnectionCount ()
	Update connection count. More...
int	GetConnectionCount () const
	Number of connections. More...
int	GetConnectionAt (int childController) const
	Index of local controller for child controller. More...
void	SetConnectionAt (int childController, int localController)
	Set index of local controller for child controller. More...
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
	deSynthesizerSourceSynthesizer ()
	Create synthesizer source. More...
virtual	~deSynthesizerSourceSynthesizer ()
	Clean up synthesizer 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 source using another synthesizer.

Member Typedef Documentation

Ref

typedef deTObjectReference<deSynthesizerSourceSynthesizer> deSynthesizerSourceSynthesizer::Ref

Type holding strong reference.

Constructor & Destructor Documentation

deSynthesizerSourceSynthesizer()

deSynthesizerSourceSynthesizer::deSynthesizerSourceSynthesizer

(

)

Create synthesizer source.

~deSynthesizerSourceSynthesizer()

virtual deSynthesizerSourceSynthesizer::~deSynthesizerSourceSynthesizer ( )

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

GetConnectionAt()

int deSynthesizerSourceSynthesizer::GetConnectionAt

(

int

childController

)

const

Index of local controller for child controller.

GetConnectionCount()

int deSynthesizerSourceSynthesizer::GetConnectionCount ( ) const

inline

Number of connections.

This is the number of controllers in the child synthesizer if present or 0 if absent.

GetSynthesizer()

deSynthesizer* deSynthesizerSourceSynthesizer::GetSynthesizer ( ) const

inline

Synthesizer or NULL if silent.

SetConnectionAt()

void deSynthesizerSourceSynthesizer::SetConnectionAt	(	int	childController,
		int	localController
	)

Set index of local controller for child controller.

SetSynthesizer()

void deSynthesizerSourceSynthesizer::SetSynthesizer

(

deSynthesizer *

synthesizer

)

Set synthesizer or NULL if silent.

UpdateConnectionCount()

void deSynthesizerSourceSynthesizer::UpdateConnectionCount

(

)

Update connection count.

You have to call this method after you changed the child synthesizer without first removing it from this synthesizer.

Visit()

virtual void deSynthesizerSourceSynthesizer::Visit ( deSynthesizerSourceVisitor &  visitor )

virtual

Visit source.

Reimplemented from deSynthesizerSource.

---

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

• deSynthesizerSourceSynthesizer.h