Cinder  0.8.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
cinder::TweenBase Class Referenceabstract

#include <Tween.h>

Inheritance diagram for cinder::TweenBase:
[legend]

Classes

class  Options
 

Public Types

typedef std::function< void()> StartFn
 
typedef std::function< void()> FinishFn
 
typedef std::function< void()> UpdateFn
 

Public Member Functions

 TweenBase (void *target, bool copyStartValue, float startTime, float duration, EaseFn easeFunction=easeNone)
 
virtual ~TweenBase ()
 
void setEaseFn (EaseFn easeFunction)
 change how the tween moves through time More...
 
EaseFn getEaseFn () const
 
void setStartFn (StartFn startFunction)
 
StartFn getStartFn () const
 
void setReverseStartFn (StartFn reverseStartFunction)
 
StartFn getReverseStartFn () const
 
void setUpdateFn (UpdateFn updateFunction)
 
UpdateFn getUpdateFn () const
 
void setFinishFn (FinishFn finishFn)
 
FinishFn getFinishFn () const
 
void setReverseFinishFn (FinishFn reverseFinishFn)
 
FinishFn getReverseFinishFn () const
 
voidgetTarget () const
 Returns the item's target pointer. More...
 
float getStartTime () const
 Returns the item's start time. More...
 
void setStartTime (float newTime)
 Set the items's start time to newTime. More...
 
float getDuration () const
 Returns the item's duration. More...
 
void setDuration (float newDuration)
 Sets the item's duration to newDuration. More...
 
bool getLoop () const
 Returns whether the item starts over when it is complete. More...
 
void setLoop (bool doLoop=true)
 Sets whether the item starts over when it is complete. More...
 
bool getPingPong () const
 Returns whether the item alternates between forward and reverse. Overrides loop when true. More...
 
void setPingPong (bool pingPong=true)
 Sets whether the item alternates between forward and reverse. Overrides loop when true. More...
 
bool getInfinite () const
 Returns whether the item ever is marked as complete. More...
 
void setInfinite (bool infinite=true)
 Sets whether the item ever is marked as complete. More...
 
float getEndTime () const
 Returns the time of the item's competion, equivalent to getStartTime() + getDuration(). More...
 
class TimelinegetParent () const
 Returns a pointer to the item's parent Timeline. More...
 
void removeSelf ()
 Removes the item from its parent Timeline. More...
 
bool hasStarted () const
 Returns whether the item has started. More...
 
bool isComplete ()
 Returns whether the item has completed. More...
 
bool getAutoRemove () const
 Should the item remove itself from the Timeline when it is complete. More...
 
void setAutoRemove (bool autoRemove=true)
 Sets whether the item will remove itself from the Timeline when it is complete. More...
 
virtual void start (bool reverse)=0
 
virtual void loopStart ()
 
virtual void update (float relativeTime)=0
 
virtual bool updateAtLoopStart ()
 Call update() only at the beginning of each loop (for example Cues exhibit require this behavior) More...
 
virtual float calcDuration () const
 
virtual void reverse ()=0
 
virtual TimelineItemRef clone () const =0
 Creates a clone of the item. More...
 
virtual TimelineItemRef cloneReverse () const =0
 Creates a cloned item which runs in reverse relative to a timeline of duration timelineDuration. More...
 
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. More...
 
TimelineItemRef thisRef ()
 

Protected Member Functions

virtual void reset (bool unsetStarted)
 Marks the item as not completed, and if unsetStarted, marks the item as not started. More...
 
virtual void complete (bool reverse)
 
void setDurationDirty ()
 
void updateDuration () const
 
float loopTime (float absTime)
 Converts time from absolute to absolute based on item's looping attributes. More...
 
void setTarget (void *target)
 

Protected Attributes

StartFn mStartFunction
 
StartFn mReverseStartFunction
 
UpdateFn mUpdateFunction
 
FinishFn mFinishFunction
 
FinishFn mReverseFinishFunction
 
EaseFn mEaseFunction
 
float mDuration
 
bool mCopyStartValue
 
class TimelinemParent
 
voidmTarget
 
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
 

Member Typedef Documentation

typedef std::function<void ()> cinder::TweenBase::StartFn
typedef std::function<void ()> cinder::TweenBase::FinishFn
typedef std::function<void ()> cinder::TweenBase::UpdateFn

Constructor & Destructor Documentation

cinder::TweenBase::TweenBase ( void target,
bool  copyStartValue,
float  startTime,
float  duration,
EaseFn  easeFunction = easeNone 
)
virtual cinder::TweenBase::~TweenBase ( )
virtual

Member Function Documentation

void cinder::TweenBase::setEaseFn ( EaseFn  easeFunction)

change how the tween moves through time

EaseFn cinder::TweenBase::getEaseFn ( ) const
void cinder::TweenBase::setStartFn ( StartFn  startFunction)
StartFn cinder::TweenBase::getStartFn ( ) const
void cinder::TweenBase::setReverseStartFn ( StartFn  reverseStartFunction)
StartFn cinder::TweenBase::getReverseStartFn ( ) const
void cinder::TweenBase::setUpdateFn ( UpdateFn  updateFunction)
UpdateFn cinder::TweenBase::getUpdateFn ( ) const
void cinder::TweenBase::setFinishFn ( FinishFn  finishFn)
FinishFn cinder::TweenBase::getFinishFn ( ) const
void cinder::TweenBase::setReverseFinishFn ( FinishFn  reverseFinishFn)
FinishFn cinder::TweenBase::getReverseFinishFn ( ) const
virtual void cinder::TweenBase::reset ( bool  unsetStarted)
protectedvirtual

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

Reimplemented from cinder::TimelineItem.

virtual void cinder::TweenBase::complete ( bool  reverse)
protectedvirtual

Implements cinder::TimelineItem.

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

Returns the item's target pointer.

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.

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 void cinder::TimelineItem::start ( bool  reverse)
pure virtualinherited
virtual void cinder::TimelineItem::loopStart ( )
virtualinherited

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

virtual void cinder::TimelineItem::update ( float  relativeTime)
pure virtualinherited
virtual bool cinder::TimelineItem::updateAtLoopStart ( )
virtualinherited

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

Reimplemented in cinder::Cue.

virtual float cinder::TimelineItem::calcDuration ( ) const
virtualinherited

Reimplemented in cinder::Timeline.

virtual void cinder::TimelineItem::reverse ( )
pure virtualinherited
virtual TimelineItemRef cinder::TimelineItem::clone ( ) const
pure virtualinherited

Creates a clone of the item.

Implemented in cinder::Cue, cinder::Tween< T >, and cinder::Timeline.

virtual TimelineItemRef cinder::TimelineItem::cloneReverse ( ) const
pure virtualinherited

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

Implemented in cinder::Cue, cinder::Tween< T >, and 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.

TimelineItemRef cinder::TimelineItem::thisRef ( )
inherited
void cinder::TimelineItem::setDurationDirty ( )
protectedinherited
void cinder::TimelineItem::updateDuration ( ) const
protectedinherited
float cinder::TimelineItem::loopTime ( float  absTime)
protectedinherited

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

void cinder::TimelineItem::setTarget ( void target)
protectedinherited

Member Data Documentation

StartFn cinder::TweenBase::mStartFunction
protected
StartFn cinder::TweenBase::mReverseStartFunction
protected
UpdateFn cinder::TweenBase::mUpdateFunction
protected
FinishFn cinder::TweenBase::mFinishFunction
protected
FinishFn cinder::TweenBase::mReverseFinishFunction
protected
EaseFn cinder::TweenBase::mEaseFunction
protected
float cinder::TweenBase::mDuration
protected
bool cinder::TweenBase::mCopyStartValue
protected
class Timeline* cinder::TimelineItem::mParent
protectedinherited
void* cinder::TimelineItem::mTarget
protectedinherited
float cinder::TimelineItem::mStartTime
protectedinherited
bool cinder::TimelineItem::mHasStarted
protectedinherited
bool cinder::TimelineItem::mHasReverseStarted
protectedinherited
bool cinder::TimelineItem::mComplete
protectedinherited
bool cinder::TimelineItem::mReverseComplete
protectedinherited
bool cinder::TimelineItem::mMarkedForRemoval
protectedinherited
bool cinder::TimelineItem::mInfinite
protectedinherited
bool cinder::TimelineItem::mLoop
protectedinherited
bool cinder::TimelineItem::mPingPong
protectedinherited
bool cinder::TimelineItem::mUseAbsoluteTime
protectedinherited
bool cinder::TimelineItem::mAutoRemove
protectedinherited
int32_t cinder::TimelineItem::mLastLoopIteration
protectedinherited

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