Sequine - Scripting API
Calcatz.Sequine.TweenPositionCommand Class Reference

Tweens the transform's position by interpolating it over time towards a target position after a certain duration. More...

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

Public Member Functions

override void Execute (CommandExecutionFlow _flow)
 The process to execute upon visiting the main in-point (white in-point). More...
 
override OneOf< Vector3, Quaternion > GetOutput (CommandExecutionFlow _flow, int _pointIndex)
 
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

Vector3 endPosition
 
- Public Attributes inherited from Calcatz.Sequine.TransformTweenCommand
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_POSITION = 2
 
const int OUT_PORT_POSITION = 2
 
- Static Public Attributes inherited from Calcatz.Sequine.TransformTweenCommand
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 OnTweenUpdate (float _t)
 
- Protected Member Functions inherited from Calcatz.Sequine.TransformTweenCommand
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)
 
- Protected Member Functions inherited from Calcatz.Sequine.ModifyTransformCommand
Transform GetTransform (CommandExecutionFlow _flow)
 

Additional Inherited Members

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

Detailed Description

Tweens the transform's position by interpolating it over time towards a target position after a certain duration.

Member Function Documentation

◆ Editor_InitInPoints()

override void Calcatz.Sequine.TweenPositionCommand.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.TransformTweenCommand.

◆ Editor_InitOutPoints()

override void Calcatz.Sequine.TweenPositionCommand.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.Sequine.TransformTweenCommand.

◆ Editor_OnDrawContents()

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

Called when a Command Node is drawn.

Parameters
_absPosition

Reimplemented from Calcatz.Sequine.TransformTweenCommand.

◆ Execute()

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

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

Parameters
_flow

Reimplemented from Calcatz.Sequine.TransformTweenCommand.

◆ GetOutput()

override OneOf< Vector3, Quaternion > Calcatz.Sequine.TweenPositionCommand.GetOutput ( CommandExecutionFlow  _flow,
int  _pointIndex 
)
virtual

◆ OnTweenUpdate()

override void Calcatz.Sequine.TweenPositionCommand.OnTweenUpdate ( float  _t)
protectedvirtual

Member Data Documentation

◆ endPosition

Vector3 Calcatz.Sequine.TweenPositionCommand.endPosition

◆ IN_PORT_POSITION

const int Calcatz.Sequine.TweenPositionCommand.IN_PORT_POSITION = 2
static

◆ OUT_PORT_POSITION

const int Calcatz.Sequine.TweenPositionCommand.OUT_PORT_POSITION = 2
static