Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   Tutorial


Effect Class Reference

#include <Effect.h>

Inheritance diagram for Effect:

Stk Chorus Echo JCRev NRev PitShift PRCRev List of all members.

Detailed Description

STK abstract effects parent class.

This class provides common functionality for STK effects subclasses.

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

Definition at line 17 of file Effect.h.

Public Member Functions

 Effect ()
 Class constructor.

virtual ~Effect ()
 Class destructor.

virtual void clear ()=0
 Reset and clear all internal state.

void setEffectMix (StkFloat mix)
 Set the mixture of input and "effected" levels in the output (0.0 = input only, 1.0 = reverb only).

StkFloat lastOut () const
 Return the last output value.

StkFloat lastOutLeft () const
 Return the last left output value.

StkFloat lastOutRight () const
 Return the last right output value.

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

virtual StkFloat * tick (StkFloat *vector, unsigned int vectorSize)
 Take vectorSize inputs, compute the same number of outputs and return them in vector.

virtual StkFramestick (StkFrames &frames, unsigned int channel=1)
 Take a channel of the StkFrames object as inputs to the effect and replace with corresponding outputs.


Member Function Documentation

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

Take a channel of the StkFrames object as inputs to the effect and replace with corresponding 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 Chorus, Echo, JCRev, NRev, PitShift, and PRCRev.


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.