Inheritance diagram for tracktion::engine::StepClip:

Classes
struct	Channel

struct	ChannelList

struct	Pattern

struct	PatternInstance

Public Types
enum	Defaults { defaultNumNotes , defaultNumChannels , defaultMidiChannel , defaultNoteNumber , defaultNoteValue , minNumNotes , maxNumNotes , minNumChannels , maxNumChannels }

using	Ptr = juce::ReferenceCountedObjectPtr< StepClip >

using	PatternArray = juce::ReferenceCountedArray< PatternInstance >

Public Types inherited from tracktion::engine::Clip
enum class	FollowActionDurationType { beats , loops }
	Defines the types of duration follow actions can use. More...

enum	SyncType { syncBarsBeats , syncAbsolute }
	Determines the clip sync type. More...

using	Ptr = juce::ReferenceCountedObjectPtr< Clip >

using	Array = juce::ReferenceCountedArray< Clip >

Public Types inherited from tracktion::engine::TrackItem
enum class	Type { unknown , wave , midi , edit , step , marker , pitch , timeSig , collection , video , recording , chord , arranger , container }
	Defines the types of item that can live on Track[s]. More...

Public Types inherited from tracktion::engine::Selectable
using	WeakRef = juce::WeakReference< Selectable >

Public Member Functions
	StepClip (const juce::ValueTree &, EditItemID, ClipOwner &)

void	cloneFrom (Clip *) override
	Clones the given clip to this clip.

const juce::Array< Channel * > &	getChannels () const noexcept

void	removeChannel (int index)

void	insertNewChannel (int index)

bool	usesProbability ()

PatternArray	getPatternSequence () const

void	setPatternSequence (const PatternArray &)

void	insertVariation (int patternIndex, int insertIndex)

void	removeVariation (int variationIndex)

void	removeAllVariations ()

void	createDefaultPatternIfEmpty ()

void	setPatternForVariation (int variationIndex, int newPatternIndex)

int	insertPattern (const Pattern &, int index)

int	insertNewPattern (int index)

void	removePattern (int patternIndex)

void	removeUnusedPatterns ()

bool	getCell (int patternIndex, int channelIndex, int noteIndex)

void	setCell (int patternIndex, int channelIndex, int noteIndex, bool value)

Pattern	getPattern (int index)

int	getNumPatterns () const

juce::Array< Pattern >	getPatterns ()

float	getVolumeDb () const

void	setVolumeDb (float v)

void	generateMidiSequence (juce::MidiMessageSequence &result, bool convertToSeconds=true, PatternInstance *instance=nullptr)
	Generate a MidiMessageSequence from either the entire clip or one of its pattern instances.

juce::MidiMessageSequence	generateMidiSequence (MidiList::TimeBase, PatternInstance *instance=nullptr)
	Generate a MidiMessageSequence from either the entire clip or one of its pattern instances.

juce::Array< BeatPosition >	getBeatTimesOfPatternStarts () const

BeatPosition	getStartBeatOf (PatternInstance *)

BeatPosition	getEndBeatOf (PatternInstance *)

int	getBeatsPerBar ()

void	resizeClipForPatternInstances ()

bool	canBeAddedTo (ClipOwner &) override
	Tests whether this clip can go on the given parent.

juce::String	getSelectableDescription () override
	Subclasses must return a description of what they are.

juce::Colour	getDefaultColour () const override
	Returns the default colour for this clip.

bool	isMidi () const override
	Returns true if this is a MidiClip.

bool	beatBasedLooping () const override
	Returns true if this clip's looping is based on beats or false if absolute time.

bool	isMuted () const override
	Returns true if the clip is muted.

void	setMuted (bool m) override
	Mutes or unmutes the clip.

LiveClipLevel	getLiveClipLevel ()

bool	canLoop () const override
	StepClips can only loop if they're being used as launcher clips.

ClipPosition	getPosition () const override
	Returns the ClipPosition on the parent Track.

bool	isLooping () const override
	Returns true if this clip is currently looping.

void	setNumberOfLoops (int) override
	Sets the clip looping a number of times.

void	disableLooping () override
	Disables all looping.

void	setLoopRange (TimeRange) override
	Sets the loop range the clip should use in seconds.

void	setLoopRangeBeats (BeatRange) override
	Sets the loop range the clip should use in beats.

BeatPosition	getLoopStartBeats () const override
	Returns the beat position of the loop start point.

BeatDuration	getLoopLengthBeats () const override
	Returns the length of loop in beats.

TimePosition	getLoopStart () const override
	Returns the start time of the loop start point.

TimeDuration	getLoopLength () const override
	Returns the length of loop in seconds.

std::shared_ptr< LaunchHandle >	getLaunchHandle () override
	Some clip types can be launched, if that's possible, this returns a handle to trigger starting/stopping the clip.

void	setUsesGlobalLaunchQuatisation (bool useGlobal) override
	Some clip types can be launched, if that's possible, this sets whether the clip's quantisation or the global quantisation should be used.

bool	usesGlobalLaunchQuatisation () override
	Some clip types can be launched, if that's possible, this returns whether the clip's quantisation or the global quantisation should be used.

LaunchQuantisation *	getLaunchQuantisation () override
	Some clip types can be launched, if that's possible, this returns a quantisation that can be used for this clip.

FollowActions *	getFollowActions () override
	Some clip types can be launched, if that's possible, this can be used to determine the action to perform after a clip has played.

Public Member Functions inherited from tracktion::engine::Clip
	Clip (const juce::ValueTree &, ClipOwner &, EditItemID, Type)
	Creates a clip of a given type from a ValueTree state.

	~Clip () override
	Destructor.

virtual void	initialise ()
	Initialises the Clip.

virtual void	flushStateToValueTree ()
	Can be overridden to ensure any state (e.g.

virtual void	sourceMediaChanged ()
	Called when the source media file reference (attribute "source") has changed - i.e.

virtual void	pitchTempoTrackChanged ()
	Called when there are pitch or tempo changes made which might require clips to adjust timing information.

virtual juce::String	getName () const override
	Returns the name of the clip.

void	setName (const juce::String &newName)
	Sets a new name for a clip.

virtual bool	usesSourceFile () const
	True if it references a source file - i.e.

SourceFileReference &	getSourceFileReference ()
	Returns the SourceFileReference of the Clip.

juce::File	getCurrentSourceFile () const
	Returns the current source file, this is different to the SourceFileReference as it could be a temporary comp file, clipFX, reverse render etc.

juce::Array< ReferencedItem >	getReferencedItems () override
	Returns an array of any ReferencedItem[s] e.g.

void	reassignReferencedItem (const ReferencedItem &, ProjectItemID, double) override
	Should be implemented to change the underlying source to a new ProjectItemID.

BeatPosition	getContentBeatAtTime (TimePosition) const
	Returns the beat number (with offset) at the given time.

TimePosition	getTimeOfContentBeat (BeatPosition) const
	Returns time of a beat number.

virtual TimeDuration	getMaximumLength ()
	Returns the maximum length this clip can have.

virtual juce::Array< TimePosition >	getInterestingTimes ()
	Returns times for snapping to, relative to the Edit.

TimePosition	getSpottingPoint () const
	Returns the first marked time in the source file which can be used for syncronising newly added clips.

TimeRange	getLoopRange () const
	Returns the loop range in seconds.

BeatRange	getLoopRangeBeats () const
	Returns the loop range in beats.

virtual void	setSyncType (SyncType sync)
	Sets the sync type for the clip.

SyncType	getSyncType () const
	Returns the sync type clip is using.

void	setPosition (ClipPosition newPosition)
	Sets the position of the clip.

void	setStart (TimePosition newStart, bool preserveSync, bool keepLength)
	Sets the start time of the clip.

void	setLength (TimeDuration newLength, bool preserveSync)
	Sets the length of the clip.

void	setEnd (TimePosition newEnd, bool preserveSync)
	Sets the end of the clip.

void	setOffset (TimeDuration newOffset)
	Sets the offset of the clip, i.e.

void	trimAwayOverlap (TimeRange editRangeToTrim)
	Trims away any part of the clip that overlaps this region.

void	removeFromParent ()
	Removes this clip from the parent track or container clip.

bool	moveTo (ClipOwner &)
	Moves the clip to a new parent (if possible).

double	getSpeedRatio () const noexcept
	Returns the speed ratio i.e.

virtual void	setSpeedRatio (double)
	Sets a speed ratio i.e.

virtual void	rescale (TimePosition pivotTimeInEdit, double factor)
	stretches and scales this clip relative to a fixed point in the edit.

bool	isGrouped () const override
	Returns true if the clip is part of a group.

TrackItem *	getGroupParent () const override
	Returns the parent TrackItem if part of a group.

void	setGroup (EditItemID newGroupID)
	Sets the clip to be part of a group.

EditItemID	getGroupID () const noexcept
	Returns the ID of the group.

CollectionClip *	getGroupClip () const
	Returns this as a CollectionClip if it is one.

bool	isLinked () const
	Returns true if this clip is linked with any others.

void	setLinkGroupID (juce::String newLinkID)
	Sets the link ID to link this clip with others.

juce::String	getLinkGroupID () const
	Returns the link ID of this clip.

ClipOwner *	getParent () const
	Returns the parent ClipOwner this clip is on.

ClipTrack *	getClipTrack () const
	Returns the parent ClipTrack this clip is on (if any).

Track *	getTrack () const override
	Returns the parent Track this clip is on (if any).

ClipSlot *	getClipSlot () const
	Returns the parent ClipSlot this clip is on (if any).

virtual juce::Colour	getColour () const
	Returns the colour property of this clip.

void	setColour (juce::Colour col)
	Sets the colour property of this clip.

virtual void	removePlugin (const Plugin::Ptr &)
	Removes the given plugin from the clip if the clip supports plugins.

virtual bool	addClipPlugin (const Plugin::Ptr &, SelectionManager &)
	Adds a plugin to the clip.

virtual Plugin::Array	getAllPlugins ()
	Returns all the plugins on the clip.

virtual void	sendMirrorUpdateToAllPlugins (Plugin &) const
	Sends an update to all plugins mirroing the one passed in.

virtual PluginList *	getPluginList ()
	Returns the PluginList for this clip if it has one.

virtual void	clearTakes ()
	Clears any takes this clip has.

virtual bool	hasAnyTakes () const
	Returns true if this clip has any takes.

virtual juce::StringArray	getTakeDescriptions () const
	Returns the descriptions of any takes.

virtual void	setCurrentTake (int)
	Sets a given take index to be the current take.

virtual int	getCurrentTake () const
	Returns the current take index.

virtual int	getNumTakes (bool)
	Returns the total number of takes.

virtual bool	isCurrentTakeComp ()
	Returns true if the current take is a comp.

virtual void	setShowingTakes (bool shouldShow)
	Sets whether the clip should be showing takes.

virtual bool	isShowingTakes () const
	Returns true if the clip is showing takes.

virtual Clip::Array	unpackTakes (bool)
	Attempts to unpack the takes to new clips.

void	updateLinkedClips ()
	Triggers a call to cloneFrom for all clips with the same linkID.

virtual PatternGenerator *	getPatternGenerator ()
	Returns the PatternGenerator for this clip if it has one.

void	addListener (Listener *)
	Adds a Listener.

void	removeListener (Listener *)
	Removes a Listener.

juce::ListenerList< Listener > &	getListeners ()
	Returns the listener list so Nodes can manually call them.

void	changed () override
	This should be called to send a change notification to any SelectableListeners that are registered with this object.

juce::UndoManager *	getUndoManager () const
	Returns the UndoManager.

virtual void	setParent (ClipOwner *)

Public Member Functions inherited from tracktion::engine::TrackItem
	TrackItem (Edit &, EditItemID, Type)
	Creates a TrackItem with an ID and type.

	~TrackItem ()
	Destructor.

TimeRange	getEditTimeRange () const
	Returns the time range of this item.

BeatRange	getEditBeatRange () const
	Returns the beat range of this item.

BeatPosition	getStartBeat () const
	Returns the start beat in the Edit of this item.

BeatPosition	getContentStartBeat () const
	Returns the start beat of the content in the Edit of this item.

BeatPosition	getEndBeat () const
	Returns the end beat in the Edit of this item.

BeatDuration	getLengthInBeats () const
	Returns the duration in beats the of this item.

TimePosition	getTimeOfRelativeBeat (BeatDuration) const
	Returns an Edit time point for a given number of beats from the start of this item.

BeatPosition	getBeatOfRelativeTime (TimeDuration) const
	Returns an Edit beat point for a given number of seconds from the start of this item.

BeatDuration	getOffsetInBeats () const
	Returns an the offset of this item in beats.

EditItemID	getTrackID () const
	Returns the ID of the Track this item lives on.

Public Member Functions inherited from tracktion::engine::EditItem
	EditItem (EditItemID, Edit &)

Public Member Functions inherited from tracktion::engine::Selectable
virtual void	selectionStatusChanged (bool isNowSelected)
	Can be overridden to tell this object that it has just been selected or deselected.

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 Member Functions inherited from juce::ReferenceCountedObject
void	incReferenceCount () noexcept

void	decReferenceCount () noexcept

bool	decReferenceCountWithoutDeleting () noexcept

int	getReferenceCount () const noexcept

Public Member Functions inherited from juce::ChangeBroadcaster
void	addChangeListener (ChangeListener *listener)

void	removeChangeListener (ChangeListener *listener)

void	removeAllChangeListeners ()

void	sendChangeMessage ()

void	sendSynchronousChangeMessage ()

void	dispatchPendingMessages ()

Public Attributes
juce::CachedValue< bool >	repeatSequence

Public Attributes inherited from tracktion::engine::Clip
juce::CachedValue< FollowActionDurationType >	followActionDurationType
	The type of duration to use for when to trigger the follow action.

juce::CachedValue< BeatDuration >	followActionBeats
	Determines the time for which a launched clip will play before a follow action is taken.

juce::CachedValue< double >	followActionNumLoops
	Determines the number of loops for which a launched clip will play before a follow action is taken.

juce::ValueTree	state
	The ValueTree of the Clip state.

juce::CachedValue< juce::Colour >	colour
	The colour property.

juce::CachedValue< bool >	disabled
	Whether the Clip is disabled or not.

Public Attributes inherited from tracktion::engine::TrackItem
const Type	type
	The type of this item.

Public Attributes inherited from tracktion::engine::EditItem
Edit &	edit

const EditItemID	itemID
	Every EditItem has an ID which is unique within the edit.

Public Attributes inherited from tracktion::engine::Selectable
WeakRef::Master	masterReference

Additional Inherited Members
Static Public Member Functions inherited from tracktion::engine::Clip
static bool	isClipState (const juce::ValueTree &)
	Checks whether a ValueTree is some kind of clip state.

static bool	isClipState (const juce::Identifier &)
	Checks whether a ValueTree type is some kind of clip state.

static Ptr	createClipForState (const juce::ValueTree &, ClipOwner &targetParent)
	Creates a clip for a given ValueTree representation.

Static Public Member Functions inherited from tracktion::engine::TrackItem
static const char *	typeToString (Type)
	Returns the string version of a TrackItem::Type.

static juce::Identifier	clipTypeToXMLType (Type)
	Returns an Identifier version of a TrackItem::Type.

static TrackItem::Type	xmlTagToType (juce::StringRef)
	Returns the TrackItem::Type of a type string.

static TrackItem::Type	stringToType (const juce::String &)
	Returns the TrackItem::Type of a type string.

static juce::String	getSuggestedNameForNewItem (Type)
	Returns a text string for a new clip of the given type.

template<typename ArrayType >
static void	sortByTime (ArrayType &items)
	Helper function to sort an array of TrackItem[s] by their start time.

template<typename ArrayType >
static void	stableSortByTime (ArrayType &items)
	Helper function to sort an array of TrackItem[s] by their start time without changing the order of items at the same time.

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.

Static Public Member Functions inherited from tracktion::engine::Exportable
static juce::Array< Exportable * >	addAllExportables (Edit &)
	Returns all the Exportables contained in an Edit.

Protected Member Functions inherited from tracktion::engine::Clip
void	setCurrentSourceFile (const juce::File &)
	Sets a new source file for this clip.

virtual juce::Array< TimePosition >	getRescaledMarkPoints () const
	Returns the mark points relative to the start of the clip, rescaled to the current speed.

void	valueTreeParentChanged (juce::ValueTree &) override

Protected Member Functions inherited from juce::ReferenceCountedObject
	ReferenceCountedObject (const ReferenceCountedObject &) noexcept

	ReferenceCountedObject (ReferenceCountedObject &&) noexcept

ReferenceCountedObject &	operator= (const ReferenceCountedObject &) noexcept

ReferenceCountedObject &	operator= (ReferenceCountedObject &&) noexcept

void	resetReferenceCount () noexcept

Protected Member Functions inherited from juce::ValueTree::Listener
virtual void	valueTreeRedirected (ValueTree &treeWhichHasBeenChanged)

Protected Attributes inherited from tracktion::engine::Clip
bool	isInitialised

bool	cloneInProgress

juce::CachedValue< juce::String >	clipName

ClipOwner *	parent

juce::CachedValue< TimePosition >	clipStart

juce::CachedValue< TimeDuration >	length

juce::CachedValue< TimeDuration >	offset

juce::CachedValue< double >	speedRatio

SourceFileReference	sourceFileReference

juce::CachedValue< EditItemID >	groupID

juce::CachedValue< juce::String >	linkID

juce::File	currentSourceFile

juce::CachedValue< SyncType >	syncType

juce::CachedValue< bool >	showingTakes

std::unique_ptr< PatternGenerator >	patternGenerator

AsyncCaller	updateLinkedClipsCaller

juce::ListenerList< Listener >	listeners

Detailed Description

Definition at line 17 of file tracktion_StepClip.h.

Member Typedef Documentation

◆ PatternArray

using tracktion::engine::StepClip::PatternArray = juce::ReferenceCountedArray<PatternInstance>

Definition at line 188 of file tracktion_StepClip.h.

◆ Ptr

using tracktion::engine::StepClip::Ptr = juce::ReferenceCountedObjectPtr<StepClip>

Definition at line 24 of file tracktion_StepClip.h.

Member Enumeration Documentation

◆ Defaults

enum tracktion::engine::StepClip::Defaults

Definition at line 172 of file tracktion_StepClip.h.

Constructor & Destructor Documentation

◆ StepClip()

tracktion::engine::StepClip::StepClip	(	const juce::ValueTree &	v,
		EditItemID	id,
		ClipOwner &	targetParent
	)

Definition at line 52 of file tracktion_StepClip.cpp.

◆ ~StepClip()

tracktion::engine::StepClip::~StepClip ( )

override

Definition at line 102 of file tracktion_StepClip.cpp.

Member Function Documentation

◆ beatBasedLooping()

bool tracktion::engine::StepClip::beatBasedLooping ( ) const

overridevirtual

Returns true if this clip's looping is based on beats or false if absolute time.

Reimplemented from tracktion::engine::Clip.

Definition at line 254 of file tracktion_StepClip.h.

◆ canBeAddedTo()

bool tracktion::engine::StepClip::canBeAddedTo ( ClipOwner & )

overridevirtual

Tests whether this clip can go on the given parent.

Implements tracktion::engine::Clip.

Definition at line 208 of file tracktion_StepClip.cpp.

◆ canLoop()

bool tracktion::engine::StepClip::canLoop ( ) const

overridevirtual

StepClips can only loop if they're being used as launcher clips.

Arranger clips will automatically loop until their end time.

Reimplemented from tracktion::engine::Clip.

Definition at line 731 of file tracktion_StepClip.cpp.

◆ cloneFrom()

void tracktion::engine::StepClip::cloneFrom ( Clip * c )

overridevirtual

Clones the given clip to this clip.

Reimplemented from tracktion::engine::Clip.

Definition at line 108 of file tracktion_StepClip.cpp.

◆ createDefaultPatternIfEmpty()

void tracktion::engine::StepClip::createDefaultPatternIfEmpty ( )

Definition at line 609 of file tracktion_StepClip.cpp.

◆ disableLooping()

void tracktion::engine::StepClip::disableLooping ( )

overridevirtual

Disables all looping.

Reimplemented from tracktion::engine::Clip.

Definition at line 754 of file tracktion_StepClip.cpp.

◆ generateMidiSequence() [1/2]

void tracktion::engine::StepClip::generateMidiSequence	(	juce::MidiMessageSequence &	result,
		bool	convertToSeconds = `true`,
		PatternInstance *	instance = `nullptr`
	)

Generate a MidiMessageSequence from either the entire clip or one of its pattern instances.

Parameters

[out]	result	Result sequence to add the messages to
[in]	convertToSeconds	Leave the timestamps in beats, or convert them to seconds while generating
[in]	instance	Specific pattern to generate, nullptr for the whole clip

Definition at line 410 of file tracktion_StepClip.cpp.

◆ generateMidiSequence() [2/2]

juce::MidiMessageSequence tracktion::engine::StepClip::generateMidiSequence	(	MidiList::TimeBase	timeBase,
		PatternInstance *	instance = `nullptr`
	)

Generate a MidiMessageSequence from either the entire clip or one of its pattern instances.

Parameters

[in]	PatternInstance	Specific pattern to generate, nullptr for the whole clip
[in]	TimeBase	The time base for the sequence

Returns: result Result sequence

Definition at line 452 of file tracktion_StepClip.cpp.

◆ getBeatsPerBar()

int tracktion::engine::StepClip::getBeatsPerBar ( )

Definition at line 304 of file tracktion_StepClip.cpp.

◆ getBeatTimesOfPatternStarts()

juce::Array< BeatPosition > tracktion::engine::StepClip::getBeatTimesOfPatternStarts ( ) const

Definition at line 219 of file tracktion_StepClip.cpp.

◆ getCell()

bool tracktion::engine::StepClip::getCell	(	int	patternIndex,
		int	channelIndex,
		int	noteIndex
	)

Definition at line 706 of file tracktion_StepClip.cpp.

◆ getChannels()

const juce::Array< StepClip::Channel * > & tracktion::engine::StepClip::getChannels ( ) const

noexcept

Definition at line 519 of file tracktion_StepClip.cpp.

◆ getDefaultColour()

juce::Colour tracktion::engine::StepClip::getDefaultColour ( ) const

overridevirtual

Returns the default colour for this clip.

Implements tracktion::engine::Clip.

Definition at line 496 of file tracktion_StepClip.cpp.

◆ getEndBeatOf()

BeatPosition tracktion::engine::StepClip::getEndBeatOf ( PatternInstance * instance )

Definition at line 265 of file tracktion_StepClip.cpp.

◆ getFollowActions()

FollowActions * tracktion::engine::StepClip::getFollowActions ( )

overridevirtual

Some clip types can be launched, if that's possible, this can be used to determine the action to perform after a clip has played.

Reimplemented from tracktion::engine::Clip.

Definition at line 834 of file tracktion_StepClip.cpp.

◆ getLaunchHandle()

std::shared_ptr< LaunchHandle > tracktion::engine::StepClip::getLaunchHandle ( )

overridevirtual

Some clip types can be launched, if that's possible, this returns a handle to trigger starting/stopping the clip.

Reimplemented from tracktion::engine::Clip.

Definition at line 818 of file tracktion_StepClip.cpp.

◆ getLaunchQuantisation()

LaunchQuantisation * tracktion::engine::StepClip::getLaunchQuantisation ( )

overridevirtual

Some clip types can be launched, if that's possible, this returns a quantisation that can be used for this clip.

N.B. This will always be the clip's LaunchQuantisation, to find out if you should use the Edit's LaunchQuantisation, check usesGlobalLaunchQuatisation first

Reimplemented from tracktion::engine::Clip.

Definition at line 826 of file tracktion_StepClip.cpp.

◆ getLiveClipLevel()

LiveClipLevel tracktion::engine::StepClip::getLiveClipLevel ( )

Definition at line 501 of file tracktion_StepClip.cpp.

◆ getLoopLength()

TimeDuration tracktion::engine::StepClip::getLoopLength ( ) const

overridevirtual

Returns the length of loop in seconds.

Reimplemented from tracktion::engine::Clip.

Definition at line 813 of file tracktion_StepClip.cpp.

◆ getLoopLengthBeats()

BeatDuration tracktion::engine::StepClip::getLoopLengthBeats ( ) const

overridevirtual

Returns the length of loop in beats.

Reimplemented from tracktion::engine::Clip.

Definition at line 283 of file tracktion_StepClip.h.

◆ getLoopStart()

TimePosition tracktion::engine::StepClip::getLoopStart ( ) const

overridevirtual

Returns the start time of the loop start point.

Reimplemented from tracktion::engine::Clip.

Definition at line 808 of file tracktion_StepClip.cpp.

◆ getLoopStartBeats()

BeatPosition tracktion::engine::StepClip::getLoopStartBeats ( ) const

overridevirtual

Returns the beat position of the loop start point.

Reimplemented from tracktion::engine::Clip.

Definition at line 281 of file tracktion_StepClip.h.

◆ getPattern()

StepClip::Pattern tracktion::engine::StepClip::getPattern ( int index )

Definition at line 648 of file tracktion_StepClip.cpp.

◆ getPatterns()

juce::Array< StepClip::Pattern > tracktion::engine::StepClip::getPatterns ( )

Definition at line 632 of file tracktion_StepClip.cpp.

◆ getPatternSequence()

StepClip::PatternArray tracktion::engine::StepClip::getPatternSequence ( ) const

Definition at line 572 of file tracktion_StepClip.cpp.

◆ getPosition()

ClipPosition tracktion::engine::StepClip::getPosition ( ) const

overridevirtual

Returns the ClipPosition on the parent Track.

Reimplemented from tracktion::engine::Clip.

Definition at line 725 of file tracktion_StepClip.cpp.

◆ getSelectableDescription()

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

overridevirtual

Subclasses must return a description of what they are.

Implements tracktion::engine::Selectable.

Definition at line 213 of file tracktion_StepClip.cpp.

◆ getStartBeatOf()

BeatPosition tracktion::engine::StepClip::getStartBeatOf ( PatternInstance * instance )

Definition at line 252 of file tracktion_StepClip.cpp.

◆ getVolumeDb()

float tracktion::engine::StepClip::getVolumeDb ( ) const

Definition at line 215 of file tracktion_StepClip.h.

◆ insertNewChannel()

void tracktion::engine::StepClip::insertNewChannel ( int index )

Definition at line 537 of file tracktion_StepClip.cpp.

◆ insertNewPattern()

int tracktion::engine::StepClip::insertNewPattern ( int index )

Definition at line 661 of file tracktion_StepClip.cpp.

◆ insertPattern()

int tracktion::engine::StepClip::insertPattern	(	const Pattern &	p,
		int	index
	)

Definition at line 653 of file tracktion_StepClip.cpp.

◆ insertVariation()

void tracktion::engine::StepClip::insertVariation	(	int	patternIndex,
		int	insertIndex
	)

Definition at line 588 of file tracktion_StepClip.cpp.

◆ isLooping()

bool tracktion::engine::StepClip::isLooping ( ) const

overridevirtual

Returns true if this clip is currently looping.

Reimplemented from tracktion::engine::Clip.

Definition at line 271 of file tracktion_StepClip.h.

◆ isMidi()

bool tracktion::engine::StepClip::isMidi ( ) const

overridevirtual

Returns true if this is a MidiClip.

Implements tracktion::engine::Clip.

Definition at line 253 of file tracktion_StepClip.h.

◆ isMuted()

bool tracktion::engine::StepClip::isMuted ( ) const

overridevirtual

Returns true if the clip is muted.

Implements tracktion::engine::Clip.

Definition at line 255 of file tracktion_StepClip.h.

◆ removeAllVariations()

void tracktion::engine::StepClip::removeAllVariations ( )

Definition at line 604 of file tracktion_StepClip.cpp.

◆ removeChannel()

void tracktion::engine::StepClip::removeChannel ( int index )

Definition at line 560 of file tracktion_StepClip.cpp.

◆ removeUnusedPatterns()

void tracktion::engine::StepClip::removeUnusedPatterns ( )

Definition at line 673 of file tracktion_StepClip.cpp.

◆ removeVariation()

void tracktion::engine::StepClip::removeVariation ( int variationIndex )

Definition at line 595 of file tracktion_StepClip.cpp.

◆ resizeClipForPatternInstances()

void tracktion::engine::StepClip::resizeClipForPatternInstances ( )

Definition at line 278 of file tracktion_StepClip.cpp.

◆ setCell()

void tracktion::engine::StepClip::setCell	(	int	patternIndex,
		int	channelIndex,
		int	noteIndex,
		bool	value
	)

Definition at line 711 of file tracktion_StepClip.cpp.

◆ setLoopRange()

void tracktion::engine::StepClip::setLoopRange ( TimeRange )

overridevirtual

Sets the loop range the clip should use in seconds.

Reimplemented from tracktion::engine::Clip.

Definition at line 793 of file tracktion_StepClip.cpp.

◆ setLoopRangeBeats()

void tracktion::engine::StepClip::setLoopRangeBeats ( BeatRange )

overridevirtual

Sets the loop range the clip should use in beats.

Reimplemented from tracktion::engine::Clip.

Definition at line 771 of file tracktion_StepClip.cpp.

◆ setMuted()

void tracktion::engine::StepClip::setMuted ( bool )

overridevirtual

Mutes or unmutes the clip.

Reimplemented from tracktion::engine::Clip.

Definition at line 256 of file tracktion_StepClip.h.

◆ setNumberOfLoops()

void tracktion::engine::StepClip::setNumberOfLoops ( int )

overridevirtual

Sets the clip looping a number of times.

Reimplemented from tracktion::engine::Clip.

Definition at line 736 of file tracktion_StepClip.cpp.

◆ setPatternForVariation()

void tracktion::engine::StepClip::setPatternForVariation	(	int	variationIndex,
		int	newPatternIndex
	)

Definition at line 621 of file tracktion_StepClip.cpp.

◆ setPatternSequence()

void tracktion::engine::StepClip::setPatternSequence ( const PatternArray & newSequence )

Definition at line 577 of file tracktion_StepClip.cpp.

◆ setUsesGlobalLaunchQuatisation()

void tracktion::engine::StepClip::setUsesGlobalLaunchQuatisation ( bool )

overridevirtual

Some clip types can be launched, if that's possible, this sets whether the clip's quantisation or the global quantisation should be used.

See also: getLaunchQuantisation, Edit::getLaunchQuantisation

Reimplemented from tracktion::engine::Clip.

Definition at line 292 of file tracktion_StepClip.h.

◆ setVolumeDb()

void tracktion::engine::StepClip::setVolumeDb ( float v )

Definition at line 216 of file tracktion_StepClip.h.

◆ usesGlobalLaunchQuatisation()

bool tracktion::engine::StepClip::usesGlobalLaunchQuatisation ( )

overridevirtual

Some clip types can be launched, if that's possible, this returns whether the clip's quantisation or the global quantisation should be used.

See also: getLaunchQuantisation, Edit::getLaunchQuantisation

Reimplemented from tracktion::engine::Clip.

Definition at line 294 of file tracktion_StepClip.h.

◆ usesProbability()

bool tracktion::engine::StepClip::usesProbability ( )

Definition at line 524 of file tracktion_StepClip.cpp.

Member Data Documentation

◆ repeatSequence

juce::CachedValue<bool> tracktion::engine::StepClip::repeatSequence

Definition at line 260 of file tracktion_StepClip.h.

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

tracktion_engine/model/clips/tracktion_StepClip.h
tracktion_engine/model/clips/tracktion_StepClip.cpp

Classes

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PatternArray

◆ Ptr

Member Enumeration Documentation

◆ Defaults

Constructor & Destructor Documentation

◆ StepClip()

◆ ~StepClip()

Member Function Documentation

◆ beatBasedLooping()

◆ canBeAddedTo()

◆ canLoop()

◆ cloneFrom()

◆ createDefaultPatternIfEmpty()

◆ disableLooping()

◆ generateMidiSequence() [1/2]

◆ generateMidiSequence() [2/2]

◆ getBeatsPerBar()

◆ getBeatTimesOfPatternStarts()

◆ getCell()

◆ getChannels()

◆ getDefaultColour()

◆ getEndBeatOf()

◆ getFollowActions()

◆ getLaunchHandle()

◆ getLaunchQuantisation()

◆ getLiveClipLevel()

◆ getLoopLength()

◆ getLoopLengthBeats()

◆ getLoopStart()

◆ getLoopStartBeats()

◆ getPattern()

◆ getPatterns()

◆ getPatternSequence()

◆ getPosition()

◆ getSelectableDescription()

◆ getStartBeatOf()

◆ getVolumeDb()

◆ insertNewChannel()

◆ insertNewPattern()

◆ insertPattern()

◆ insertVariation()

◆ isLooping()

◆ isMidi()

◆ isMuted()

◆ removeAllVariations()

◆ removeChannel()

◆ removeUnusedPatterns()

◆ removeVariation()

◆ resizeClipForPatternInstances()

◆ setCell()

◆ setLoopRange()

◆ setLoopRangeBeats()

◆ setMuted()

◆ setNumberOfLoops()

◆ setPatternForVariation()

◆ setPatternSequence()

◆ setUsesGlobalLaunchQuatisation()

◆ setVolumeDb()

◆ usesGlobalLaunchQuatisation()

◆ usesProbability()

Member Data Documentation

◆ repeatSequence