ofxPDSP
pdsp::ClockedLFO Class Reference

LFO clocked to global tempo and synchronized to transport. More...

#include <ClockedLFO.h>

Inheritance diagram for pdsp::ClockedLFO:
pdsp::Patchable

Public Member Functions

 ClockedLFO (const ClockedLFO &Other)
 
ClockedLFOoperator= (const ClockedLFO &Other)
 
Patchableset (float division, float phaseOffset)
 sets the default time division and phase offset values and returns the module ready to be patched. More...
 
Patchablein_division ()
 Sets "division" as selected input and returns this module ready to be patched. This is the default input. This is the time division, higher is faster, for example 16.0f means 1/16th and 0.5f means two bars/cycle. It is updated only at control-rate.
 
Patchablein_retrig ()
 Sets "retrig" as selected input and returns this module ready to be patched. Connect a "trig" output to this input to activate manual retriggering of the phasor, otherwise the phasor is synced to the transport.
 
Patchablein_phase_offset ()
 Sets "phase_offset" as selected input and returns this module ready to be patched. This is the offset of the phasor at retrigger or in relation to the given division. It is updated only at control-rate.
 
Patchableout_triangle ()
 Sets "triangle" as selected output and returns this module ready to be patched. This is the default output. This is the triangle waveform output.
 
Patchableout_sine ()
 Sets "sine" as selected output and returns this module ready to be patched. This is the sine waveform output.
 
Patchableout_saw ()
 Sets "sine" as selected output and returns this module ready to be patched. This is the saw waveform output (rising saw).
 
Patchableout_square ()
 Sets "square" as selected output and returns this module ready to be patched. This is the square waveform output.
 
Patchableout_sample_and_hold ()
 Sets "sample_and_hold" as selected output and returns this module ready to be patched. This is the sample & hold waveform output.
 
- Public Member Functions inherited from pdsp::Patchable
void resetInputToDefault ()
 resets the selected input to the default.
 
void resetOutputToDefault ()
 resets the selected output to the default.
 
Patchablein (const char *tag)
 sets the selected input to the one tagged with "tag", if tag is a valid string, and returns this Patchable ready to be patched. More...
 
Patchableout (const char *tag)
 sets the selected output to the one tagged with "tag", if tag is a valid string, and returns this Patchable ready to be patched. More...
 
void disconnectIn ()
 disconnects all the outputs connected to the selected input, then resets the selected input to the default.
 
void disconnectOut ()
 disconnects all the inputs connected to the selected output, then resets the selected output to the default.
 
void disconnectAll ()
 disconnects all the inputs and outputs to their connected outputs and inputs. Also resets the selected input and output to the default.
 
InputNodegetSelectedInput ()
 returns the selected input, you can patch a Patchable or OutputNode to it with the >> operator.
 
OutputNodegetSelectedOutput ()
 returns the selected output, you can patch it to another Patchable or InputNode with the >> operator.
 
std::vector< std::string > getInputsList ()
 returns a vector of the valid input tags
 
std::vector< std::string > getOutputsList ()
 returns a vector of the valid input tags
 

Additional Inherited Members

- Protected Member Functions inherited from pdsp::Patchable
void addOutput (const char *tag, OutputNode &output)
 method to add outputs when constructing a Unit More...
 
void addInput (const char *tag, InputNode &input)
 method to add inputs when constructing a Unit More...
 
void addModuleOutput (const char *tag, Patchable &unit)
 method to add outputs when constructing a module More...
 
void addModuleInput (const char *tag, Patchable &unit)
 method to add outputs when constructing a module More...
 

Detailed Description

LFO clocked to global tempo and synchronized to transport.

Member Function Documentation

◆ set()

pdsp::Patchable & pdsp::ClockedLFO::set ( float  division,
float  phaseOffset 
)

sets the default time division and phase offset values and returns the module ready to be patched.

Parameters
[in]divisiondivision time, for example 4.0f is one quarter/cycle and 0.25f means 4 bars/cycle
[in]phaseOffsetphase offset at retrigger or in relation to the given division

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