om::engine::base::SequencerTrack Class Reference

An interface for objects that handle playback of a specific type of time sequence. More...

#include <omEngineSequencerTrack.h>

Inheritance diagram for om::engine::base::SequencerTrack:

Public Member Functions
virtual	~SequencerTrack ()
	Destroy a sequencer track and release internal resources. More...
virtual Size	getSequenceCount () const =0
	Return the number of sequences that this track supports playing. More...
virtual Sequence *	getSequence (Index sequenceIndex) const =0
	Return a pointer to the sequence at the specified index in this track. More...
virtual Bool	getSequenceIndex (Sequence *sequence, Index &sequenceIndex) const =0
	Get the index of the specified sequence in this track. More...
virtual Bool	playSequence (Index sequenceIndex, PlaybackID playbackID, const Playback &playback)=0
	Play the specified sequence with the given playback state using this sequencer track. More...
virtual void	updatePlayback (PlaybackID playbackID, const Playback &playback)=0
	Update the playback state for a currently playing sequence in this sequencer track. More...
virtual void	pausePlayback (PlaybackID playbackID)=0
	Pause a currently playing playback instance with the specified ID. More...
virtual void	resumePlayback (PlaybackID playbackID)=0
	Resume playback for a playback instance with the specified ID. More...
virtual void	stopPlayback (PlaybackID playbackID)=0
	Completely stop playback for the playback instance with the specified ID. More...
virtual void	pauseAll ()=0
	Simultaneously pause the playback of all playback instances in this sequencer track. More...
virtual void	resumeAll ()=0
	Simultaneously resume the playback of all playback instances in this sequencer track. More...
virtual void	stopAll ()=0
	Simultaneously stop the playback of all playback instances in this sequencer track. More...
virtual const ResourceType &	getResourceType () const =0
	Return the resource type of this object's concrete type. More...

Detailed Description

An interface for objects that handle playback of a specific type of time sequence.

Constructor & Destructor Documentation

virtual om::engine::base::SequencerTrack::~SequencerTrack ( )

inlinevirtual

Destroy a sequencer track and release internal resources.

Member Function Documentation

virtual Size om::engine::base::SequencerTrack::getSequenceCount ( ) const

pure virtual

Return the number of sequences that this track supports playing.

Implemented in om::engine::animation::AnimationSequencerTrack, and om::engine::sound::SoundSequencerTrack.

virtual Sequence* om::engine::base::SequencerTrack::getSequence ( Index  sequenceIndex ) const

pure virtual

Return a pointer to the sequence at the specified index in this track.

Implemented in om::engine::animation::AnimationSequencerTrack, and om::engine::sound::SoundSequencerTrack.

virtual Bool om::engine::base::SequencerTrack::getSequenceIndex ( Sequence *  sequence, Index &  sequenceIndex  ) const

pure virtual

Get the index of the specified sequence in this track.

Implemented in om::engine::animation::AnimationSequencerTrack, and om::engine::sound::SoundSequencerTrack.

virtual Bool om::engine::base::SequencerTrack::playSequence ( Index  sequenceIndex, PlaybackID  playbackID, const Playback &  playback  )

pure virtual

Play the specified sequence with the given playback state using this sequencer track.

Implemented in om::engine::animation::AnimationSequencerTrack, and om::engine::sound::SoundSequencerTrack.

virtual void om::engine::base::SequencerTrack::updatePlayback ( PlaybackID  playbackID, const Playback &  playback  )

pure virtual

Update the playback state for a currently playing sequence in this sequencer track.

Implemented in om::engine::animation::AnimationSequencerTrack, and om::engine::sound::SoundSequencerTrack.

virtual void om::engine::base::SequencerTrack::pausePlayback ( PlaybackID  playbackID )

pure virtual

Pause a currently playing playback instance with the specified ID.

Implemented in om::engine::animation::AnimationSequencerTrack, and om::engine::sound::SoundSequencerTrack.

virtual void om::engine::base::SequencerTrack::resumePlayback ( PlaybackID  playbackID )

pure virtual

Resume playback for a playback instance with the specified ID.

Implemented in om::engine::animation::AnimationSequencerTrack, and om::engine::sound::SoundSequencerTrack.

virtual void om::engine::base::SequencerTrack::stopPlayback ( PlaybackID  playbackID )

pure virtual

Completely stop playback for the playback instance with the specified ID.

Implemented in om::engine::animation::AnimationSequencerTrack, and om::engine::sound::SoundSequencerTrack.

virtual void om::engine::base::SequencerTrack::pauseAll ( )

pure virtual

Simultaneously pause the playback of all playback instances in this sequencer track.

Implemented in om::engine::animation::AnimationSequencerTrack, and om::engine::sound::SoundSequencerTrack.

virtual void om::engine::base::SequencerTrack::resumeAll ( )

pure virtual

Simultaneously resume the playback of all playback instances in this sequencer track.

Implemented in om::engine::animation::AnimationSequencerTrack, and om::engine::sound::SoundSequencerTrack.

virtual void om::engine::base::SequencerTrack::stopAll ( )

pure virtual

Simultaneously stop the playback of all playback instances in this sequencer track.

Implemented in om::engine::animation::AnimationSequencerTrack, and om::engine::sound::SoundSequencerTrack.

virtual const ResourceType& om::engine::base::SequencerTrack::getResourceType ( ) const

pure virtual

Return the resource type of this object's concrete type.

Implemented in om::engine::sound::SoundSequencerTrack, and om::engine::animation::AnimationSequencerTrack.

---

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

• omEngineSequencerTrack.h