CSL  5.2
csl::Triangle Class Reference

Triangle envelope class – equal attack/release times. More...

#include <Envelope.h>

+ Inheritance diagram for csl::Triangle:

List of all members.

Public Member Functions

 Triangle ()
 Various Constructors.
 Triangle (LineMode mode, float duration, float amplitude)
 Simple constructor.
 Triangle (LineMode mode, float duration, float initialDelay, float amplitude)
 Versions with initial delay segments.
 Triangle (float duration, float amplitude=1.0f)
 Simple constructor.
 Triangle (float duration, float initialDelay, float amplitude)
 Versions with initial delay segments.
 ~Triangle ()
 Minimal version - AR.
virtual bool isActive ()
 This answers whether I'm active (ptr < end)
void addBreakpoint (float startTime, float value)
void setMode (LineMode mode)
virtual void setDuration (float d)
 set/scale durations
virtual void scaleTimes (float s)
 scale durations
virtual void scaleValues (float s)
 scale values so the max is s
virtual void reset ()
 reset internal time to restart envelope
virtual void trigger ()
 reset internal time to restart envelope
virtual void dump ()
 Pretty-printer.
virtual void nextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (CException)
 The main FrameStream work method.
virtual void nextBuffer (Buffer &outputBuffer) throw (CException)
 get a buffer of Frames – this is the core CSL "pull" function; the given buffer can be written into, and a changed() message is sent.
unsigned frameRate ()
void setFrameRate (unsigned rate)
 get/set the receiver's frame rate
virtual unsigned numChannels ()
void setNumChannels (unsigned ch)
 get/set the receiver's number of outputs
BufferCopyPolicy copyPolicy ()
void setCopyPolicy (BufferCopyPolicy ch)
 get/set the receiver's buffer copy policy
virtual bool isFixed ()
 query whether I'm fixed (StaticVariable overrides this)
void addOutput (UnitGenerator *ugen)
 add to or return the UGen vector of outputs
void removeOutput (UnitGenerator *ugen)
UGenVector outputs ()
virtual unsigned numOutputs ()
bool checkFanOut (Buffer &outputBuffer) throw (CException)
 check for fan-out and copy previous buffer; return true if fanning out
void handleFanOut (Buffer &outputBuffer) throw (CException)
virtual void setValue (sample theValue)
 set/get the value (not allowed in the abstract, useful for static values)
virtual sample value ()
void attachObserver (Observer *)
 (possibly notify obersvers on my death)
void detachObserver (Observer *)
void changed (void *argument)
 this is what I send to myself to notify my observers; It's not overridden in general. It results in the observers receiving update() calls < override evaluate to filter updates to the observer map
virtual int evaluate (void *argument)
void setScale (UnitGenerator &scale)
 set the receiver's scale member to a UGen or a float
void setScale (float scale)
void setOffset (UnitGenerator &offset)
 set the receiver's offset member to a UGen or a float
void setOffset (float offset)
void isScaled ()
 answer whether scale = 1 & offset = 0
PortgetPort (CSL_MAP_KEY name)

Protected Member Functions

unsigned int privateNextBuffer (CPoint *breakpoint, LineSegment *segment, float *buffer, unsigned int numFrames)
 Internal helper method for computing the next buffer.
void createSegments ()
 Allocate memory for the segments.
void calculateSegments ()
 Calculate the internal data.
void zeroBuffer (Buffer &outputBuffer, unsigned outBufNum)
 utility method to zero out an outputBuffer
void addInput (CSL_MAP_KEY name, UnitGenerator &ugen)
 Plug in a unit generator to the named input slot.
void addInput (CSL_MAP_KEY name, float value)
 Plug in a float to the named input slot.
void pullInput (Port *thePort, unsigned numFrames) throw (CException)
 method to read the control values (in case they're dynamic). this sends nextBuffer() to the input.
void pullInput (Port *thePort, Buffer &theBuffer) throw (CException)

Protected Attributes

float mDuration
 Total duration, typically in seconds.
float mCurrentMark
 How far we have read.
Breakpoints mSegmentMap
 list of envelope breakpoints
LineSegment ** mSegments
 array of line segments that for the envelope
float * mValues
unsigned mSize
unsigned mFrameRate
 trigger ignored here
unsigned mNumChannels
 my "expected" number of output channels
BufferCopyPolicy mCopyPolicy
 the policy I use if asked for more or fewer channels
UGenVector mOutputs
 the vector of my output UGens
unsigned mNumOutputs
 the number of outputs
BuffermOutputCache
 my past output ring buffer (only used in case of fan-out)
unsigned mSequence
 the highest-seen buffer seq number
PortMap mInputs
 the map of my inputs or controls (used by the mix-in classes)

Detailed Description

Triangle envelope class – equal attack/release times.

Definition at line 227 of file Envelope.h.


Constructor & Destructor Documentation

csl::Triangle::Triangle ( )
inline

Various Constructors.

Definition at line 230 of file Envelope.h.

Triangle::Triangle ( LineMode  mode,
float  duration,
float  amplitude 
)

Simple constructor.

~~~~~ Triangle class ~~~~~

Definition at line 525 of file Envelope.cpp.

Triangle::Triangle ( LineMode  mode,
float  duration,
float  initialDelay,
float  amplitude 
)

Versions with initial delay segments.

Definition at line 530 of file Envelope.cpp.

Triangle::Triangle ( float  duration,
float  amplitude = 1.0f 
)

Simple constructor.

Definition at line 535 of file Envelope.cpp.

Triangle::Triangle ( float  duration,
float  initialDelay,
float  amplitude 
)

Versions with initial delay segments.

Definition at line 540 of file Envelope.cpp.

csl::Triangle::~Triangle ( )
inline

Minimal version - AR.

Definition at line 240 of file Envelope.h.


Member Function Documentation

bool Envelope::isActive ( )
virtualinherited

This answers whether I'm active (ptr < end)

Reimplemented from csl::UnitGenerator.

Reimplemented in csl::RandEnvelope.

Definition at line 211 of file Envelope.cpp.

References csl::Envelope::mCurrentMark, and csl::Envelope::mDuration.

void Envelope::addBreakpoint ( float  startTime,
float  value 
)
inherited
void Envelope::setMode ( LineMode  mode)
inherited

Definition at line 206 of file Envelope.cpp.

References csl::Envelope::mSegments, and csl::Envelope::mSize.

void Envelope::setDuration ( float  d)
virtualinherited

set/scale durations

Scaling operations.

Reimplemented in csl::RandEnvelope, csl::AR, and csl::ADSR.

Definition at line 220 of file Envelope.cpp.

References csl::kLogError, csl::logMsg(), csl::Envelope::mDuration, and csl::Envelope::scaleTimes().

Referenced by csl::FancyFMInstrument::setParameter().

void Envelope::scaleTimes ( float  s)
virtualinherited
void Envelope::reset ( )
virtualinherited

reset internal time to restart envelope

Reset time to 0.0 to restart envelope.

Reimplemented in csl::RandEnvelope.

Definition at line 276 of file Envelope.cpp.

References csl::Envelope::mCurrentMark, csl::Envelope::mSegments, and csl::Envelope::mSize.

Referenced by csl::Envelope::trigger().

void Envelope::dump ( void  )
virtualinherited
void Envelope::nextBuffer ( Buffer outputBuffer,
unsigned  outBufNum 
) throw (CException)
virtualinherited

The main FrameStream work method.

Reimplemented from csl::UnitGenerator.

Reimplemented in csl::RandEnvelope.

Definition at line 292 of file Envelope.cpp.

References DECLARE_SCALABLE_CONTROLS, csl::kLogError, LOAD_SCALABLE_CONTROLS, csl::logMsg(), mFrameRate, and UPDATE_SCALABLE_CONTROLS.

unsigned int csl::Envelope::privateNextBuffer ( CPoint breakpoint,
LineSegment segment,
float *  buffer,
unsigned int  numFrames 
)
protectedinherited

Internal helper method for computing the next buffer.

void Envelope::createSegments ( )
protectedinherited
void csl::UnitGenerator::setFrameRate ( unsigned  rate)
inlineinherited

get/set the receiver's frame rate

Definition at line 226 of file CSL_Core.h.

References csl::UnitGenerator::mFrameRate.

Referenced by m3_header().

void csl::UnitGenerator::setNumChannels ( unsigned  ch)
inlineinherited
BufferCopyPolicy csl::UnitGenerator::copyPolicy ( )
inlineinherited

Definition at line 231 of file CSL_Core.h.

References csl::UnitGenerator::mCopyPolicy.

void csl::UnitGenerator::setCopyPolicy ( BufferCopyPolicy  ch)
inlineinherited
virtual bool csl::UnitGenerator::isFixed ( )
inlinevirtualinherited

query whether I'm fixed (StaticVariable overrides this)

Reimplemented in csl::StaticVariable, and csl::BinaryOp.

Definition at line 247 of file CSL_Core.h.

UGenVector csl::UnitGenerator::outputs ( )
inlineinherited

Definition at line 253 of file CSL_Core.h.

References csl::UnitGenerator::mOutputs.

virtual unsigned csl::UnitGenerator::numOutputs ( )
inlinevirtualinherited

Definition at line 254 of file CSL_Core.h.

References csl::UnitGenerator::mNumOutputs.

bool UnitGenerator::checkFanOut ( Buffer outputBuffer) throw (CException)
inherited

check for fan-out and copy previous buffer; return true if fanning out

Definition at line 549 of file CSL_Core.cpp.

void UnitGenerator::handleFanOut ( Buffer outputBuffer) throw (CException)
inherited

Definition at line 563 of file CSL_Core.cpp.

References csl_max.

virtual void csl::UnitGenerator::setValue ( sample  theValue)
inlinevirtualinherited

set/get the value (not allowed in the abstract, useful for static values)

Reimplemented in csl::DynamicVariable, and csl::StaticVariable.

Definition at line 260 of file CSL_Core.h.

virtual sample csl::UnitGenerator::value ( )
inlinevirtualinherited

Reimplemented in csl::StaticVariable.

Definition at line 261 of file CSL_Core.h.

void UnitGenerator::zeroBuffer ( Buffer outputBuffer,
unsigned  outBufNum 
)
protectedinherited

utility method to zero out an outputBuffer

Definition at line 513 of file CSL_Core.cpp.

References csl::Buffer::mMonoBufferByteSize, and csl::Buffer::monoBuffer().

void Model::attachObserver ( Observer o)
inherited

(possibly notify obersvers on my death)

register/remove observers

Definition at line 491 of file CGestalt.cpp.

References csl::logMsg(), csl::Observer::mKey, and csl::Observer::mPeriod.

Referenced by csl::SpatialPanner::setSpeakerLayout().

void Model::detachObserver ( Observer o)
inherited
void Model::changed ( void *  argument)
inherited

this is what I send to myself to notify my observers; It's not overridden in general. It results in the observers receiving update() calls < override evaluate to filter updates to the observer map

Definition at line 529 of file CGestalt.cpp.

References csl::logMsg().

Referenced by csl::SpeakerLayout::addSpeaker(), csl::MIDIIn::handleIncomingMidiMessage(), and csl::SpeakerLayout::setDefaultSpeakerLayout().

virtual int csl::Model::evaluate ( void *  argument)
inlinevirtualinherited

Reimplemented in csl::MIDIIn.

Definition at line 259 of file CGestalt.h.

void Scalable::setScale ( float  scale)
inherited

Definition at line 894 of file CSL_Core.cpp.

References csl::Controllable::addInput(), CSL_SCALE, and csl::logMsg().

void Scalable::setOffset ( UnitGenerator offset)
inherited

set the receiver's offset member to a UGen or a float

Definition at line 901 of file CSL_Core.cpp.

References csl::Controllable::addInput(), CSL_OFFSET, and csl::logMsg().

void Scalable::setOffset ( float  offset)
inherited

Reimplemented in csl::RandEnvelope.

Definition at line 908 of file CSL_Core.cpp.

References csl::Controllable::addInput(), CSL_OFFSET, and csl::logMsg().

void csl::Scalable::isScaled ( )
inherited

answer whether scale = 1 & offset = 0

Port * Controllable::getPort ( CSL_MAP_KEY  name)
inherited
void Controllable::addInput ( CSL_MAP_KEY  name,
float  value 
)
protectedinherited

Plug in a float to the named input slot.

Definition at line 754 of file CSL_Core.cpp.

References csl::logMsg(), csl::Controllable::mInputs, and csl::Port::mValue.

void Controllable::pullInput ( Port thePort,
unsigned  numFrames 
) throw (CException)
protectedinherited

method to read the control values (in case they're dynamic). this sends nextBuffer() to the input.

Definition at line 695 of file CSL_Core.cpp.

References csl::kSamples, csl::logMsg(), csl::Buffer::mIsPopulated, csl::Buffer::mNumFrames, csl::Buffer::mType, csl::UnitGenerator::nextBuffer(), and csl::Buffer::zeroBuffers().

Referenced by csl::Panner::nextBuffer(), csl::NtoMPanner::nextBuffer(), and csl::Effect::pullInput().

void Controllable::pullInput ( Port thePort,
Buffer theBuffer 
) throw (CException)
protectedinherited

Definition at line 727 of file CSL_Core.cpp.

References csl::UnitGenerator::nextBuffer().


Member Data Documentation

float csl::Envelope::mCurrentMark
protectedinherited
unsigned csl::UnitGenerator::mNumChannels
protectedinherited
BufferCopyPolicy csl::UnitGenerator::mCopyPolicy
protectedinherited

the policy I use if asked for more or fewer channels

Definition at line 269 of file CSL_Core.h.

Referenced by csl::UnitGenerator::copyPolicy(), and csl::UnitGenerator::setCopyPolicy().

UGenVector csl::UnitGenerator::mOutputs
protectedinherited
unsigned csl::UnitGenerator::mNumOutputs
protectedinherited

the number of outputs

Definition at line 271 of file CSL_Core.h.

Referenced by csl::UnitGenerator::addOutput(), csl::UnitGenerator::numOutputs(), and csl::UnitGenerator::removeOutput().

Buffer* csl::UnitGenerator::mOutputCache
protectedinherited

my past output ring buffer (only used in case of fan-out)

Definition at line 272 of file CSL_Core.h.

Referenced by csl::UnitGenerator::addOutput().

unsigned csl::UnitGenerator::mSequence
protectedinherited

the highest-seen buffer seq number

Definition at line 273 of file CSL_Core.h.


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