tracktion::engine::StepVolumeEffect Struct Reference

#include <tracktion_ClipEffects.h>

Inheritance diagram for tracktion::engine::StepVolumeEffect:

Classes
struct	Pattern

Public Member Functions
	StepVolumeEffect (const juce::ValueTree &, ClipEffects &)
	~StepVolumeEffect () override
int	getMaxNumNotes ()
juce::ReferenceCountedObjectPtr< ClipEffectRenderJob >	createRenderJob (const AudioFile &sourceFile, TimeDuration sourceLength) override
	Subclasses should return a job that can render the source.
bool	hasProperties () override
	Return true here to show a properties button in the editor and enable the propertiesButtonPressed callback.
void	propertiesButtonPressed (SelectionManager &) override
juce::String	getSelectableDescription () override
	Subclasses must return a description of what they are.
Public Member Functions inherited from tracktion::engine::ClipEffect
virtual void	initialise ()
	ClipEffect (const juce::ValueTree &, ClipEffects &)
EffectType	getType () const
virtual void	sourceChanged ()
	Callback to indicate the destination file has changed.
HashCode	getHash () const
	Returns the hash for this effect.
AudioFile	getSourceFile () const
AudioFile	getDestinationFile () const
bool	isUsingFile (const AudioFile &) const
virtual void	flushStateToValueTree ()
juce::UndoManager &	getUndoManager ()
AudioClipBase &	getClip ()
Public Member Functions inherited from tracktion::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.
virtual void	selectableAboutToBeDeleted ()
	Called just before the selectable is about to be deleted so any subclasses should still be valid at this point.
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 Attributes
juce::CachedValue< BeatDuration >	noteLength
juce::CachedValue< double >	crossfade
juce::CachedValue< juce::String >	pattern
Public Attributes inherited from tracktion::engine::ClipEffect
Edit &	edit
juce::ValueTree	state
ClipEffects &	clipEffects
Public Attributes inherited from tracktion::engine::Selectable
WeakRef::Master	masterReference

Protected Member Functions
HashCode	getIndividualHash () const override
Protected Member Functions inherited from tracktion::engine::ClipEffect
void	valueTreeChanged () override
Protected Member Functions inherited from tracktion::engine::ValueTreeAllEventListener
void	valueTreePropertyChanged (juce::ValueTree &, const juce::Identifier &) override
void	valueTreeChildAdded (juce::ValueTree &, juce::ValueTree &) override
void	valueTreeChildRemoved (juce::ValueTree &, juce::ValueTree &, int) override
void	valueTreeChildOrderChanged (juce::ValueTree &, int, int) override
void	valueTreeParentChanged (juce::ValueTree &) override
void	valueTreeRedirected (juce::ValueTree &) override

Additional Inherited Members
Public Types inherited from tracktion::engine::ClipEffect
enum class	EffectType {   none , volume , fadeInOut , tapeStartStop ,   stepVolume , pitchShift , warpTime , normalise ,   makeMono , reverse , invert , filter ,   firstEffect = volume , lastEffect = filter }
Public Types inherited from tracktion::engine::Selectable
using	WeakRef = juce::WeakReference< Selectable >
Static Public Member Functions inherited from tracktion::engine::ClipEffect
static juce::ValueTree	create (EffectType)
static ClipEffect *	create (const juce::ValueTree &, ClipEffects &)
static void	createEffectAndAddToValueTree (Edit &, juce::ValueTree parent, ClipEffect::EffectType, int index)
static juce::String	getTypeDisplayName (EffectType)
static void	addEffectsToMenu (juce::PopupMenu &)
Static Public Member Functions inherited from tracktion::engine::Selectable
static void	initialise ()
static bool	isSelectableValid (const Selectable *) noexcept
	checks whether this object has been deleted.

Constructor & Destructor Documentation

StepVolumeEffect()

tracktion::engine::StepVolumeEffect::StepVolumeEffect	(	const juce::ValueTree &	,
		ClipEffects &
	)

~StepVolumeEffect()

tracktion::engine::StepVolumeEffect::~StepVolumeEffect ( )

override

Member Function Documentation

getMaxNumNotes()

int tracktion::engine::StepVolumeEffect::getMaxNumNotes

(

)

createRenderJob()

juce::ReferenceCountedObjectPtr< ClipEffectRenderJob > tracktion::engine::StepVolumeEffect::createRenderJob ( const AudioFile &  sourceFile, TimeDuration  sourceLength  )

overridevirtual

Subclasses should return a job that can render the source.

N.B. because the sourceFile may not be valid at the time of job creation you should use the sourceLength parameter to determine how to build the render node.

Implements tracktion::engine::ClipEffect.

hasProperties()

bool tracktion::engine::StepVolumeEffect::hasProperties ( )

overridevirtual

Return true here to show a properties button in the editor and enable the propertiesButtonPressed callback.

Reimplemented from tracktion::engine::ClipEffect.

propertiesButtonPressed()

void tracktion::engine::StepVolumeEffect::propertiesButtonPressed ( SelectionManager &  )

overridevirtual

Reimplemented from tracktion::engine::ClipEffect.

getSelectableDescription()

juce::String tracktion::engine::StepVolumeEffect::getSelectableDescription ( )

overridevirtual

Subclasses must return a description of what they are.

Implements tracktion::engine::Selectable.

getIndividualHash()

HashCode tracktion::engine::StepVolumeEffect::getIndividualHash ( ) const

overrideprotectedvirtual

Reimplemented from tracktion::engine::ClipEffect.

Member Data Documentation

noteLength

juce::CachedValue<BeatDuration> tracktion::engine::StepVolumeEffect::noteLength

crossfade

juce::CachedValue<double> tracktion::engine::StepVolumeEffect::crossfade

pattern

juce::CachedValue<juce::String> tracktion::engine::StepVolumeEffect::pattern

---

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

• tracktion_ClipEffects.h