Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   FAQ   Tutorial

stk::Mesh2D Class Reference

Two-dimensional rectilinear waveguide mesh class. More...

#include <Mesh2D.h>

Inheritance diagram for stk::Mesh2D:
stk::Instrmnt stk::Stk

List of all members.

Public Member Functions

 Mesh2D (unsigned short nX, unsigned short nY)
 Class constructor, taking the x and y dimensions in samples.
 ~Mesh2D (void)
 Class destructor.
void clear (void)
 Reset and clear all internal state.
void setNX (unsigned short lenX)
 Set the x dimension size in samples.
void setNY (unsigned short lenY)
 Set the y dimension size in samples.
void setInputPosition (StkFloat xFactor, StkFloat yFactor)
 Set the x, y input position on a 0.0 - 1.0 scale.
void setDecay (StkFloat decayFactor)
 Set the loss filters gains (0.0 - 1.0).
void noteOn (StkFloat frequency, StkFloat amplitude)
 Impulse the mesh with the given amplitude (frequency ignored).
void noteOff (StkFloat amplitude)
 Stop a note with the given amplitude (speed of decay) ... currently ignored.
StkFloat energy (void)
 Calculate and return the signal energy stored in the mesh.
StkFloat inputTick (StkFloat input)
 Input a sample to the mesh and compute one output sample.
void controlChange (int number, StkFloat value)
 Perform the control change specified by number and value (0.0 - 128.0).
StkFloat tick (unsigned int channel=0)
 Compute and return one output sample.
StkFramestick (StkFrames &frames, unsigned int channel=0)
 Fill a channel of the StkFrames object with computed outputs.

Detailed Description

Two-dimensional rectilinear waveguide mesh class.

This class implements a rectilinear, two-dimensional digital waveguide mesh structure. For details, see Van Duyne and Smith, "Physical Modeling with the 2-D Digital Waveguide Mesh", Proceedings of the 1993 International Computer Music Conference.

This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.

Control Change Numbers:

by Julius Smith, 2000 - 2002. Revised by Gary Scavone for STK, 2002.

Member Function Documentation

StkFrames & stk::Mesh2D::tick ( StkFrames frames,
unsigned int  channel = 0 
) [inline, virtual]

Fill a channel of the StkFrames object with computed outputs.

The channel argument must be less than the number of channels in the StkFrames argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an StkError exception.

Implements stk::Instrmnt.

00116 {
00117   unsigned int nChannels = lastFrame_.channels();
00118 #if defined(_STK_DEBUG_)
00119   if ( channel > frames.channels() - nChannels ) {
00120     oStream_ << "Mesh2D::tick(): channel and StkFrames arguments are incompatible!";
00121     handleError( StkError::FUNCTION_ARGUMENT );
00122   }
00123 #endif
00125   StkFloat *samples = &frames[channel];
00126   unsigned int j, hop = frames.channels() - nChannels;
00127   if ( nChannels == 1 ) {
00128     for ( unsigned int i=0; i<frames.frames(); i++, samples += hop )
00129       *samples++ = tick();
00130   }
00131   else {
00132     for ( unsigned int i=0; i<frames.frames(); i++, samples += hop ) {
00133       *samples++ = tick();
00134       for ( j=1; j<nChannels; j++ )
00135         *samples++ = lastFrame_[j];
00136     }
00137   }
00139   return frames;
00140 }

The documentation for this class was generated from the following file:

The Synthesis ToolKit in C++ (STK)
©1995-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.