#include <Tween.h>
Inherits cinder::TimelineItem.
Inherited by cinder::Tween< T >.
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 | |
| 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 |
| 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 Timeline * | getParent () const |
| Returns a pointer to the item's parent Timeline. | |
| void | removeSelf () |
| Removes the item from its parent Timeline. | |
| 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 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) | |
| virtual float | calcDuration () const |
| virtual void | reverse ()=0 |
| virtual TimelineItemRef | clone () const =0 |
| Creates a clone of the item. | |
| virtual TimelineItemRef | cloneReverse () const =0 |
| Creates a cloned item which runs in reverse relative to a timeline of duration timelineDuration. | |
| 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 | reset (bool unsetStarted) |
| Marks the item as not completed, and if unsetStarted, marks the item as not started. | |
| 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. | |
| void | setTarget (void *target) |
Protected Attributes | |
| StartFn | mStartFunction |
| StartFn | mReverseStartFunction |
| UpdateFn | mUpdateFunction |
| FinishFn | mFinishFunction |
| FinishFn | mReverseFinishFunction |
| EaseFn | mEaseFunction |
| float | mDuration |
| bool | mCopyStartValue |
| class Timeline * | mParent |
| 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 |
| typedef std::function<void ()> cinder::TweenBase::StartFn |
| typedef std::function<void ()> cinder::TweenBase::FinishFn |
| typedef std::function<void ()> cinder::TweenBase::UpdateFn |
| cinder::TweenBase::TweenBase | ( | void * | target, |
| bool | copyStartValue, | ||
| float | startTime, | ||
| float | duration, | ||
| EaseFn | easeFunction = easeNone |
||
| ) |
| virtual cinder::TweenBase::~TweenBase | ( | ) | [virtual] |
| 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 | ) |
| virtual void cinder::TweenBase::reset | ( | bool | unsetStarted | ) | [protected, virtual] |
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 | ) | [protected, virtual] |
Implements 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.
| 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 virtual, inherited] |
Implemented in cinder::Tween< T >, cinder::Cue, and cinder::Timeline.
| virtual void cinder::TimelineItem::loopStart | ( | ) | [virtual, inherited] |
Reimplemented in cinder::Cue, and cinder::Timeline.
| virtual void cinder::TimelineItem::update | ( | float | relativeTime | ) | [pure virtual, inherited] |
Implemented in cinder::FnTween< T >, cinder::Tween< T >, cinder::Cue, and cinder::Timeline.
| virtual bool cinder::TimelineItem::updateAtLoopStart | ( | ) | [virtual, inherited] |
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 [virtual, inherited] |
Reimplemented in cinder::Timeline.
| virtual void cinder::TimelineItem::reverse | ( | ) | [pure virtual, inherited] |
Implemented in cinder::Cue, cinder::Tween< T >, and cinder::Timeline.
| virtual TimelineItemRef cinder::TimelineItem::clone | ( | ) | const [pure virtual, inherited] |
Creates a clone of the item.
Implemented in cinder::Cue, cinder::Tween< T >, and cinder::Timeline.
| virtual TimelineItemRef cinder::TimelineItem::cloneReverse | ( | ) | const [pure virtual, inherited] |
Creates a cloned item which runs in reverse relative to a timeline of duration timelineDuration.
Implemented in cinder::Tween< T >, cinder::Cue, 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] |
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] |
friend class Timeline [friend, inherited] |
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] |
Reimplemented from cinder::TimelineItem.
bool cinder::TweenBase::mCopyStartValue [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] |