logo
Main Page | Namespaces | Classes | Compounds | Files | Compound Members | Related

SynthCore::Envelope3 Class Reference

Envelope3 is a generic envelope module. More...

#include <envelope.h>

Inheritance diagram for SynthCore::Envelope3:

SynthCore::Module List of all members.

Public Methods

virtual std::string getName ()
 This is the name of the unit.

void setDuration (int calls)
 Sets the duration of the envelope measured in CALLS to the update function.

virtual ModulesharedClone ()
 Envelope3 (SynthVoice *s)
 Constructor.

 ~Envelope3 ()
 Destructor;.

void update ()
 Actual Code takes place here;.

void loadXML (XMLNode *n, bool firstPass)
 Reads parameters from XML document (use the parser in the Utils namespace).

std::string getXML (int indent)

Static Public Methods

ModulenewInstance (SynthVoice *s)
 Static constructor (for 'factory' use).


Public Attributes

bool killVoice
EnvDatamyData
 The actual envelope.

OutputOutput1
 Mono Output.

InputInput1
 Mono Input.


Detailed Description

Envelope3 is a generic envelope module.

The envelope can be arbitrarily complex.

If the input is connected, the output will be: Output = Input * envelope otherwise it will be, Output = envelope.

Todo:
check the two modes.

Definition at line 129 of file envelope.h.


Member Function Documentation

std::string SynthCore::Envelope3::getXML int    indent [virtual]
 

Return XML representation of parameters. Used for serializing modules.

Reimplemented from SynthCore::Module.

Definition at line 55 of file envelope.cpp.

References SynthCore::Input::getXML(), SynthCore::Output::getXML(), SynthCore::EnvData::getXML(), Input1, Utils::intToString(), killVoice, myData, Utils::newline(), Output1, and Utils::space().

Module * SynthCore::Envelope3::sharedClone   [virtual]
 

Creates a copy of the Module. If any ressources can be shared across a voice the method should utilize it.

Reimplemented from SynthCore::Module.

Definition at line 31 of file envelope.cpp.

References Envelope3(), SynthCore::Module::firstVoice, SynthCore::Module::hostVoice, killVoice, SynthCore::Module::ModID, and myData.


Member Data Documentation

bool SynthCore::Envelope3::killVoice
 

Set this to true, if you want the Envelope to kill the current voice, when the end of the envelope is reached. Notice that at least one envelope must kill the voice in order not to use excessive CPU power.

Definition at line 138 of file envelope.h.

Referenced by Envelope3(), getXML(), loadXML(), sharedClone(), and SynthCore::SynthVoice::SynthVoice().


The documentation for this class was generated from the following files:
Syntopia Project. Visit the web page, or the SourceForge page.
Docs made by Doxygen. Email: Mikael Christensen