Sequine - Scripting API
Calcatz.Sequine.TransformTweenCommand Class Reference

Base class for commands that tweens a Transform's value. More...

Inheritance diagram for Calcatz.Sequine.TransformTweenCommand:
Calcatz.Sequine.ModifyTransformCommand Calcatz.CookieCutter.Command< Vector3, Quaternion > Calcatz.Sequine.TweenPositionCommand Calcatz.Sequine.TweenRotationCommand Calcatz.Sequine.TweenScaleCommand

Public Member Functions

override void Execute (CommandExecutionFlow _flow)
 The process to execute upon visiting the main in-point (white in-point). More...
 
override void Editor_InitInPoints ()
 Called when a Command Node is initialized, specifically the in-points. Use this method to ensure inputIds as well. More...
 
override void Editor_InitOutPoints ()
 Called when a Command Node is initialized, specifically the out-points. Use this method to ensure nextIds as well. More...
 
override void Editor_OnDrawContents (Vector2 _absPosition)
 Called when a Command Node is drawn. More...
 
- Public Member Functions inherited from Calcatz.Sequine.ModifyTransformCommand
override bool Validate (CommandData _commandData)
 Validate() is called when opening the nodes editor (if in Edit Mode), or right before the command execution (if in Play Mode). The main purpose is to adapt or validate any data inside the Command, if its structure had been changed. More...
 

Public Attributes

Tween tween = new Tween()
 
- Public Attributes inherited from Calcatz.Sequine.ModifyTransformCommand
bool localSpace
 
UnityEngine.Object transformTarget
 
TargetObject< Transform > transformRef
 

Static Public Attributes

const int IN_PORT_DURATION = 1
 
const int OUT_PORT_ONCOMPLETE = 1
 
- Static Public Attributes inherited from Calcatz.Sequine.ModifyTransformCommand
const int IN_PORT_TARGET = 0
 

Protected Member Functions

override void HandleInterruption ()
 Called when the current flow is force killed, while the currently executed command is exactly this command, and has not exited. Note that "exited" here means that Exit() method has been called. More...
 
void StartTweening (CommandExecutionFlow _flow, Transform _transform)
 
virtual void OnTweenUpdate (float _t)
 
- Protected Member Functions inherited from Calcatz.Sequine.ModifyTransformCommand
Transform GetTransform (CommandExecutionFlow _flow)
 

Properties

Transform currentTransform [get]
 
- Properties inherited from Calcatz.Sequine.ModifyTransformCommand
override float nodeWidth [get]
 
virtual bool globalSpaceAvailable [get]
 

Detailed Description

Base class for commands that tweens a Transform's value.

Member Function Documentation

◆ Editor_InitInPoints()

override void Calcatz.Sequine.TransformTweenCommand.Editor_InitInPoints ( )
virtual

Called when a Command Node is initialized, specifically the in-points. Use this method to ensure inputIds as well.

Reimplemented from Calcatz.Sequine.ModifyTransformCommand.

Reimplemented in Calcatz.Sequine.TweenPositionCommand, Calcatz.Sequine.TweenRotationCommand, and Calcatz.Sequine.TweenScaleCommand.

◆ Editor_InitOutPoints()

override void Calcatz.Sequine.TransformTweenCommand.Editor_InitOutPoints ( )
virtual

Called when a Command Node is initialized, specifically the out-points. Use this method to ensure nextIds as well.

Reimplemented from Calcatz.CookieCutter.Command< Vector3, Quaternion >.

Reimplemented in Calcatz.Sequine.TweenPositionCommand, Calcatz.Sequine.TweenRotationCommand, and Calcatz.Sequine.TweenScaleCommand.

◆ Editor_OnDrawContents()

override void Calcatz.Sequine.TransformTweenCommand.Editor_OnDrawContents ( Vector2  _absPosition)
virtual

Called when a Command Node is drawn.

Parameters
_absPosition

Reimplemented from Calcatz.Sequine.ModifyTransformCommand.

Reimplemented in Calcatz.Sequine.TweenPositionCommand, Calcatz.Sequine.TweenRotationCommand, and Calcatz.Sequine.TweenScaleCommand.

◆ Execute()

override void Calcatz.Sequine.TransformTweenCommand.Execute ( CommandExecutionFlow  _flow)
virtual

The process to execute upon visiting the main in-point (white in-point).

Parameters
_flow

Reimplemented from Calcatz.CookieCutter.Command< Vector3, Quaternion >.

Reimplemented in Calcatz.Sequine.TweenPositionCommand, Calcatz.Sequine.TweenRotationCommand, and Calcatz.Sequine.TweenScaleCommand.

◆ HandleInterruption()

override void Calcatz.Sequine.TransformTweenCommand.HandleInterruption ( )
protectedvirtual

Called when the current flow is force killed, while the currently executed command is exactly this command, and has not exited. Note that "exited" here means that Exit() method has been called.

Reimplemented from Calcatz.CookieCutter.Command< Vector3, Quaternion >.

◆ OnTweenUpdate()

virtual void Calcatz.Sequine.TransformTweenCommand.OnTweenUpdate ( float  _t)
protectedvirtual

◆ StartTweening()

void Calcatz.Sequine.TransformTweenCommand.StartTweening ( CommandExecutionFlow  _flow,
Transform  _transform 
)
protected

Member Data Documentation

◆ IN_PORT_DURATION

const int Calcatz.Sequine.TransformTweenCommand.IN_PORT_DURATION = 1
static

◆ OUT_PORT_ONCOMPLETE

const int Calcatz.Sequine.TransformTweenCommand.OUT_PORT_ONCOMPLETE = 1
static

◆ tween

Tween Calcatz.Sequine.TransformTweenCommand.tween = new Tween()

Property Documentation

◆ currentTransform

Transform Calcatz.Sequine.TransformTweenCommand.currentTransform
getprotected