Otter  0.9.88
2d Game Development Framework based on SFML.Net
 All Classes Namespaces Functions Variables Enumerations Properties
Otter.Tween.TweenerImpl Class Reference

Inherits Otter.Tween.IRemoveTweens.

Inherited by Otter.Tweener.

Public Member Functions

Tween Tween< T > (T target, object values, float duration, float delay=0, bool overwrite=false)
 
Tween Timer (float duration, float delay=0)
 Starts a simple timer for setting up callback scheduling. More...
 
void Cancel ()
 Remove tweens from the tweener without calling their complete functions. More...
 
void CancelAndComplete ()
 Assign tweens their final value and remove them from the tweener. More...
 
void Pause ()
 Set tweens to pause. They won't update and their delays won't tick down. More...
 
void PauseToggle ()
 Toggle tweens' paused value. More...
 
void Resume ()
 Resumes tweens from a paused state. More...
 
void Update (float secondsElapsed)
 Updates the tweener and all objects it contains. More...
 
void TargetCancel (object target)
 Cancel all tweens with the given target. More...
 
void TargetCancel (object target, params string[] properties)
 Cancel tweening named properties on the given target. More...
 
void TargetCancelAndComplete (object target)
 Cancel, complete, and call complete callbacks for all tweens with the given target.. More...
 
void TargetPause (object target)
 Pause all tweens with the given target. More...
 
void TargetPauseToggle (object target)
 Toggle the pause state of all tweens with the given target. More...
 
void TargetResume (object target)
 Resume all tweens with the given target. More...
 
- Public Member Functions inherited from Otter.Tween.IRemoveTweens
void Remove (Tween t)
 

Static Public Member Functions

static void SetLerper< TLerper > (Type propertyType)
 Associate a Lerper class with a property type. More...
 

Member Function Documentation

void Otter.Tween.TweenerImpl.Cancel ( )

Remove tweens from the tweener without calling their complete functions.

void Otter.Tween.TweenerImpl.CancelAndComplete ( )

Assign tweens their final value and remove them from the tweener.

void Otter.Tween.TweenerImpl.Pause ( )

Set tweens to pause. They won't update and their delays won't tick down.

void Otter.Tween.TweenerImpl.PauseToggle ( )

Toggle tweens' paused value.

void Otter.Tween.TweenerImpl.Resume ( )

Resumes tweens from a paused state.

static void Otter.Tween.TweenerImpl.SetLerper< TLerper > ( Type  propertyType)
static

Associate a Lerper class with a property type.

Template Parameters
TLerperThe Lerper class to use for properties of the given type.
Parameters
typeThe type of the property to associate the given Lerper with.
Type Constraints
TLerper :GlideLerper 
TLerper :new() 
void Otter.Tween.TweenerImpl.TargetCancel ( object  target)

Cancel all tweens with the given target.

Parameters
targetThe object being tweened that you want to cancel.
void Otter.Tween.TweenerImpl.TargetCancel ( object  target,
params string[]  properties 
)

Cancel tweening named properties on the given target.

Parameters
targetThe object being tweened that you want to cancel properties on.
propertiesThe properties to cancel.
void Otter.Tween.TweenerImpl.TargetCancelAndComplete ( object  target)

Cancel, complete, and call complete callbacks for all tweens with the given target..

Parameters
targetThe object being tweened that you want to cancel and complete.
void Otter.Tween.TweenerImpl.TargetPause ( object  target)

Pause all tweens with the given target.

Parameters
targetThe object being tweened that you want to pause.
void Otter.Tween.TweenerImpl.TargetPauseToggle ( object  target)

Toggle the pause state of all tweens with the given target.

Parameters
targetThe object being tweened that you want to toggle pause.
void Otter.Tween.TweenerImpl.TargetResume ( object  target)

Resume all tweens with the given target.

Parameters
targetThe object being tweened that you want to resume.
Tween Otter.Tween.TweenerImpl.Timer ( float  duration,
float  delay = 0 
)

Starts a simple timer for setting up callback scheduling.

Parameters
durationHow long the timer will run for, in seconds.
delayHow long to wait before starting the timer, in seconds.
Returns
The tween created, for setting properties.
Tween Otter.Tween.TweenerImpl.Tween< T > ( target,
object  values,
float  duration,
float  delay = 0,
bool  overwrite = false 
)

Tweens a set of properties on an object.

To tween instance properties/fields, pass the object.

To tween static properties/fields, pass the type of the object, using typeof(ObjectType) or object.GetType().

Parameters
targetThe object or type to tween.
valuesThe values to tween to, in an anonymous type ( new { prop1 = 100, prop2 = 0} ).
durationDuration of the tween in seconds.
delayDelay before the tween starts, in seconds.
overwriteWhether pre-existing tweens should be overwritten if this tween involves the same properties.
Returns
The tween created, for setting properties on.
Type Constraints
T :class 
void Otter.Tween.TweenerImpl.Update ( float  secondsElapsed)

Updates the tweener and all objects it contains.

Parameters
secondsElapsedSeconds elapsed since last update.

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