Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   Tutorial


Generator Class Reference

#include <Generator.h>

Inheritance diagram for Generator:

Stk Envelope Modulate Noise SingWave ADSR Asymp SubNoise List of all members.

Detailed Description

STK abstract unit generator parent class.

This class provides common functionality for STK unit generator source subclasses.

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

Definition at line 17 of file Generator.h.

Public Member Functions

 Generator ()
 Class constructor.

virtual ~Generator ()
 Class destructor.

virtual StkFloat lastOut () const
 Return the last output value.

virtual StkFloat tick (void)=0
 Abstract tick function ... must be implemented in subclasses.

virtual StkFloat * tick (StkFloat *vector, unsigned int vectorSize)
 Compute vectorSize outputs and return them in vector.

virtual StkFramestick (StkFrames &frames, unsigned int channel=1)
 Fill a channel of the StkFrames object with computed outputs.


Member Function Documentation

virtual StkFrames& Generator::tick StkFrames frames,
unsigned int  channel = 1
[virtual]
 

Fill a channel of the StkFrames object with computed outputs.

The channel argument should be one or greater (the first channel is specified by 1). An StkError will be thrown if the channel argument is zero or it is greater than the number of channels in the StkFrames object.

Reimplemented in ADSR, Asymp, Envelope, Modulate, Noise, SingWave, and SubNoise.


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