engine::BreakpointOscillatorModifier Class Reference

#include <tracktion_BreakpointOscillatorModifier.h>

Inheritance diagram for engine::BreakpointOscillatorModifier:

Classes
struct	Assignment
struct	Stage

Public Types
using	Ptr = juce::ReferenceCountedObjectPtr< BreakpointOscillatorModifier >
using	Array = juce::ReferenceCountedArray< BreakpointOscillatorModifier >
Public Types inherited from engine::Modifier
enum class	ProcessingPosition { none , preFX , postFX }
	Determines the position in the FX chain where the modifier should be processed. More...
using	Ptr = juce::ReferenceCountedObjectPtr< Modifier >
using	Array = juce::ReferenceCountedArray< Modifier >
Public Types inherited from engine::Selectable
using	WeakRef = juce::WeakReference< Selectable >

Public Member Functions
	BreakpointOscillatorModifier (Edit &, const juce::ValueTree &)
	~BreakpointOscillatorModifier () override
void	initialise () override
	Call this once after construction to connect it to the audio graph.
juce::String	getName () const override
float	getCurrentValue () override
	Returns the current value of the modifier.
float	getCurrentEnvelopeValue () const noexcept
	Returns the envelope value before the bipolar and depth have been applied.
float	getCurrentPhase () const noexcept
	Returns the current phase between 0 & 1.
float	getTotalTime () const
	Returns the total time for this envelope.
AutomatableParameter::ModifierAssignment *	createAssignment (const juce::ValueTree &) override
	Must return a new ModifierAssignment for a given state.
ProcessingPosition	getProcessingPosition () override
	Should return the position in the plugin chain that this Modifier should be processed.
void	applyToBuffer (const PluginRenderContext &) override
	Sub classes should implement this to process the Modifier.
juce::String	getSelectableDescription () override
	Subclasses must return a description of what they are.
Stage	getStage (int index) const
virtual void	initialise ()=0
	Call this once after construction to connect it to the audio graph.
virtual void	initialise (double, int)
	Sub classes should implement this to initialise the Modifier.
Public Member Functions inherited from engine::Modifier
	Modifier (Edit &, const juce::ValueTree &)
	Creates a Modifier for a given state.
	~Modifier () override
	Destructor.
void	remove ()
	Removes this Modifier from its parent Track.
virtual juce::StringArray	getMidiInputNames ()
	Can return an array of names represeting MIDI inputs.
virtual juce::StringArray	getAudioInputNames ()
	Can return an array of names represeting audio inputs.
virtual void	deinitialise ()
	Sub classes should implement this to deinitialise the Modifier.
bool	baseClassNeedsInitialising () const noexcept
	Returns true if the Modifier needs initialising.
void	baseClassInitialise (double sampleRate, int blockSizeSamples)
	Initialises the Modifier.
void	baseClassDeinitialise ()
	Deinitialises the Modifier.
void	baseClassApplyToBuffer (const PluginRenderContext &)
	Updates internal value history and calls the subclass's applyToBuffer method.
TimePosition	getCurrentTime () const
	Returns the edit time of the current value.
float	getValueAt (TimeDuration numSecondsBeforeNow) const
	Returns the value of the at a given time in the past.
std::vector< float >	getValues (TimeDuration numSecondsBeforeNow) const
	Returns a vector of previous sample values.
double	getSampleRate () const
	Returns the sample rate the Modifier has been initialised with.
void	selectableAboutToBeDeleted () override
Public Member Functions inherited from engine::AutomatableEditItem
	AutomatableEditItem (Edit &, const juce::ValueTree &)
	~AutomatableEditItem () override
virtual void	flushPluginStateToValueTree ()
virtual void	restorePluginStateFromValueTree (const juce::ValueTree &)
juce::Array< AutomatableParameter * >	getAutomatableParameters () const
int	getNumAutomatableParameters () const
AutomatableParameter::Ptr	getAutomatableParameter (int index) const
AutomatableParameter::Ptr	getAutomatableParameterByID (const juce::String &paramID) const
void	visitAllAutomatableParams (const std::function< void(AutomatableParameter &)> &visit) const
void	deleteParameter (AutomatableParameter *)
void	deleteAutomatableParameters ()
int	indexOfAutomatableParameter (const AutomatableParameter::Ptr &) const
AutomatableParameterTree &	getParameterTree () const
juce::ReferenceCountedArray< AutomatableParameter >	getFlattenedParameterTree () const
void	addParameterListChangeListener (ParameterListChangeListener *)
void	removeParameterListChangeListener (ParameterListChangeListener *)
bool	isAutomationNeeded () const noexcept
void	setAutomatableParamPosition (TimePosition)
bool	isBeingActivelyPlayed () const
virtual void	updateAutomatableParamPosition (TimePosition)
	Updates all the auto params to their positions at this time.
void	updateParameterStreams (TimePosition)
	Updates all the parameter streams to their positions at this time.
void	resetRecordingStatus ()
	Marks the end of an automation recording stream.
void	updateStreamIterators ()
void	addActiveParameter (const AutomatableParameter &)
void	removeActiveParameter (const AutomatableParameter &)
bool	isActiveParameter (AutomatableParameter &)
Public Member Functions inherited from engine::EditItem
	EditItem (EditItemID, Edit &)
	EditItem (Edit &, const juce::ValueTree &)
virtual	~EditItem ()=default
Public Member Functions inherited from engine::Selectable
	Selectable ()
virtual	~Selectable ()
virtual void	selectionStatusChanged (bool isNowSelected)
	Can be overridden to tell this object that it has just been selected or deselected.
virtual void	changed ()
	This should be called to send a change notification to any SelectableListeners that are registered with this object.
void	addListener (SelectableListener *)
void	removeListener (SelectableListener *)
void	addSelectableListener (SelectableListener *)
void	removeSelectableListener (SelectableListener *)
void	cancelAnyPendingUpdates ()
	If changed() has been called, this will cancel any pending async change notificaions.
void	deselect ()
void	propertiesChanged ()
void	notifyListenersOfDeletion ()
WeakRef	getWeakRef ()
Public Member Functions inherited from engine::AutomatableParameter::ModifierSource
	ModifierSource ()=default
virtual	~ModifierSource ()

Public Attributes
juce::CachedValue< float >	numActivePoints
juce::CachedValue< float >	syncType
juce::CachedValue< float >	rate
juce::CachedValue< float >	rateType
juce::CachedValue< float >	depth
juce::CachedValue< float >	bipolar
juce::CachedValue< float >	stageZeroValue
juce::CachedValue< float >	stageOneValue
juce::CachedValue< float >	stageOneTime
juce::CachedValue< float >	stageOneCurve
juce::CachedValue< float >	stageTwoValue
juce::CachedValue< float >	stageTwoTime
juce::CachedValue< float >	stageTwoCurve
juce::CachedValue< float >	stageThreeValue
juce::CachedValue< float >	stageThreeTime
juce::CachedValue< float >	stageThreeCurve
juce::CachedValue< float >	stageFourValue
juce::CachedValue< float >	stageFourTime
juce::CachedValue< float >	stageFourCurve
AutomatableParameter::Ptr	numActivePointsParam
AutomatableParameter::Ptr	syncTypeParam
AutomatableParameter::Ptr	rateParam
AutomatableParameter::Ptr	rateTypeParam
AutomatableParameter::Ptr	depthParam
AutomatableParameter::Ptr	bipolarParam
AutomatableParameter::Ptr	stageZeroValueParam
AutomatableParameter::Ptr	stageOneValueParam
AutomatableParameter::Ptr	stageOneTimeParam
AutomatableParameter::Ptr	stageOneCurveParam
AutomatableParameter::Ptr	stageTwoValueParam
AutomatableParameter::Ptr	stageTwoTimeParam
AutomatableParameter::Ptr	stageTwoCurveParam
AutomatableParameter::Ptr	stageThreeValueParam
AutomatableParameter::Ptr	stageThreeTimeParam
AutomatableParameter::Ptr	stageThreeCurveParam
AutomatableParameter::Ptr	stageFourValueParam
AutomatableParameter::Ptr	stageFourTimeParam
AutomatableParameter::Ptr	stageFourCurveParam
Public Attributes inherited from engine::Modifier
juce::ValueTree	state
	Modifier internal state.
juce::CachedValue< juce::Colour >	colour
	Colour property.
juce::CachedValue< float >	enabled
	Enabled property.
AutomatableParameter::Ptr	enabledParam
	Parameter to change the enabled state.
Public Attributes inherited from engine::AutomatableEditItem
juce::ValueTree	elementState
juce::CachedValue< bool >	remapOnTempoChange
Public Attributes inherited from engine::EditItem
Edit &	edit
const EditItemID	itemID
	Every EditItem has an ID which is unique within the edit.
Public Attributes inherited from engine::Selectable
WeakRef::Master	masterReference

Additional Inherited Members
Static Public Member Functions inherited from engine::Selectable
static void	initialise ()
static bool	isSelectableValid (const Selectable *) noexcept
	checks whether this object has been deleted.
Static Public Attributes inherited from engine::Modifier
static constexpr TimeDuration	maxHistoryTime = TimeDuration::fromSeconds (3.0)
	The max number of seconds of modifier value history that is stored.
Protected Member Functions inherited from engine::Modifier
void	setEditTime (TimePosition newEditTime)
	Subclasses can call this to update the edit time of the current value.
Protected Member Functions inherited from engine::AutomatableEditItem
virtual void	buildParameterTree () const
void	updateLastPlaybackTime ()
void	clearParameterList ()
void	addAutomatableParameter (const AutomatableParameter::Ptr &)
void	rebuildParameterTree ()
void	saveChangedParametersToState ()
	Saves the explicit value of any parameters that have deviated to the state.
void	restoreChangedParametersFromState ()
	Restores the value of any explicitly set parameters.

Member Typedef Documentation

Ptr

using engine::BreakpointOscillatorModifier::Ptr = juce::ReferenceCountedObjectPtr<BreakpointOscillatorModifier>

Array

using engine::BreakpointOscillatorModifier::Array = juce::ReferenceCountedArray<BreakpointOscillatorModifier>

Constructor & Destructor Documentation

BreakpointOscillatorModifier()

engine::BreakpointOscillatorModifier::BreakpointOscillatorModifier	(	Edit &	,
		const juce::ValueTree &
	)

~BreakpointOscillatorModifier()

engine::BreakpointOscillatorModifier::~BreakpointOscillatorModifier ( )

override

Member Function Documentation

initialise() [1/3]

void engine::BreakpointOscillatorModifier::initialise ( )

overridevirtual

Call this once after construction to connect it to the audio graph.

Implements engine::Modifier.

getName()

juce::String engine::BreakpointOscillatorModifier::getName ( ) const

overridevirtual

Implements engine::EditItem.

getCurrentValue()

float engine::BreakpointOscillatorModifier::getCurrentValue ( )

overridevirtual

Returns the current value of the modifier.

Implements engine::Modifier.

getCurrentEnvelopeValue()

float engine::BreakpointOscillatorModifier::getCurrentEnvelopeValue ( ) const

noexcept

Returns the envelope value before the bipolar and depth have been applied.

getCurrentPhase()

float engine::BreakpointOscillatorModifier::getCurrentPhase ( ) const

noexcept

Returns the current phase between 0 & 1.

getTotalTime()

float engine::BreakpointOscillatorModifier::getTotalTime

(

)

const

Returns the total time for this envelope.

createAssignment()

AutomatableParameter::ModifierAssignment * engine::BreakpointOscillatorModifier::createAssignment ( const juce::ValueTree &  )

overridevirtual

Must return a new ModifierAssignment for a given state.

Implements engine::Modifier.

getProcessingPosition()

ProcessingPosition engine::BreakpointOscillatorModifier::getProcessingPosition ( )

overridevirtual

Should return the position in the plugin chain that this Modifier should be processed.

Reimplemented from engine::Modifier.

applyToBuffer()

void engine::BreakpointOscillatorModifier::applyToBuffer ( const PluginRenderContext &  )

overridevirtual

Sub classes should implement this to process the Modifier.

Reimplemented from engine::Modifier.

getSelectableDescription()

juce::String engine::BreakpointOscillatorModifier::getSelectableDescription ( )

overridevirtual

Subclasses must return a description of what they are.

Implements engine::Selectable.

References engine::getName().

getStage()

Stage engine::BreakpointOscillatorModifier::getStage

(

int

index

)

const

initialise() [2/3]

virtual void engine::Modifier::initialise ( )

virtual

Call this once after construction to connect it to the audio graph.

Implements engine::Modifier.

initialise() [3/3]

virtual void engine::Modifier::initialise ( double  , int    )

virtual

Sub classes should implement this to initialise the Modifier.

Reimplemented from engine::Modifier.

Member Data Documentation

numActivePoints

juce::CachedValue<float> engine::BreakpointOscillatorModifier::numActivePoints

syncType

juce::CachedValue<float> engine::BreakpointOscillatorModifier::syncType

rate

juce::CachedValue<float> engine::BreakpointOscillatorModifier::rate

rateType

juce::CachedValue<float> engine::BreakpointOscillatorModifier::rateType

depth

juce::CachedValue<float> engine::BreakpointOscillatorModifier::depth

bipolar

juce::CachedValue<float> engine::BreakpointOscillatorModifier::bipolar

stageZeroValue

juce::CachedValue<float> engine::BreakpointOscillatorModifier::stageZeroValue

stageOneValue

juce::CachedValue<float> engine::BreakpointOscillatorModifier::stageOneValue

stageOneTime

juce::CachedValue<float> engine::BreakpointOscillatorModifier::stageOneTime

stageOneCurve

juce::CachedValue<float> engine::BreakpointOscillatorModifier::stageOneCurve

stageTwoValue

juce::CachedValue<float> engine::BreakpointOscillatorModifier::stageTwoValue

stageTwoTime

juce::CachedValue<float> engine::BreakpointOscillatorModifier::stageTwoTime

stageTwoCurve

juce::CachedValue<float> engine::BreakpointOscillatorModifier::stageTwoCurve

stageThreeValue

juce::CachedValue<float> engine::BreakpointOscillatorModifier::stageThreeValue

stageThreeTime

juce::CachedValue<float> engine::BreakpointOscillatorModifier::stageThreeTime

stageThreeCurve

juce::CachedValue<float> engine::BreakpointOscillatorModifier::stageThreeCurve

stageFourValue

juce::CachedValue<float> engine::BreakpointOscillatorModifier::stageFourValue

stageFourTime

juce::CachedValue<float> engine::BreakpointOscillatorModifier::stageFourTime

stageFourCurve

juce::CachedValue<float> engine::BreakpointOscillatorModifier::stageFourCurve

numActivePointsParam

AutomatableParameter::Ptr engine::BreakpointOscillatorModifier::numActivePointsParam

syncTypeParam

AutomatableParameter::Ptr engine::BreakpointOscillatorModifier::syncTypeParam

rateParam

AutomatableParameter::Ptr engine::BreakpointOscillatorModifier::rateParam

rateTypeParam

AutomatableParameter::Ptr engine::BreakpointOscillatorModifier::rateTypeParam

depthParam

AutomatableParameter::Ptr engine::BreakpointOscillatorModifier::depthParam

bipolarParam

AutomatableParameter::Ptr engine::BreakpointOscillatorModifier::bipolarParam

stageZeroValueParam

AutomatableParameter::Ptr engine::BreakpointOscillatorModifier::stageZeroValueParam

stageOneValueParam

AutomatableParameter::Ptr engine::BreakpointOscillatorModifier::stageOneValueParam

stageOneTimeParam

AutomatableParameter::Ptr engine::BreakpointOscillatorModifier::stageOneTimeParam

stageOneCurveParam

AutomatableParameter::Ptr engine::BreakpointOscillatorModifier::stageOneCurveParam

stageTwoValueParam

AutomatableParameter::Ptr engine::BreakpointOscillatorModifier::stageTwoValueParam

stageTwoTimeParam

AutomatableParameter::Ptr engine::BreakpointOscillatorModifier::stageTwoTimeParam

stageTwoCurveParam

AutomatableParameter::Ptr engine::BreakpointOscillatorModifier::stageTwoCurveParam

stageThreeValueParam

AutomatableParameter::Ptr engine::BreakpointOscillatorModifier::stageThreeValueParam

stageThreeTimeParam

AutomatableParameter::Ptr engine::BreakpointOscillatorModifier::stageThreeTimeParam

stageThreeCurveParam

AutomatableParameter::Ptr engine::BreakpointOscillatorModifier::stageThreeCurveParam

stageFourValueParam

AutomatableParameter::Ptr engine::BreakpointOscillatorModifier::stageFourValueParam

stageFourTimeParam

AutomatableParameter::Ptr engine::BreakpointOscillatorModifier::stageFourTimeParam

stageFourCurveParam

AutomatableParameter::Ptr engine::BreakpointOscillatorModifier::stageFourCurveParam

---

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

• tracktion_BreakpointOscillatorModifier.h