csound::Event Class Reference

#include <Event.hpp>


Detailed Description

Represents an event in music space, such as a note of definite duration, a MIDI-like "note on" or "note off" event, or a MIDI-like control event. Fields have the same semantics as MIDI with some differences. All fields are floats; status is stored separately from channel; channel can have any positive value; spatial location in X, Y, and Z are stored; phase in radians is stored; and pitch-class set is stored.

Events can be multiplied (matrix dot product) with the local coordinate system of a Node or transform to translate, scale, or rotate them in any or all dimensions of music space.

Events usually are value objects, not references.

Silence Events translate to Csound score statements ("i" statements), but they are always real-time score statements at time 0, suitable for use with Csound's -L or line event option.

Public Types

enum  Dimensions {
  TIME = 0, DURATION, STATUS, INSTRUMENT,
  KEY, VELOCITY, PHASE, PAN,
  DEPTH, HEIGHT, PITCHES, HOMOGENEITY,
  ELEMENT_COUNT
}
enum  { INDEFINITE = 16384 }

Public Member Functions

 Event ()
 Event (const Event &a)
 Event (std::string text)
 Event (const ublas::vector< double, ublas::unbounded_array< double > > &a)
 Event (double time, double duration, double status, double instrument, double key, double velocity, double phase, double pan, double depth, double height, double pitches)
 Event (const std::vector< double > &v)
virtual ~Event ()
virtual void initialize ()
virtual bool isMidiEvent () const
virtual bool isNoteOn () const
virtual bool isNoteOff () const
virtual bool isNote () const
virtual bool isMatchingNoteOff (const Event &event) const
virtual bool isMatchingEvent (const Event &event) const
virtual void set (double time, double duration, double status, double instrument, double key, double velocity, double phase=0, double pan=0, double depth=0, double height=0, double pitches=4095)
virtual void setMidi (double time, char status, char key, char velocity)
virtual int getMidiStatus () const
virtual int getStatusNumber () const
virtual double getStatus () const
virtual void setStatus (double status)
virtual int getChannel () const
virtual double getInstrument () const
virtual void setInstrument (double instrument)
virtual double getTime () const
virtual void setTime (double time)
virtual double getDuration () const
virtual void setDuration (double duration)
virtual double getOffTime () const
virtual int getKeyNumber () const
virtual double getKey () const
virtual double getKey (double tonesPerOctave) const
virtual void setKey (double key)
virtual double getFrequency () const
virtual void setFrequency (double frequency)
virtual int getVelocityNumber () const
virtual double getVelocity () const
virtual void setVelocity (double velocity)
virtual double getGain () const
virtual double getPan () const
virtual void setPan (double pan)
virtual double getDepth () const
virtual void setDepth (double depth)
virtual double getHeight () const
virtual void setHeight (double height)
virtual double getPitches () const
virtual void setPitches (double pitches)
virtual double getAmplitude () const
virtual void setAmplitude (double amplitude)
virtual double getPhase () const
virtual void setPhase (double phase)
virtual double getLeftGain () const
virtual double getRightGain () const
virtual void dump (std::ostream &stream)
virtual std::string toString () const
virtual std::string toCsoundIStatement (double tempering=12.0) const
virtual std::string toCsoundIStatementHeld (int tag, double tempering=12.0) const
virtual std::string toCsoundIStatementRelease (int tag, double tempering=12.0) const
virtual void conformToPitchClassSet ()
virtual void temper (double divisionsPerOctave)
virtual std::string getProperty (std::string name)
virtual void setProperty (std::string name, std::string value)
virtual void removeProperty (std::string nameO)
virtual void clearProperties ()
virtual void createNoteOffEvent (Event &event) const
virtual Eventoperator= (const Event &a)
virtual Eventoperator= (const ublas::vector< double > &a)

Data Fields

std::map< std::string,
std::string > 
properties

Static Public Attributes

static int SORT_ORDER []
static const char * labels []


Member Enumeration Documentation

Enumerator:
TIME 
DURATION 
STATUS 
INSTRUMENT 
KEY 
VELOCITY 
PHASE 
PAN 
DEPTH 
HEIGHT 
PITCHES 
HOMOGENEITY 
ELEMENT_COUNT 

anonymous enum

Enumerator:
INDEFINITE 


Constructor & Destructor Documentation

csound::Event::Event (  ) 

csound::Event::Event ( const Event a  ) 

csound::Event::Event ( std::string  text  ) 

csound::Event::Event ( const ublas::vector< double, ublas::unbounded_array< double > > &  a  ) 

csound::Event::Event ( double  time,
double  duration,
double  status,
double  instrument,
double  key,
double  velocity,
double  phase,
double  pan,
double  depth,
double  height,
double  pitches 
)

csound::Event::Event ( const std::vector< double > &  v  ) 

virtual csound::Event::~Event (  )  [virtual]


Member Function Documentation

virtual void csound::Event::initialize (  )  [virtual]

virtual bool csound::Event::isMidiEvent (  )  const [virtual]

virtual bool csound::Event::isNoteOn (  )  const [virtual]

virtual bool csound::Event::isNoteOff (  )  const [virtual]

virtual bool csound::Event::isNote (  )  const [virtual]

virtual bool csound::Event::isMatchingNoteOff ( const Event event  )  const [virtual]

virtual bool csound::Event::isMatchingEvent ( const Event event  )  const [virtual]

virtual void csound::Event::set ( double  time,
double  duration,
double  status,
double  instrument,
double  key,
double  velocity,
double  phase = 0,
double  pan = 0,
double  depth = 0,
double  height = 0,
double  pitches = 4095 
) [virtual]

virtual void csound::Event::setMidi ( double  time,
char  status,
char  key,
char  velocity 
) [virtual]

virtual int csound::Event::getMidiStatus (  )  const [virtual]

virtual int csound::Event::getStatusNumber (  )  const [virtual]

virtual double csound::Event::getStatus (  )  const [virtual]

virtual void csound::Event::setStatus ( double  status  )  [virtual]

virtual int csound::Event::getChannel (  )  const [virtual]

virtual double csound::Event::getInstrument (  )  const [virtual]

virtual void csound::Event::setInstrument ( double  instrument  )  [virtual]

virtual double csound::Event::getTime (  )  const [virtual]

virtual void csound::Event::setTime ( double  time  )  [virtual]

virtual double csound::Event::getDuration (  )  const [virtual]

virtual void csound::Event::setDuration ( double  duration  )  [virtual]

virtual double csound::Event::getOffTime (  )  const [virtual]

virtual int csound::Event::getKeyNumber (  )  const [virtual]

virtual double csound::Event::getKey (  )  const [virtual]

virtual double csound::Event::getKey ( double  tonesPerOctave  )  const [virtual]

virtual void csound::Event::setKey ( double  key  )  [virtual]

virtual double csound::Event::getFrequency (  )  const [virtual]

virtual void csound::Event::setFrequency ( double  frequency  )  [virtual]

virtual int csound::Event::getVelocityNumber (  )  const [virtual]

virtual double csound::Event::getVelocity (  )  const [virtual]

virtual void csound::Event::setVelocity ( double  velocity  )  [virtual]

virtual double csound::Event::getGain (  )  const [virtual]

virtual double csound::Event::getPan (  )  const [virtual]

virtual void csound::Event::setPan ( double  pan  )  [virtual]

virtual double csound::Event::getDepth (  )  const [virtual]

virtual void csound::Event::setDepth ( double  depth  )  [virtual]

virtual double csound::Event::getHeight (  )  const [virtual]

virtual void csound::Event::setHeight ( double  height  )  [virtual]

virtual double csound::Event::getPitches (  )  const [virtual]

virtual void csound::Event::setPitches ( double  pitches  )  [virtual]

virtual double csound::Event::getAmplitude (  )  const [virtual]

virtual void csound::Event::setAmplitude ( double  amplitude  )  [virtual]

virtual double csound::Event::getPhase (  )  const [virtual]

virtual void csound::Event::setPhase ( double  phase  )  [virtual]

virtual double csound::Event::getLeftGain (  )  const [virtual]

virtual double csound::Event::getRightGain (  )  const [virtual]

virtual void csound::Event::dump ( std::ostream &  stream  )  [virtual]

virtual std::string csound::Event::toString (  )  const [virtual]

virtual std::string csound::Event::toCsoundIStatement ( double  tempering = 12.0  )  const [virtual]

virtual std::string csound::Event::toCsoundIStatementHeld ( int  tag,
double  tempering = 12.0 
) const [virtual]

virtual std::string csound::Event::toCsoundIStatementRelease ( int  tag,
double  tempering = 12.0 
) const [virtual]

virtual void csound::Event::conformToPitchClassSet (  )  [virtual]

virtual void csound::Event::temper ( double  divisionsPerOctave  )  [virtual]

virtual std::string csound::Event::getProperty ( std::string  name  )  [virtual]

virtual void csound::Event::setProperty ( std::string  name,
std::string  value 
) [virtual]

virtual void csound::Event::removeProperty ( std::string  nameO  )  [virtual]

virtual void csound::Event::clearProperties (  )  [virtual]

virtual void csound::Event::createNoteOffEvent ( Event event  )  const [virtual]

virtual Event& csound::Event::operator= ( const Event a  )  [virtual]

virtual Event& csound::Event::operator= ( const ublas::vector< double > &  a  )  [virtual]


Field Documentation

std::map<std::string,std::string> csound::Event::properties

int csound::Event::SORT_ORDER[] [static]

const char* csound::Event::labels[] [static]


Generated on Sun Nov 9 00:24:49 2008 for Csound and CsoundAC by  doxygen 1.5.6