tracktion::engine::ClipOwner Class Reference

Base class for items that can contain clips. More...

#include <tracktion_ClipOwner.h>

Inheritance diagram for tracktion::engine::ClipOwner:

Public Member Functions
	ClipOwner ()
	Constructs an empty ClipOwner.
virtual	~ClipOwner ()
	Destructor.
virtual juce::ValueTree &	getClipOwnerState ()=0
	Must return the state of this ClipOwner.
virtual EditItemID	getClipOwnerID ()=0
	Must return the ID of this ClipOwner.
virtual Selectable *	getClipOwnerSelectable ()=0
	Must return the selectable if this ClipOwner is one.
virtual Edit &	getClipOwnerEdit ()=0
	Must return the Edit this ClipOwner belongs to.
const juce::Array< Clip * > &	getClips () const
	Returns the clips this owner contains.

Protected Member Functions
void	initialiseClipOwner (Edit &, juce::ValueTree clipParentState)
	Must be called once from the subclass constructor to init the clip owner.
virtual void	clipCreated (Clip &)=0
	Called when a clip is created which could be during Edit load.
virtual void	clipAddedOrRemoved ()=0
	Called when a clip is added or removed.
virtual void	clipOrderChanged ()=0
	Called when clips have moved times so that their order has changed.
virtual void	clipPositionChanged ()=0
	Called when a clip start or end position has changed.

Detailed Description

Base class for items that can contain clips.

See also

ClipTrack, ContainerClip

Constructor & Destructor Documentation

ClipOwner()

tracktion::engine::ClipOwner::ClipOwner

(

)

Constructs an empty ClipOwner.

Call initialiseClipOwner in the subclass constructor to initialise it.

~ClipOwner()

virtual tracktion::engine::ClipOwner::~ClipOwner ( )

virtual

Destructor.

Member Function Documentation

getClipOwnerState()

virtual juce::ValueTree & tracktion::engine::ClipOwner::getClipOwnerState ( )

pure virtual

Must return the state of this ClipOwner.

Implemented in tracktion::engine::ContainerClip, tracktion::engine::ClipSlot, and tracktion::engine::ClipTrack.

getClipOwnerID()

virtual EditItemID tracktion::engine::ClipOwner::getClipOwnerID ( )

pure virtual

Must return the ID of this ClipOwner.

Implemented in tracktion::engine::ContainerClip, tracktion::engine::ClipSlot, and tracktion::engine::ClipTrack.

getClipOwnerSelectable()

virtual Selectable * tracktion::engine::ClipOwner::getClipOwnerSelectable ( )

pure virtual

Must return the selectable if this ClipOwner is one.

Implemented in tracktion::engine::ContainerClip, tracktion::engine::ClipSlot, and tracktion::engine::ClipTrack.

getClipOwnerEdit()

virtual Edit & tracktion::engine::ClipOwner::getClipOwnerEdit ( )

pure virtual

Must return the Edit this ClipOwner belongs to.

Implemented in tracktion::engine::ContainerClip, tracktion::engine::ClipSlot, and tracktion::engine::ClipTrack.

getClips()

const juce::Array< Clip * > & tracktion::engine::ClipOwner::getClips

(

)

const

Returns the clips this owner contains.

initialiseClipOwner()

void tracktion::engine::ClipOwner::initialiseClipOwner ( Edit &  , juce::ValueTree  clipParentState  )

protected

Must be called once from the subclass constructor to init the clip owner.

clipCreated()

virtual void tracktion::engine::ClipOwner::clipCreated ( Clip &  )

protectedpure virtual

Called when a clip is created which could be during Edit load.

Implemented in tracktion::engine::ClipTrack.

clipAddedOrRemoved()

virtual void tracktion::engine::ClipOwner::clipAddedOrRemoved ( )

protectedpure virtual

Called when a clip is added or removed.

This is subtly different to the created/deleted callback as it will only get called whilst the Edit is in normal operation.

Implemented in tracktion::engine::ClipTrack.

clipOrderChanged()

virtual void tracktion::engine::ClipOwner::clipOrderChanged ( )

protectedpure virtual

Called when clips have moved times so that their order has changed.

N.B. This may be asyncronously to their start times changing.

Implemented in tracktion::engine::ClipTrack.

clipPositionChanged()

virtual void tracktion::engine::ClipOwner::clipPositionChanged ( )

protectedpure virtual

Called when a clip start or end position has changed.

Implemented in tracktion::engine::ClipTrack.

---

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

• tracktion_ClipOwner.h