API Panel.Position.Morph: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	Morph
Blends positions from two sources to a destination
- HANDLE	Dest
The position or component to update
- HANDLE	Start
The initial position at Step=0
- HANDLE	End
The final position at Step=1
- FLOAT	Step
A value from 0 to 1 for the position between Start and End
- BOOL	CurveArcs
True to curve movement if rotation is applied, false for linear movement
- NONE	Return

Detailed description

This call smoothly interpolates between two objects, storing the result in a third Dest position.

The Step may be any value and is not bounded by Flowcode, but typically lies within the range of 0 to 1. A value of 0 represents the position of Start and 1 represents End.

The Animate call performs this operation over a fixed time, selecting the Step from 0 to 1 appropriately then invoking this routine.

Examples

Calling in a calculation

Add to a calculation icon:

::Panel.Position.Morph(dest, start, end, step, false)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Blends positions from two sources to a destination
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''Morph'''
+|-
+| colspan="2" | Blends positions from two sources to a destination&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Dest
+|-
+| colspan="2" | The position or component to update&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Start
+|-
+| colspan="2" | The initial position at Step=0&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | End
+|-
+| colspan="2" | The final position at Step=1&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" | Step
+|-
+| colspan="2" | A value from 0 to 1 for the position between Start and End&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | CurveArcs
+|-
+| colspan="2" | True to curve movement if rotation is applied, false for linear movement&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API Panel|Panel]]
-:[[API Panel.Position|Position]]
-::[[API Panel.Position|Morph]]
-</div>
-__TOC__
-==Parameters==
+==Detailed description==
-[[Variable types|HANDLE]] ''Dest''
+This call smoothly interpolates between two objects, storing the result in a third ''Dest'' position.
-:The position or component to update
-[[Variable types|HANDLE]] ''Start''
-:The initial position at Step=0
-[[Variable types|HANDLE]] ''End''
+[[File:SIMAPI Panel.Position.Morph.svg|350px]]
-:The final position at Step=1
-[[Variable types|FLOAT]] ''Step''
-:A value from 0 to 1 for the position between Start and End
-==Return value==
+The ''Step'' may be any value and is not bounded by Flowcode, but typically lies within the range of 0 to 1. A value of 0 represents the position of ''Start'' and 1 represents ''End''.
-''This call does not return a value''
-==Detailed description==
+The [[API Panel.Position.Animate|Animate]] call performs this operation over a fixed time, selecting the ''Step'' from 0 to 1 appropriately then invoking this routine.
-''<span style="color:red;">No additional information</span>''
 ==Examples==
 ===Calling in a calculation===
-* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.Morph(dest, start, end, step)</pre>
+* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.Morph(dest, start, end, step, false)</pre>
-''<span style="color:red;">No additional information</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation