Tanoda
Leap.Unity.Animation.TransformTweenBehaviour Class Reference

This is a wrapper MonoBehaviour that demonstrates and exposes some of the basic functionality of the Tween library. Tweens can interpolate between more than just Transform properties, so don't be afraid to roll your own. More...

Inheritance diagram for Leap.Unity.Animation.TransformTweenBehaviour:

Classes

class  FloatEvent
 

Public Types

enum  EventType { OnLeaveStart = 110 , OnReachEnd = 120 , OnLeaveEnd = 130 , OnReachStart = 140 }
 

Public Member Functions

void PlayTween ()
 Tweens play forward by default, but at any time past the starting state they can also be played backwards to return to the starting state. See the tween property for more direct control of this behaviour's tween. More...
 
void PlayTween (Direction tweenDirection=Direction.Forward, float afterDelay=0F)
 
void PlayForward ()
 
void PlayBackward ()
 
void PlayForwardAfterDelay (float delay=0F)
 
void PlayBackwardAfterDelay (float delay=0F)
 
void StopTween ()
 Stops the underlying tween and resets it to the starting state. More...
 
void SetTargetToStart ()
 
void SetTargetToEnd ()
 

Public Attributes

Transform targetTransform
 
Transform startTransform
 
Transform endTransform
 
bool startAtEnd = false
 
bool tweenLocalPosition = true
 
bool tweenLocalRotation = true
 
bool tweenLocalScale = true
 
float tweenDuration = 0.25F
 
SmoothType tweenSmoothType = SmoothType.Smooth
 
Action< float > OnProgress = (progress) => { }
 
Action OnLeaveStart = () => { }
 
Action OnReachEnd = () => { }
 
Action OnLeaveEnd = () => { }
 
Action OnReachStart = () => { }
 

Properties

Tween tween [get, set]
 Returns the Tween object the TransformTween behaviour produces on Start(). More...
 

Detailed Description

This is a wrapper MonoBehaviour that demonstrates and exposes some of the basic functionality of the Tween library. Tweens can interpolate between more than just Transform properties, so don't be afraid to roll your own.

Definition at line 23 of file TransformTweenBehaviour.cs.

Member Enumeration Documentation

◆ EventType

Enumerator
OnLeaveStart 
OnReachEnd 
OnLeaveEnd 
OnReachStart 

Definition at line 201 of file TransformTweenBehaviour.cs.

Member Function Documentation

◆ PlayBackward()

void Leap.Unity.Animation.TransformTweenBehaviour.PlayBackward ( )

Definition at line 156 of file TransformTweenBehaviour.cs.

◆ PlayBackwardAfterDelay()

void Leap.Unity.Animation.TransformTweenBehaviour.PlayBackwardAfterDelay ( float  delay = 0F)

Definition at line 164 of file TransformTweenBehaviour.cs.

◆ PlayForward()

void Leap.Unity.Animation.TransformTweenBehaviour.PlayForward ( )

Definition at line 152 of file TransformTweenBehaviour.cs.

◆ PlayForwardAfterDelay()

void Leap.Unity.Animation.TransformTweenBehaviour.PlayForwardAfterDelay ( float  delay = 0F)

Definition at line 160 of file TransformTweenBehaviour.cs.

◆ PlayTween() [1/2]

void Leap.Unity.Animation.TransformTweenBehaviour.PlayTween ( )

Tweens play forward by default, but at any time past the starting state they can also be played backwards to return to the starting state. See the tween property for more direct control of this behaviour's tween.

Definition at line 133 of file TransformTweenBehaviour.cs.

◆ PlayTween() [2/2]

void Leap.Unity.Animation.TransformTweenBehaviour.PlayTween ( Direction  tweenDirection = Direction.Forward,
float  afterDelay = 0F 
)

Definition at line 137 of file TransformTweenBehaviour.cs.

◆ SetTargetToEnd()

void Leap.Unity.Animation.TransformTweenBehaviour.SetTargetToEnd ( )

Definition at line 179 of file TransformTweenBehaviour.cs.

◆ SetTargetToStart()

void Leap.Unity.Animation.TransformTweenBehaviour.SetTargetToStart ( )

Definition at line 175 of file TransformTweenBehaviour.cs.

◆ StopTween()

void Leap.Unity.Animation.TransformTweenBehaviour.StopTween ( )

Stops the underlying tween and resets it to the starting state.

Definition at line 171 of file TransformTweenBehaviour.cs.

Member Data Documentation

◆ endTransform

Transform Leap.Unity.Animation.TransformTweenBehaviour.endTransform

Definition at line 31 of file TransformTweenBehaviour.cs.

◆ OnLeaveEnd

Action Leap.Unity.Animation.TransformTweenBehaviour.OnLeaveEnd = () => { }

Definition at line 49 of file TransformTweenBehaviour.cs.

◆ OnLeaveStart

Action Leap.Unity.Animation.TransformTweenBehaviour.OnLeaveStart = () => { }

Definition at line 47 of file TransformTweenBehaviour.cs.

◆ OnProgress

Action<float> Leap.Unity.Animation.TransformTweenBehaviour.OnProgress = (progress) => { }

Definition at line 45 of file TransformTweenBehaviour.cs.

◆ OnReachEnd

Action Leap.Unity.Animation.TransformTweenBehaviour.OnReachEnd = () => { }

Definition at line 48 of file TransformTweenBehaviour.cs.

◆ OnReachStart

Action Leap.Unity.Animation.TransformTweenBehaviour.OnReachStart = () => { }

Definition at line 50 of file TransformTweenBehaviour.cs.

◆ startAtEnd

bool Leap.Unity.Animation.TransformTweenBehaviour.startAtEnd = false

Definition at line 33 of file TransformTweenBehaviour.cs.

◆ startTransform

Transform Leap.Unity.Animation.TransformTweenBehaviour.startTransform

Definition at line 29 of file TransformTweenBehaviour.cs.

◆ targetTransform

Transform Leap.Unity.Animation.TransformTweenBehaviour.targetTransform

Definition at line 26 of file TransformTweenBehaviour.cs.

◆ tweenDuration

float Leap.Unity.Animation.TransformTweenBehaviour.tweenDuration = 0.25F

Definition at line 40 of file TransformTweenBehaviour.cs.

◆ tweenLocalPosition

bool Leap.Unity.Animation.TransformTweenBehaviour.tweenLocalPosition = true

Definition at line 36 of file TransformTweenBehaviour.cs.

◆ tweenLocalRotation

bool Leap.Unity.Animation.TransformTweenBehaviour.tweenLocalRotation = true

Definition at line 37 of file TransformTweenBehaviour.cs.

◆ tweenLocalScale

bool Leap.Unity.Animation.TransformTweenBehaviour.tweenLocalScale = true

Definition at line 38 of file TransformTweenBehaviour.cs.

◆ tweenSmoothType

SmoothType Leap.Unity.Animation.TransformTweenBehaviour.tweenSmoothType = SmoothType.Smooth

Definition at line 41 of file TransformTweenBehaviour.cs.

Property Documentation

◆ tween

Tween Leap.Unity.Animation.TransformTweenBehaviour.tween
getset

Returns the Tween object the TransformTween behaviour produces on Start().

Use this to play or otherwise manipulate the animation.

Definition at line 60 of file TransformTweenBehaviour.cs.


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