ModulatorSynthGroup::ChildSynthIterator Class Reference

Iterates over all child synths. More...

Public Types
enum	Mode
	This can be set to iterate either all synths or only the allowed ones. More...

Public Member Functions
	ChildSynthIterator (ModulatorSynthGroup *groupToBeIterated, Mode iteratorMode=SkipUnallowedSynths)
	Creates a new ChildSynthIterator. More...
bool	getNextAllowedChild (ModulatorSynth *&child)
	sets the passed pointer to the next ModulatorSynth in the chain that is allowed and returns false if the end of the chain is reached or if the child is a nullpointer

Detailed Description

Iterates over all child synths.

Example usage:

ModulatorSynth *child;
ChildSynthIterator childIterator(this);

while(childIterator.getNextAllowedChild(child))
{
    // Do something here
}

Member Enumeration Documentation

enum Mode

This can be set to iterate either all synths or only the allowed ones.

Constructor & Destructor Documentation

ChildSynthIterator	(	ModulatorSynthGroup *	groupToBeIterated,
		Mode	iteratorMode = SkipUnallowedSynths
	)

Creates a new ChildSynthIterator.

It is okay to create one on the stack. You have to pass a pointer to the ModulatorSynthGroup that should be iterated.