libgig  3.3.0.svn3
sf2::Region Class Reference

Instrument zone. More...

#include <SF.h>

Public Member Functions

 Region ()
 
SampleGetSample ()
 
RegionGetParent ()
 
int GetUnityNote ()
 
InstrumentGetParentInstrument ()
 
int GetPan (Region *pPresetRegion=NULL)
 
int GetFineTune (Region *pPresetRegion=NULL)
 
int GetCoarseTune (Region *pPresetRegion=NULL)
 
double GetEG1PreAttackDelay (Region *pPresetRegion=NULL)
 
double GetEG1Attack (Region *pPresetRegion=NULL)
 
double GetEG1Hold (Region *pPresetRegion=NULL)
 
double GetEG1Decay (Region *pPresetRegion=NULL)
 
int GetEG1Sustain (Region *pPresetRegion=NULL)
 
double GetEG1Release (Region *pPresetRegion=NULL)
 
double GetEG2PreAttackDelay (Region *pPresetRegion=NULL)
 
double GetEG2Attack (Region *pPresetRegion=NULL)
 
double GetEG2Hold (Region *pPresetRegion=NULL)
 
double GetEG2Decay (Region *pPresetRegion=NULL)
 
int GetEG2Sustain (Region *pPresetRegion=NULL)
 
double GetEG2Release (Region *pPresetRegion=NULL)
 
int GetModEnvToPitch (Region *pPresetRegion=NULL)
 
int GetModLfoToPitch (Region *pPresetRegion=NULL)
 
int GetModEnvToFilterFc (Region *pPresetRegion=NULL)
 
int GetModLfoToFilterFc (Region *pPresetRegion=NULL)
 
double GetModLfoToVolume (Region *pPresetRegion=NULL)
 
double GetFreqModLfo (Region *pPresetRegion=NULL)
 
double GetDelayModLfo (Region *pPresetRegion=NULL)
 
int GetVibLfoToPitch (Region *pPresetRegion=NULL)
 
double GetFreqVibLfo (Region *pPresetRegion=NULL)
 
double GetDelayVibLfo (Region *pPresetRegion=NULL)
 
int GetInitialFilterFc (Region *pPresetRegion)
 
int GetInitialFilterQ (Region *pPresetRegion)
 

Public Attributes

int loKey
 
int hiKey
 
int minVel
 
int maxVel
 
int pan
 
int fineTune
 
int coarseTune
 
int overridingRootKey
 
int startAddrsOffset
 
int startAddrsCoarseOffset
 
int endAddrsOffset
 
int endAddrsCoarseOffset
 
int startloopAddrsOffset
 
int startloopAddrsCoarseOffset
 
int endloopAddrsOffset
 
int endloopAddrsCoarseOffset
 
int modEnvToPitch
 
int modLfoToPitch
 
int modEnvToFilterFc
 
int modLfoToFilterFc
 
int modLfoToVolume
 
int freqModLfo
 
int delayModLfo
 
int vibLfoToPitch
 
int freqVibLfo
 
int delayVibLfo
 
int initialFilterFc
 
int initialFilterQ
 
uint exclusiveClass
 
SamplepSample
 
bool HasLoop
 
uint LoopStart
 
uint LoopEnd
 
InstrumentpInstrument
 
std::vector< ModulatorItemmodulators
 

Friends

class Instrument
 
class Preset
 

Detailed Description

Instrument zone.

Definition at line 351 of file SF.h.

Constructor & Destructor Documentation

Member Function Documentation

int sf2::Region::GetCoarseTune ( Region pPresetRegion = NULL)

Definition at line 573 of file SF.cpp.

References coarseTune.

double sf2::Region::GetDelayModLfo ( Region pPresetRegion = NULL)

Definition at line 689 of file SF.cpp.

References sf2::CheckRange(), delayModLfo, and sf2::ToSeconds().

double sf2::Region::GetDelayVibLfo ( Region pPresetRegion = NULL)

Definition at line 707 of file SF.cpp.

References sf2::CheckRange(), delayVibLfo, and sf2::ToSeconds().

double sf2::Region::GetEG1Attack ( Region pPresetRegion = NULL)

Definition at line 587 of file SF.cpp.

References sf2::CheckRange(), and sf2::ToSeconds().

double sf2::Region::GetEG1Decay ( Region pPresetRegion = NULL)

Definition at line 599 of file SF.cpp.

References sf2::CheckRange(), and sf2::ToSeconds().

double sf2::Region::GetEG1Hold ( Region pPresetRegion = NULL)

Definition at line 593 of file SF.cpp.

References sf2::CheckRange(), and sf2::ToSeconds().

double sf2::Region::GetEG1PreAttackDelay ( Region pPresetRegion = NULL)

Definition at line 581 of file SF.cpp.

References sf2::CheckRange(), and sf2::ToSeconds().

double sf2::Region::GetEG1Release ( Region pPresetRegion = NULL)

Definition at line 611 of file SF.cpp.

References sf2::CheckRange(), and sf2::ToSeconds().

int sf2::Region::GetEG1Sustain ( Region pPresetRegion = NULL)

Definition at line 605 of file SF.cpp.

References sf2::CheckRange().

double sf2::Region::GetEG2Attack ( Region pPresetRegion = NULL)

Definition at line 623 of file SF.cpp.

References sf2::CheckRange(), and sf2::ToSeconds().

double sf2::Region::GetEG2Decay ( Region pPresetRegion = NULL)

Definition at line 635 of file SF.cpp.

References sf2::CheckRange(), and sf2::ToSeconds().

double sf2::Region::GetEG2Hold ( Region pPresetRegion = NULL)

Definition at line 629 of file SF.cpp.

References sf2::CheckRange(), and sf2::ToSeconds().

double sf2::Region::GetEG2PreAttackDelay ( Region pPresetRegion = NULL)

Definition at line 617 of file SF.cpp.

References sf2::CheckRange(), and sf2::ToSeconds().

double sf2::Region::GetEG2Release ( Region pPresetRegion = NULL)

Definition at line 647 of file SF.cpp.

References sf2::CheckRange(), and sf2::ToSeconds().

int sf2::Region::GetEG2Sustain ( Region pPresetRegion = NULL)

Definition at line 641 of file SF.cpp.

References sf2::CheckRange().

int sf2::Region::GetFineTune ( Region pPresetRegion = NULL)

Definition at line 565 of file SF.cpp.

References fineTune.

double sf2::Region::GetFreqModLfo ( Region pPresetRegion = NULL)

Definition at line 683 of file SF.cpp.

References sf2::CheckRange(), freqModLfo, and sf2::ToHz().

double sf2::Region::GetFreqVibLfo ( Region pPresetRegion = NULL)

Definition at line 701 of file SF.cpp.

References sf2::CheckRange(), freqVibLfo, and sf2::ToHz().

int sf2::Region::GetInitialFilterFc ( Region pPresetRegion)

Definition at line 713 of file SF.cpp.

References sf2::CheckRange(), and initialFilterFc.

int sf2::Region::GetInitialFilterQ ( Region pPresetRegion)

Definition at line 719 of file SF.cpp.

References sf2::CheckRange(), and initialFilterQ.

int sf2::Region::GetModEnvToFilterFc ( Region pPresetRegion = NULL)

Definition at line 665 of file SF.cpp.

References sf2::CheckRange(), and modEnvToFilterFc.

int sf2::Region::GetModEnvToPitch ( Region pPresetRegion = NULL)

Definition at line 653 of file SF.cpp.

References sf2::CheckRange(), and modEnvToPitch.

int sf2::Region::GetModLfoToFilterFc ( Region pPresetRegion = NULL)

Definition at line 671 of file SF.cpp.

References sf2::CheckRange(), and modLfoToFilterFc.

int sf2::Region::GetModLfoToPitch ( Region pPresetRegion = NULL)

Definition at line 659 of file SF.cpp.

References sf2::CheckRange(), and modLfoToPitch.

double sf2::Region::GetModLfoToVolume ( Region pPresetRegion = NULL)

Definition at line 677 of file SF.cpp.

References sf2::CheckRange(), and modLfoToVolume.

int sf2::Region::GetPan ( Region pPresetRegion = NULL)

Definition at line 557 of file SF.cpp.

References pan.

Region* sf2::Region::GetParent ( )
inline

Definition at line 379 of file SF.h.

Instrument* sf2::Region::GetParentInstrument ( )
inline
Returns
The instrument to which this region belongs, or NULL if it's preset region.

Definition at line 387 of file SF.h.

Sample* sf2::Region::GetSample ( )
inline

Definition at line 378 of file SF.h.

References pSample.

Referenced by sf2::File::DeleteSample().

int sf2::Region::GetUnityNote ( )

Definition at line 294 of file SF.cpp.

References sf2::Sample::OriginalPitch, overridingRootKey, and pSample.

int sf2::Region::GetVibLfoToPitch ( Region pPresetRegion = NULL)

Definition at line 695 of file SF.cpp.

References sf2::CheckRange(), and vibLfoToPitch.

Friends And Related Function Documentation

friend class Instrument
friend

Definition at line 423 of file SF.h.

friend class Preset
friend

Definition at line 424 of file SF.h.

Member Data Documentation

int sf2::Region::coarseTune
int sf2::Region::delayModLfo
int sf2::Region::delayVibLfo
int sf2::Region::endAddrsCoarseOffset

Definition at line 359 of file SF.h.

Referenced by sf2::Instrument::CreateRegion(), and Region().

int sf2::Region::endAddrsOffset

Definition at line 359 of file SF.h.

Referenced by sf2::Instrument::CreateRegion(), and Region().

int sf2::Region::endloopAddrsCoarseOffset

Definition at line 360 of file SF.h.

Referenced by sf2::Instrument::CreateRegion(), and Region().

int sf2::Region::endloopAddrsOffset

Definition at line 360 of file SF.h.

Referenced by sf2::Instrument::CreateRegion(), and Region().

uint sf2::Region::exclusiveClass

Definition at line 369 of file SF.h.

Referenced by sf2::Instrument::CreateRegion(), and Region().

int sf2::Region::fineTune
int sf2::Region::freqModLfo
int sf2::Region::freqVibLfo
bool sf2::Region::HasLoop

Definition at line 372 of file SF.h.

Referenced by sf2::Instrument::CreateRegion(), sf2::Sample::ReadAndLoop(), and Region().

int sf2::Region::hiKey

Definition at line 353 of file SF.h.

Referenced by sf2::Instrument::CreateRegion(), sf2::Query::next(), and Region().

int sf2::Region::initialFilterFc
int sf2::Region::initialFilterQ
int sf2::Region::loKey

Definition at line 353 of file SF.h.

Referenced by sf2::Instrument::CreateRegion(), sf2::Query::next(), and Region().

uint sf2::Region::LoopEnd

Definition at line 374 of file SF.h.

Referenced by sf2::Instrument::CreateRegion(), sf2::Sample::ReadAndLoop(), and Region().

uint sf2::Region::LoopStart

Definition at line 373 of file SF.h.

Referenced by sf2::Instrument::CreateRegion(), sf2::Sample::ReadAndLoop(), and Region().

int sf2::Region::maxVel

Definition at line 354 of file SF.h.

Referenced by sf2::Instrument::CreateRegion(), sf2::Query::next(), and Region().

int sf2::Region::minVel

Definition at line 354 of file SF.h.

Referenced by sf2::Instrument::CreateRegion(), sf2::Query::next(), and Region().

int sf2::Region::modEnvToFilterFc
int sf2::Region::modEnvToPitch
int sf2::Region::modLfoToFilterFc
int sf2::Region::modLfoToPitch
int sf2::Region::modLfoToVolume
std::vector<ModulatorItem> sf2::Region::modulators

Definition at line 389 of file SF.h.

int sf2::Region::overridingRootKey

Definition at line 358 of file SF.h.

Referenced by sf2::Instrument::CreateRegion(), GetUnityNote(), and Region().

int sf2::Region::pan

Definition at line 355 of file SF.h.

Referenced by sf2::Instrument::CreateRegion(), sf2::Preset::CreateRegion(), GetPan(), and Region().

Instrument* sf2::Region::pInstrument

Definition at line 375 of file SF.h.

Referenced by sf2::File::DeleteInstrument(), sf2::Preset::LoadRegions(), and Region().

Sample* sf2::Region::pSample

Definition at line 371 of file SF.h.

Referenced by GetSample(), GetUnityNote(), sf2::Instrument::LoadRegions(), and Region().

int sf2::Region::startAddrsCoarseOffset

Definition at line 359 of file SF.h.

Referenced by sf2::Instrument::CreateRegion(), and Region().

int sf2::Region::startAddrsOffset

Definition at line 359 of file SF.h.

Referenced by sf2::Instrument::CreateRegion(), and Region().

int sf2::Region::startloopAddrsCoarseOffset

Definition at line 360 of file SF.h.

Referenced by sf2::Instrument::CreateRegion(), and Region().

int sf2::Region::startloopAddrsOffset

Definition at line 360 of file SF.h.

Referenced by sf2::Instrument::CreateRegion(), and Region().

int sf2::Region::vibLfoToPitch

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