sf2::Region Class Reference

Instrument zone. More...

#include <SF.h>

List of all members.

Public Member Functions
	Region ()
Sample *	GetSample ()
Region *	GetParent ()
int	GetUnityNote ()
Instrument *	GetParentInstrument ()
	Returns: The instrument to which this region belongs, or NULL if it's preset region.
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)
double	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)
double	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)
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
uint	exclusiveClass
Sample *	pSample
bool	HasLoop
uint	LoopStart
uint	LoopEnd
Instrument *	pInstrument
std::vector< ModulatorItem >	modulators
Friends
class	Instrument
class	Preset

---

Detailed Description

Instrument zone.

Definition at line 347 of file SF.h.

---

Constructor & Destructor Documentation

sf2::Region::Region

(

)

Definition at line 263 of file SF.cpp.

References coarseTune, delayModLfo, delayVibLfo, endAddrsCoarseOffset, endAddrsOffset, endloopAddrsCoarseOffset, endloopAddrsOffset, exclusiveClass, fineTune, freqModLfo, freqVibLfo, HasLoop, hiKey, loKey, LoopEnd, LoopStart, maxVel, minVel, modEnvToFilterFc, modEnvToPitch, modLfoToFilterFc, modLfoToPitch, modLfoToVolume, overridingRootKey, pan, pInstrument, pSample, startAddrsCoarseOffset, startAddrsOffset, startloopAddrsCoarseOffset, startloopAddrsOffset, and vibLfoToPitch.

---

Member Function Documentation

Sample* sf2::Region::GetSample

(

)

[inline]

Definition at line 372 of file SF.h.

References pSample.

Region* sf2::Region::GetParent

(

)

[inline]

Definition at line 373 of file SF.h.

int sf2::Region::GetUnityNote

(

)

Definition at line 292 of file SF.cpp.

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

Instrument* sf2::Region::GetParentInstrument

(

)

[inline]

Returns:

The instrument to which this region belongs, or NULL if it's preset region.

Definition at line 381 of file SF.h.

int sf2::Region::GetPan

(

Region *

pPresetRegion = NULL

)

Definition at line 506 of file SF.cpp.

References pan.

int sf2::Region::GetFineTune

(

Region *

pPresetRegion = NULL

)

Definition at line 514 of file SF.cpp.

References fineTune.

int sf2::Region::GetCoarseTune

(

Region *

pPresetRegion = NULL

)

Definition at line 522 of file SF.cpp.

References coarseTune.

double sf2::Region::GetEG1PreAttackDelay

(

Region *

pPresetRegion = NULL

)

Definition at line 530 of file SF.cpp.

References EG1PreAttackDelay, and sf2::ToSeconds().

double sf2::Region::GetEG1Attack

(

Region *

pPresetRegion = NULL

)

Definition at line 535 of file SF.cpp.

References EG1Attack, and sf2::ToSeconds().

double sf2::Region::GetEG1Hold

(

Region *

pPresetRegion = NULL

)

Definition at line 540 of file SF.cpp.

References EG1Hold, and sf2::ToSeconds().

double sf2::Region::GetEG1Decay

(

Region *

pPresetRegion = NULL

)

Definition at line 545 of file SF.cpp.

References EG1Decay, and sf2::ToSeconds().

double sf2::Region::GetEG1Sustain

(

Region *

pPresetRegion = NULL

)

Definition at line 550 of file SF.cpp.

References EG1Sustain, and sf2::ToPermilles().

double sf2::Region::GetEG1Release

(

Region *

pPresetRegion = NULL

)

Definition at line 555 of file SF.cpp.

References EG1Release, and sf2::ToSeconds().

double sf2::Region::GetEG2PreAttackDelay

(

Region *

pPresetRegion = NULL

)

Definition at line 560 of file SF.cpp.

References EG2PreAttackDelay, and sf2::ToSeconds().

double sf2::Region::GetEG2Attack

(

Region *

pPresetRegion = NULL

)

Definition at line 565 of file SF.cpp.

References EG2Attack, and sf2::ToSeconds().

double sf2::Region::GetEG2Hold

(

Region *

pPresetRegion = NULL

)

Definition at line 570 of file SF.cpp.

References EG2Hold, and sf2::ToSeconds().

double sf2::Region::GetEG2Decay

(

Region *

pPresetRegion = NULL

)

Definition at line 575 of file SF.cpp.

References EG2Decay, and sf2::ToSeconds().

double sf2::Region::GetEG2Sustain

(

Region *

pPresetRegion = NULL

)

Definition at line 580 of file SF.cpp.

References EG2Sustain.

double sf2::Region::GetEG2Release

(

Region *

pPresetRegion = NULL

)

Definition at line 587 of file SF.cpp.

References EG2Release, and sf2::ToSeconds().

int sf2::Region::GetModEnvToPitch

(

Region *

pPresetRegion = NULL

)

Definition at line 592 of file SF.cpp.

References modEnvToPitch.

int sf2::Region::GetModLfoToPitch

(

Region *

pPresetRegion = NULL

)

Definition at line 596 of file SF.cpp.

References modLfoToPitch.

int sf2::Region::GetModEnvToFilterFc

(

Region *

pPresetRegion = NULL

)

Definition at line 600 of file SF.cpp.

References modEnvToFilterFc.

int sf2::Region::GetModLfoToFilterFc

(

Region *

pPresetRegion = NULL

)

Definition at line 604 of file SF.cpp.

References modLfoToFilterFc.

double sf2::Region::GetModLfoToVolume

(

Region *

pPresetRegion = NULL

)

Definition at line 608 of file SF.cpp.

References modLfoToVolume, and sf2::ToPermilles().

double sf2::Region::GetFreqModLfo

(

Region *

pPresetRegion = NULL

)

Definition at line 612 of file SF.cpp.

References freqModLfo, and sf2::ToHz().

double sf2::Region::GetDelayModLfo

(

Region *

pPresetRegion = NULL

)

Definition at line 617 of file SF.cpp.

References delayModLfo, and sf2::ToSeconds().

int sf2::Region::GetVibLfoToPitch

(

Region *

pPresetRegion = NULL

)

Definition at line 622 of file SF.cpp.

References vibLfoToPitch.

double sf2::Region::GetFreqVibLfo

(

Region *

pPresetRegion = NULL

)

Definition at line 626 of file SF.cpp.

References freqVibLfo, and sf2::ToHz().

double sf2::Region::GetDelayVibLfo

(

Region *

pPresetRegion = NULL

)

Definition at line 631 of file SF.cpp.

References delayVibLfo, and sf2::ToSeconds().

---

Friends And Related Function Documentation

friend class Instrument [friend]

Definition at line 415 of file SF.h.

friend class Preset [friend]

Definition at line 416 of file SF.h.

---

Member Data Documentation

int sf2::Region::loKey

Definition at line 349 of file SF.h.

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

int sf2::Region::hiKey

Definition at line 349 of file SF.h.

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

int sf2::Region::minVel

Definition at line 350 of file SF.h.

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

int sf2::Region::maxVel

Definition at line 350 of file SF.h.

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

int sf2::Region::pan

Definition at line 351 of file SF.h.

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

int sf2::Region::fineTune

Definition at line 352 of file SF.h.

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

int sf2::Region::coarseTune

Definition at line 353 of file SF.h.

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

int sf2::Region::overridingRootKey

Definition at line 354 of file SF.h.

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

int sf2::Region::startAddrsOffset

Definition at line 355 of file SF.h.

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

int sf2::Region::startAddrsCoarseOffset

Definition at line 355 of file SF.h.

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

int sf2::Region::endAddrsOffset

Definition at line 355 of file SF.h.

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

int sf2::Region::endAddrsCoarseOffset

Definition at line 355 of file SF.h.

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

int sf2::Region::startloopAddrsOffset

Definition at line 356 of file SF.h.

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

int sf2::Region::startloopAddrsCoarseOffset

Definition at line 356 of file SF.h.

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

int sf2::Region::endloopAddrsOffset

Definition at line 356 of file SF.h.

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

int sf2::Region::endloopAddrsCoarseOffset

Definition at line 356 of file SF.h.

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

int sf2::Region::modEnvToPitch

Definition at line 358 of file SF.h.

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

int sf2::Region::modLfoToPitch

Definition at line 358 of file SF.h.

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

int sf2::Region::modEnvToFilterFc

Definition at line 358 of file SF.h.

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

int sf2::Region::modLfoToFilterFc

Definition at line 358 of file SF.h.

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

int sf2::Region::modLfoToVolume

Definition at line 358 of file SF.h.

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

int sf2::Region::freqModLfo

Definition at line 358 of file SF.h.

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

int sf2::Region::delayModLfo

Definition at line 359 of file SF.h.

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

int sf2::Region::vibLfoToPitch

Definition at line 360 of file SF.h.

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

int sf2::Region::freqVibLfo

Definition at line 360 of file SF.h.

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

int sf2::Region::delayVibLfo

Definition at line 361 of file SF.h.

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

uint sf2::Region::exclusiveClass

Definition at line 363 of file SF.h.

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

Sample* sf2::Region::pSample

Definition at line 365 of file SF.h.

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

bool sf2::Region::HasLoop

Definition at line 366 of file SF.h.

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

uint sf2::Region::LoopStart

Definition at line 367 of file SF.h.

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

uint sf2::Region::LoopEnd

Definition at line 368 of file SF.h.

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

Instrument* sf2::Region::pInstrument

Definition at line 369 of file SF.h.

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

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

Definition at line 383 of file SF.h.

---

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

• SF.h
• SF.cpp

---