Sequine - Scripting API
Calcatz.Sequine.SequineState Class Reference

Manages how an animation clip behaves upon being played. More...

Inheritance diagram for Calcatz.Sequine.SequineState:
Calcatz.Sequine.SequineRangedState

Public Member Functions

 SequineState (AnimationMixerPlayable _animationMixer, int _inputPort)
 
void Reset ()
 
void Restart ()
 
void Play ()
 
void Stop ()
 
void Pause ()
 
void Resume ()
 
void Exit ()
 
virtual void Finish ()
 
void Tick (float _deltaTime)
 

Public Attributes

Action onComplete
 
OnStateUpdateCallback onUpdate
 

Protected Member Functions

virtual void OnTimeIncremented ()
 

Protected Attributes

AnimationClipPlayable m_clipPlayable
 
bool m_completed
 

Properties

float lengthToPlay [getset]
 
float speed [getset]
 
float time [getset]
 
float duration [get]
 
float weight [get]
 
bool isExiting [get]
 
bool exited [get]
 Whether the state has been fully transitioned to the next state or not. More...
 
bool completed [get]
 Whether the clip has been fully played according to the length to play or not. More...
 
float fadeInDuration [getset]
 
float fadeOutDuration [getset]
 
float fadeInDurationNormalized [getset]
 
float fadeOutDurationNormalized [getset]
 
float normalizedTime [getset]
 
float normalizedLength [get]
 Current played length according to lengthToPlay More...
 
AnimationClip clip [get]
 

Detailed Description

Manages how an animation clip behaves upon being played.

Constructor & Destructor Documentation

◆ SequineState()

Calcatz.Sequine.SequineState.SequineState ( AnimationMixerPlayable  _animationMixer,
int  _inputPort 
)

Member Function Documentation

◆ Exit()

void Calcatz.Sequine.SequineState.Exit ( )

◆ Finish()

virtual void Calcatz.Sequine.SequineState.Finish ( )
virtual

◆ OnTimeIncremented()

virtual void Calcatz.Sequine.SequineState.OnTimeIncremented ( )
protectedvirtual

◆ Pause()

void Calcatz.Sequine.SequineState.Pause ( )

◆ Play()

void Calcatz.Sequine.SequineState.Play ( )

◆ Reset()

void Calcatz.Sequine.SequineState.Reset ( )

◆ Restart()

void Calcatz.Sequine.SequineState.Restart ( )

◆ Resume()

void Calcatz.Sequine.SequineState.Resume ( )

◆ Stop()

void Calcatz.Sequine.SequineState.Stop ( )

◆ Tick()

void Calcatz.Sequine.SequineState.Tick ( float  _deltaTime)

Member Data Documentation

◆ m_clipPlayable

AnimationClipPlayable Calcatz.Sequine.SequineState.m_clipPlayable
protected

◆ m_completed

bool Calcatz.Sequine.SequineState.m_completed
protected

◆ onComplete

Action Calcatz.Sequine.SequineState.onComplete

◆ onUpdate

OnStateUpdateCallback Calcatz.Sequine.SequineState.onUpdate

Property Documentation

◆ clip

AnimationClip Calcatz.Sequine.SequineState.clip
get

◆ completed

bool Calcatz.Sequine.SequineState.completed
get

Whether the clip has been fully played according to the length to play or not.

◆ duration

float Calcatz.Sequine.SequineState.duration
get

◆ exited

bool Calcatz.Sequine.SequineState.exited
get

Whether the state has been fully transitioned to the next state or not.

◆ fadeInDuration

float Calcatz.Sequine.SequineState.fadeInDuration
getset

◆ fadeInDurationNormalized

float Calcatz.Sequine.SequineState.fadeInDurationNormalized
getset

◆ fadeOutDuration

float Calcatz.Sequine.SequineState.fadeOutDuration
getset

◆ fadeOutDurationNormalized

float Calcatz.Sequine.SequineState.fadeOutDurationNormalized
getset

◆ isExiting

bool Calcatz.Sequine.SequineState.isExiting
get

◆ lengthToPlay

float Calcatz.Sequine.SequineState.lengthToPlay
getset

◆ normalizedLength

float Calcatz.Sequine.SequineState.normalizedLength
get

Current played length according to lengthToPlay

◆ normalizedTime

float Calcatz.Sequine.SequineState.normalizedTime
getset

◆ speed

float Calcatz.Sequine.SequineState.speed
getset

◆ time

float Calcatz.Sequine.SequineState.time
getset

◆ weight

float Calcatz.Sequine.SequineState.weight
get