TracktionEngine
Public Member Functions | Protected Member Functions | List of all members
tracktion::engine::ClipOwner Class Referenceabstract

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

Inheritance diagram for tracktion::engine::ClipOwner:

Public Member Functions

 ClipOwner ()
 Constructs an empty ClipOwner. More...
 
virtual ~ClipOwner ()
 Destructor. More...
 
virtual juce::ValueTree & getClipOwnerState ()=0
 Must return the state of this ClipOwner. More...
 
virtual SelectablegetClipOwnerSelectable ()=0
 Must return the selectable if this ClipOwner is one. More...
 
virtual EditgetClipOwnerEdit ()=0
 Must return the Edit this ClipOwner belongs to. More...
 
const juce::Array< Clip * > & getClips () const
 Returns the clips this owner contains. More...
 

Protected Member Functions

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

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::ClipTrack, and tracktion::engine::ContainerClip.

◆ getClipOwnerSelectable()

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

Must return the selectable if this ClipOwner is one.

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

◆ getClipOwnerEdit()

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

Must return the Edit this ClipOwner belongs to.

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

◆ 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: