Public Member Functions | Protected Member Functions | Protected Attributes | Friends
cinder::Cue Class Reference

#include <Timeline.h>

Inherits cinder::TimelineItem.

List of all members.

Public Member Functions

 Cue (std::function< void()> fn, float atTime=0)
CueRef create (std::function< void()> fn, float atTime=0)
void setFn (std::function< void()> fn)
std::function< void()> getFn () const
void * getTarget () const
 Returns the item's target pointer.
float getStartTime () const
 Returns the item's start time.
void setStartTime (float newTime)
 Set the items's start time to newTime.
float getDuration () const
 Returns the item's duration.
void setDuration (float newDuration)
 Sets the item's duration to newDuration.
bool getLoop () const
 Returns whether the item starts over when it is complete.
void setLoop (bool doLoop=true)
 Sets whether the item starts over when it is complete.
bool getPingPong () const
 Returns whether the item alternates between forward and reverse. Overrides loop when true.
void setPingPong (bool pingPong=true)
 Sets whether the item alternates between forward and reverse. Overrides loop when true.
bool getInfinite () const
 Returns whether the item ever is marked as complete.
void setInfinite (bool infinite=true)
 Sets whether the item ever is marked as complete.
float getEndTime () const
 Returns the time of the item's competion, equivalent to getStartTime() + getDuration().
class TimelinegetParent () const
 Returns a pointer to the item's parent Timeline.
void removeSelf ()
 Removes the item from its parent Timeline.
virtual void reset (bool unsetStarted=false)
 Marks the item as not completed, and if unsetStarted, marks the item as not started.
bool hasStarted () const
 Returns whether the item has started.
bool isComplete ()
 Returns whether the item has completed.
bool getAutoRemove () const
 Should the item remove itself from the Timeline when it is complete.
void setAutoRemove (bool autoRemove=true)
 Sets whether the item will remove itself from the Timeline when it is complete.
virtual float calcDuration () const
void stepTo (float time, bool reverse)
 go to a specific time, generally called by the parent Timeline only. If reverse then playhead is interpreted as retreating rather than advancing.
TimelineItemRef thisRef ()

Protected Member Functions

virtual void reverse ()
virtual TimelineItemRef cloneReverse () const
 Creates a cloned item which runs in reverse relative to a timeline of duration timelineDuration.
virtual TimelineItemRef clone () const
 Creates a clone of the item.
virtual void start (bool reverse)
virtual void loopStart ()
virtual void update (float relativeTime)
virtual void complete (bool reverse)
virtual bool updateAtLoopStart ()
 Call update() only at the beginning of each loop (for example Cues exhibit require this behavior)
void setDurationDirty ()
void updateDuration () const
float loopTime (float absTime)
 Converts time from absolute to absolute based on item's looping attributes.
void setTarget (void *target)

Protected Attributes

std::function< void()> mFunction
class TimelinemParent
void * mTarget
float mStartTime
bool mHasStarted
bool mHasReverseStarted
bool mComplete
bool mReverseComplete
bool mMarkedForRemoval
bool mInfinite
bool mLoop
bool mPingPong
bool mUseAbsoluteTime
bool mAutoRemove
int32_t mLastLoopIteration

Friends

class Timeline

Constructor & Destructor Documentation

cinder::Cue::Cue ( std::function< void()>  fn,
float  atTime = 0 
)

Member Function Documentation

CueRef cinder::Cue::create ( std::function< void()>  fn,
float  atTime = 0 
)
void cinder::Cue::setFn ( std::function< void()>  fn)
std::function<void ()> cinder::Cue::getFn ( ) const
virtual void cinder::Cue::reverse ( ) [protected, virtual]

Implements cinder::TimelineItem.

TimelineItemRef cinder::Cue::cloneReverse ( ) const [protected, virtual]

Creates a cloned item which runs in reverse relative to a timeline of duration timelineDuration.

Implements cinder::TimelineItem.

TimelineItemRef cinder::Cue::clone ( ) const [protected, virtual]

Creates a clone of the item.

Implements cinder::TimelineItem.

virtual void cinder::Cue::start ( bool  reverse) [protected, virtual]

Implements cinder::TimelineItem.

void cinder::Cue::loopStart ( ) [protected, virtual]

Reimplemented from cinder::TimelineItem.

virtual void cinder::Cue::update ( float  relativeTime) [protected, virtual]

Implements cinder::TimelineItem.

virtual void cinder::Cue::complete ( bool  reverse) [protected, virtual]

Implements cinder::TimelineItem.

virtual bool cinder::Cue::updateAtLoopStart ( ) [protected, virtual]

Call update() only at the beginning of each loop (for example Cues exhibit require this behavior)

Reimplemented from cinder::TimelineItem.

void* cinder::TimelineItem::getTarget ( ) const [inherited]

Returns the item's target pointer.

Reimplemented in cinder::Tween< T >.

float cinder::TimelineItem::getStartTime ( ) const [inherited]

Returns the item's start time.

void cinder::TimelineItem::setStartTime ( float  newTime) [inherited]

Set the items's start time to newTime.

float cinder::TimelineItem::getDuration ( ) const [inherited]

Returns the item's duration.

void cinder::TimelineItem::setDuration ( float  newDuration) [inherited]

Sets the item's duration to newDuration.

bool cinder::TimelineItem::getLoop ( ) const [inherited]

Returns whether the item starts over when it is complete.

void cinder::TimelineItem::setLoop ( bool  doLoop = true) [inherited]

Sets whether the item starts over when it is complete.

bool cinder::TimelineItem::getPingPong ( ) const [inherited]

Returns whether the item alternates between forward and reverse. Overrides loop when true.

void cinder::TimelineItem::setPingPong ( bool  pingPong = true) [inherited]

Sets whether the item alternates between forward and reverse. Overrides loop when true.

bool cinder::TimelineItem::getInfinite ( ) const [inherited]

Returns whether the item ever is marked as complete.

void cinder::TimelineItem::setInfinite ( bool  infinite = true) [inherited]

Sets whether the item ever is marked as complete.

float cinder::TimelineItem::getEndTime ( ) const [inherited]

Returns the time of the item's competion, equivalent to getStartTime() + getDuration().

class Timeline* cinder::TimelineItem::getParent ( ) const [inherited]

Returns a pointer to the item's parent Timeline.

void cinder::TimelineItem::removeSelf ( ) [inherited]

Removes the item from its parent Timeline.

virtual void cinder::TimelineItem::reset ( bool  unsetStarted = false) [virtual, inherited]

Marks the item as not completed, and if unsetStarted, marks the item as not started.

Reimplemented in cinder::Timeline, and cinder::TweenBase.

bool cinder::TimelineItem::hasStarted ( ) const [inherited]

Returns whether the item has started.

bool cinder::TimelineItem::isComplete ( ) [inherited]

Returns whether the item has completed.

bool cinder::TimelineItem::getAutoRemove ( ) const [inherited]

Should the item remove itself from the Timeline when it is complete.

void cinder::TimelineItem::setAutoRemove ( bool  autoRemove = true) [inherited]

Sets whether the item will remove itself from the Timeline when it is complete.

virtual float cinder::TimelineItem::calcDuration ( ) const [virtual, inherited]

Reimplemented in cinder::Timeline.

void cinder::TimelineItem::stepTo ( float  time,
bool  reverse 
) [inherited]

go to a specific time, generally called by the parent Timeline only. If reverse then playhead is interpreted as retreating rather than advancing.

Reimplemented in cinder::Timeline.

void cinder::TimelineItem::setDurationDirty ( ) [protected, inherited]
void cinder::TimelineItem::updateDuration ( ) const [protected, inherited]
float cinder::TimelineItem::loopTime ( float  absTime) [protected, inherited]

Converts time from absolute to absolute based on item's looping attributes.

void cinder::TimelineItem::setTarget ( void *  target) [protected, inherited]

Friends And Related Function Documentation

friend class Timeline [friend, inherited]

Member Data Documentation

std::function<void ()> cinder::Cue::mFunction [protected]
class Timeline* cinder::TimelineItem::mParent [protected, inherited]
void* cinder::TimelineItem::mTarget [protected, inherited]
float cinder::TimelineItem::mStartTime [protected, inherited]
bool cinder::TimelineItem::mHasStarted [protected, inherited]
bool cinder::TimelineItem::mHasReverseStarted [protected, inherited]
bool cinder::TimelineItem::mComplete [protected, inherited]
bool cinder::TimelineItem::mReverseComplete [protected, inherited]
bool cinder::TimelineItem::mMarkedForRemoval [protected, inherited]
bool cinder::TimelineItem::mInfinite [protected, inherited]
bool cinder::TimelineItem::mLoop [protected, inherited]
bool cinder::TimelineItem::mPingPong [protected, inherited]
bool cinder::TimelineItem::mUseAbsoluteTime [protected, inherited]
bool cinder::TimelineItem::mAutoRemove [protected, inherited]
int32_t cinder::TimelineItem::mLastLoopIteration [protected, inherited]

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