Classes | Public Member Functions | List of all members
Chain Class Referenceabstract

A Processor that has a dynamic size of child processors. More...

Inheritance diagram for Chain:
EffectProcessorChain ModulatorChain ModulatorSynthChain ModulatorSynthGroup

Classes

class  Handler
 Subclass this, put it in your subclassed Chain and return a member object of the chain in Chain::getHandler(). More...
 

Public Member Functions

virtual FactoryTypegetFactoryType () const =0
 Returns the Factory type this processor is using. More...
 
virtual HandlergetHandler ()=0
 return your subclassed Handler. More...
 
virtual const HandlergetHandler () const =0
 read only access to the Handler. More...
 
virtual ProcessorgetParentProcessor ()=0
 Overwrite this and return the processor that owns this chain if it exists. More...
 
virtual const ProcessorgetParentProcessor () const =0
 Overwrite this and return the processor that owns this chain if it exists. More...
 
bool restoreChain (const ValueTree &v)
 Restores a Chain from a ValueTree. More...
 
virtual void setFactoryType (FactoryType *newType)=0
 Sets the FactoryType that will be used. More...
 

Detailed Description

A Processor that has a dynamic size of child processors.

If your Processor has more than a fixed amount of internal child processors, derive it from this class, write a Chain::Handler subclass with all needed operations and you can add / delete Processors on runtime.

You might want to overwrite the Processors functions getNumChildProcessors() and getChildProcessor() with the handlers methods (handle internal chains manually) This allows the restoreState function to only clear the dynamic list of processors.

Member Function Documentation

virtual FactoryType* getFactoryType ( ) const
pure virtual

Returns the Factory type this processor is using.

virtual Handler* getHandler ( )
pure virtual

return your subclassed Handler.

Implemented in ModulatorChain.

virtual const Handler* getHandler ( ) const
pure virtual

read only access to the Handler.

virtual Processor* getParentProcessor ( )
pure virtual

Overwrite this and return the processor that owns this chain if it exists.

virtual const Processor* getParentProcessor ( ) const
pure virtual

Overwrite this and return the processor that owns this chain if it exists.

bool restoreChain ( const ValueTree &  v)

Restores a Chain from a ValueTree.

It creates all processors and restores their values. It returns false, if anything went wrong.

virtual void setFactoryType ( FactoryType newType)
pure virtual

Sets the FactoryType that will be used.

©2017 HISE. This documentation is autogenerated from the HISE source code using Doxygen.