Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   Tutorial


Plucked Class Reference

#include <Plucked.h>

Inheritance diagram for Plucked:

Instrmnt Stk List of all members.

Detailed Description

STK plucked string model class.

This class implements a simple plucked string physical model based on the Karplus-Strong algorithm.

This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others. There exist at least two patents, assigned to Stanford, bearing the names of Karplus and/or Strong.

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

Definition at line 29 of file Plucked.h.

Public Member Functions

 Plucked (StkFloat lowestFrequency)
 Class constructor, taking the lowest desired playing frequency.

 ~Plucked ()
 Class destructor.

void clear ()
 Reset and clear all internal state.

virtual void setFrequency (StkFloat frequency)
 Set instrument parameters for a particular frequency.

void pluck (StkFloat amplitude)
 Pluck the string with the given amplitude using the current frequency.

virtual void noteOn (StkFloat frequency, StkFloat amplitude)
 Start a note with the given frequency and amplitude.

virtual void noteOff (StkFloat amplitude)
 Stop a note with the given amplitude (speed of decay).

virtual StkFloat tick ()
 Compute one output sample.

virtual StkFloat * tick (StkFloat *vector, unsigned int vectorSize)
 Computer 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& Plucked::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 from Instrmnt.


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.