Drag[en]gine Game Engine  1.21
deSynthesizerEffectStretch Class Reference

Synthesizer effect stretch time and pitch. More...

#include <deSynthesizerEffectStretch.h>

Inheritance diagram for deSynthesizerEffectStretch:
deSynthesizerEffect deObject

Public Types

typedef deTObjectReference< deSynthesizerEffectStretchRef
 Type holding strong reference. More...
 
- Public Types inherited from deSynthesizerEffect
typedef deTObjectReference< deSynthesizerEffectRef
 Type holding strong reference. More...
 
- Public Types inherited from deObject
typedef deTObjectReference< deObjectRef
 Type holding strong reference. More...
 

Public Member Functions

Management
float GetMinTime () const
 Minimum time stretch factor. More...
 
void SetMinTime (float stretch)
 Set minimum time stretch factor. More...
 
float GetMaxTime () const
 Maximum time stretch factor. More...
 
void SetMaxTime (float stretch)
 Set maximum time stretch factor. More...
 
float GetMinPitch () const
 Minimum pitch shift factor. More...
 
void SetMinPitch (float shift)
 Set minimum pitch shift factor. More...
 
float GetMaxPitch () const
 Maximum pitch shift factor. More...
 
void SetMaxPitch (float shift)
 Set maximum pitch shift factor. More...
 
deSynthesizerControllerTargetGetTargetTime ()
 Time stretch target. More...
 
const deSynthesizerControllerTargetGetTargetTime () const
 
deSynthesizerControllerTargetGetTargetPitch ()
 Pitch stretch target. More...
 
const deSynthesizerControllerTargetGetTargetPitch () const
 
Visiting
virtual void Visit (deSynthesizerEffectVisitor &visitor)
 Visit effect. More...
 
- Public Member Functions inherited from deSynthesizerEffect
deSynthesizerGetSynthesizer () const
 Parent synthesizer. More...
 
void SetSynthesizer (deSynthesizer *synthesizer)
 Set parent synthesizer. More...
 
bool GetEnabled () const
 Effect is enabled. More...
 
void SetEnabled (bool enabled)
 Set if effect is enabled. More...
 
float GetStrength () const
 Strength. More...
 
void SetStrength (float strength)
 Set strength. More...
 
deSynthesizerControllerTargetGetTargetStrength ()
 Strength target. More...
 
const deSynthesizerControllerTargetGetTargetStrength () const
 
 deSynthesizerEffect ()
 Create synthesizer effect. 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

 deSynthesizerEffectStretch ()
 Create synthesizer stretch effect. More...
 
virtual ~deSynthesizerEffectStretch ()
 Clean up synthesizer stretch effect. More...
 

Additional Inherited Members

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

Detailed Description

Synthesizer effect stretch time and pitch.

Member Typedef Documentation

◆ Ref

Constructor & Destructor Documentation

◆ deSynthesizerEffectStretch()

deSynthesizerEffectStretch::deSynthesizerEffectStretch ( )

Create synthesizer stretch effect.

◆ ~deSynthesizerEffectStretch()

virtual deSynthesizerEffectStretch::~deSynthesizerEffectStretch ( )
protectedvirtual

Clean up synthesizer stretch effect.

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

◆ GetMaxPitch()

float deSynthesizerEffectStretch::GetMaxPitch ( ) const
inline

Maximum pitch shift factor.

◆ GetMaxTime()

float deSynthesizerEffectStretch::GetMaxTime ( ) const
inline

Maximum time stretch factor.

◆ GetMinPitch()

float deSynthesizerEffectStretch::GetMinPitch ( ) const
inline

Minimum pitch shift factor.

◆ GetMinTime()

float deSynthesizerEffectStretch::GetMinTime ( ) const
inline

Minimum time stretch factor.

◆ GetTargetPitch() [1/2]

deSynthesizerControllerTarget& deSynthesizerEffectStretch::GetTargetPitch ( )
inline

Pitch stretch target.

◆ GetTargetPitch() [2/2]

const deSynthesizerControllerTarget& deSynthesizerEffectStretch::GetTargetPitch ( ) const
inline

◆ GetTargetTime() [1/2]

deSynthesizerControllerTarget& deSynthesizerEffectStretch::GetTargetTime ( )
inline

Time stretch target.

◆ GetTargetTime() [2/2]

const deSynthesizerControllerTarget& deSynthesizerEffectStretch::GetTargetTime ( ) const
inline

◆ SetMaxPitch()

void deSynthesizerEffectStretch::SetMaxPitch ( float  shift)

Set maximum pitch shift factor.

◆ SetMaxTime()

void deSynthesizerEffectStretch::SetMaxTime ( float  stretch)

Set maximum time stretch factor.

◆ SetMinPitch()

void deSynthesizerEffectStretch::SetMinPitch ( float  shift)

Set minimum pitch shift factor.

◆ SetMinTime()

void deSynthesizerEffectStretch::SetMinTime ( float  stretch)

Set minimum time stretch factor.

◆ Visit()

virtual void deSynthesizerEffectStretch::Visit ( deSynthesizerEffectVisitor visitor)
virtual

Visit effect.

Reimplemented from deSynthesizerEffect.


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