Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   FAQ   Tutorial


Envelope Class Reference

#include <Envelope.h>

Inheritance diagram for Envelope:

Generator Stk ADSR Asymp List of all members.

Detailed Description

STK envelope base class.

This class implements a simple envelope generator which is capable of ramping to a target value by a specified rate. It also responds to simple keyOn and keyOff messages, ramping to 1.0 on keyOn and to 0.0 on keyOff.

by Perry R. Cook and Gary P. Scavone, 1995 - 2007.


Public Member Functions

 Envelope (void)
 Default constructor.
 Envelope (const Envelope &e)
 Copy constructor.
virtual ~Envelope (void)
 Class destructor.
Envelopeoperator= (const Envelope &e)
 Assignment operator.
virtual void keyOn (void)
 Set target = 1.
virtual void keyOff (void)
 Set target = 0.
void setRate (StkFloat rate)
 Set the rate.
void setTime (StkFloat time)
 Set the rate based on a time duration.
virtual void setTarget (StkFloat target)
 Set the target value.
virtual void setValue (StkFloat value)
 Set current and target values to aValue.
virtual int getState (void) const
 Return the current envelope state (0 = at target, 1 otherwise).


The documentation for this class was generated from the following file:
The Synthesis ToolKit in C++ (STK)
©1995-2007 Perry R. Cook and Gary P. Scavone. All Rights Reserved.