libgig  4.0.0
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 352 of file SF.h.

Constructor & Destructor Documentation

◆ Region()

sf2::Region::Region ( )

Definition at line 262 of file SF.cpp.

Member Function Documentation

◆ GetCoarseTune()

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

Definition at line 572 of file SF.cpp.

References coarseTune.

◆ GetDelayModLfo()

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

Definition at line 688 of file SF.cpp.

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

◆ GetDelayVibLfo()

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

Definition at line 706 of file SF.cpp.

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

◆ GetEG1Attack()

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

Definition at line 586 of file SF.cpp.

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

◆ GetEG1Decay()

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

Definition at line 598 of file SF.cpp.

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

◆ GetEG1Hold()

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

Definition at line 592 of file SF.cpp.

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

◆ GetEG1PreAttackDelay()

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

Definition at line 580 of file SF.cpp.

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

◆ GetEG1Release()

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

Definition at line 610 of file SF.cpp.

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

◆ GetEG1Sustain()

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

Definition at line 604 of file SF.cpp.

References sf2::CheckRange().

◆ GetEG2Attack()

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

Definition at line 622 of file SF.cpp.

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

◆ GetEG2Decay()

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

Definition at line 634 of file SF.cpp.

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

◆ GetEG2Hold()

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

Definition at line 628 of file SF.cpp.

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

◆ GetEG2PreAttackDelay()

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

Definition at line 616 of file SF.cpp.

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

◆ GetEG2Release()

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

Definition at line 646 of file SF.cpp.

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

◆ GetEG2Sustain()

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

Definition at line 640 of file SF.cpp.

References sf2::CheckRange().

◆ GetFineTune()

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

Definition at line 564 of file SF.cpp.

References fineTune.

◆ GetFreqModLfo()

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

Definition at line 682 of file SF.cpp.

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

◆ GetFreqVibLfo()

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

Definition at line 700 of file SF.cpp.

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

◆ GetInitialFilterFc()

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

Definition at line 712 of file SF.cpp.

References sf2::CheckRange(), and initialFilterFc.

◆ GetInitialFilterQ()

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

Definition at line 718 of file SF.cpp.

References sf2::CheckRange(), and initialFilterQ.

◆ GetModEnvToFilterFc()

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

Definition at line 664 of file SF.cpp.

References sf2::CheckRange(), and modEnvToFilterFc.

◆ GetModEnvToPitch()

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

Definition at line 652 of file SF.cpp.

References sf2::CheckRange(), and modEnvToPitch.

◆ GetModLfoToFilterFc()

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

Definition at line 670 of file SF.cpp.

References sf2::CheckRange(), and modLfoToFilterFc.

◆ GetModLfoToPitch()

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

Definition at line 658 of file SF.cpp.

References sf2::CheckRange(), and modLfoToPitch.

◆ GetModLfoToVolume()

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

Definition at line 676 of file SF.cpp.

References sf2::CheckRange(), and modLfoToVolume.

◆ GetPan()

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

Definition at line 556 of file SF.cpp.

References pan.

◆ GetParent()

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

Definition at line 380 of file SF.h.

◆ GetParentInstrument()

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

Definition at line 388 of file SF.h.

◆ GetSample()

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

Definition at line 379 of file SF.h.

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

◆ GetUnityNote()

int sf2::Region::GetUnityNote ( )

Definition at line 294 of file SF.cpp.

◆ GetVibLfoToPitch()

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

Definition at line 694 of file SF.cpp.

References sf2::CheckRange(), and vibLfoToPitch.

Friends And Related Function Documentation

◆ Instrument

friend class Instrument
friend

Definition at line 424 of file SF.h.

◆ Preset

friend class Preset
friend

Definition at line 425 of file SF.h.

Member Data Documentation

◆ coarseTune

int sf2::Region::coarseTune

Definition at line 358 of file SF.h.

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

◆ delayModLfo

int sf2::Region::delayModLfo

Definition at line 365 of file SF.h.

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

◆ delayVibLfo

int sf2::Region::delayVibLfo

Definition at line 367 of file SF.h.

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

◆ endAddrsCoarseOffset

int sf2::Region::endAddrsCoarseOffset

Definition at line 360 of file SF.h.

Referenced by sf2::Instrument::CreateRegion().

◆ endAddrsOffset

int sf2::Region::endAddrsOffset

Definition at line 360 of file SF.h.

Referenced by sf2::Instrument::CreateRegion().

◆ endloopAddrsCoarseOffset

int sf2::Region::endloopAddrsCoarseOffset

Definition at line 361 of file SF.h.

Referenced by sf2::Instrument::CreateRegion().

◆ endloopAddrsOffset

int sf2::Region::endloopAddrsOffset

Definition at line 361 of file SF.h.

Referenced by sf2::Instrument::CreateRegion().

◆ exclusiveClass

uint sf2::Region::exclusiveClass

Definition at line 370 of file SF.h.

Referenced by sf2::Instrument::CreateRegion().

◆ fineTune

int sf2::Region::fineTune

Definition at line 357 of file SF.h.

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

◆ freqModLfo

int sf2::Region::freqModLfo

Definition at line 364 of file SF.h.

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

◆ freqVibLfo

int sf2::Region::freqVibLfo

Definition at line 366 of file SF.h.

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

◆ HasLoop

bool sf2::Region::HasLoop

Definition at line 373 of file SF.h.

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

◆ hiKey

int sf2::Region::hiKey

Definition at line 354 of file SF.h.

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

◆ initialFilterFc

int sf2::Region::initialFilterFc

◆ initialFilterQ

int sf2::Region::initialFilterQ

◆ loKey

int sf2::Region::loKey

Definition at line 354 of file SF.h.

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

◆ LoopEnd

uint sf2::Region::LoopEnd

Definition at line 375 of file SF.h.

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

◆ LoopStart

uint sf2::Region::LoopStart

Definition at line 374 of file SF.h.

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

◆ maxVel

int sf2::Region::maxVel

Definition at line 355 of file SF.h.

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

◆ minVel

int sf2::Region::minVel

Definition at line 355 of file SF.h.

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

◆ modEnvToFilterFc

int sf2::Region::modEnvToFilterFc

◆ modEnvToPitch

int sf2::Region::modEnvToPitch

◆ modLfoToFilterFc

int sf2::Region::modLfoToFilterFc

◆ modLfoToPitch

int sf2::Region::modLfoToPitch

◆ modLfoToVolume

int sf2::Region::modLfoToVolume

◆ modulators

std::vector<ModulatorItem> sf2::Region::modulators

Definition at line 390 of file SF.h.

◆ overridingRootKey

int sf2::Region::overridingRootKey

Definition at line 359 of file SF.h.

Referenced by sf2::Instrument::CreateRegion().

◆ pan

int sf2::Region::pan

Definition at line 356 of file SF.h.

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

◆ pInstrument

Instrument* sf2::Region::pInstrument

Definition at line 376 of file SF.h.

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

◆ pSample

Sample* sf2::Region::pSample

Definition at line 372 of file SF.h.

Referenced by sf2::Instrument::LoadRegions().

◆ startAddrsCoarseOffset

int sf2::Region::startAddrsCoarseOffset

Definition at line 360 of file SF.h.

Referenced by sf2::Instrument::CreateRegion().

◆ startAddrsOffset

int sf2::Region::startAddrsOffset

Definition at line 360 of file SF.h.

Referenced by sf2::Instrument::CreateRegion().

◆ startloopAddrsCoarseOffset

int sf2::Region::startloopAddrsCoarseOffset

Definition at line 361 of file SF.h.

Referenced by sf2::Instrument::CreateRegion().

◆ startloopAddrsOffset

int sf2::Region::startloopAddrsOffset

Definition at line 361 of file SF.h.

Referenced by sf2::Instrument::CreateRegion().

◆ vibLfoToPitch

int sf2::Region::vibLfoToPitch

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