Jump to content

API Panel.Position.Morph: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML import of API documentation
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{| class="mtx-class-macrotable wikitable"
 
|-
<sidebar>API Contents</sidebar>
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
Blends positions from two sources to a destination
| width="90%" class="mtx-class-macrohead" | '''Morph'''
 
|-
<div style="width:25%; float:right" class="toc">
| colspan="2" | Blends positions from two sources to a destination&nbsp;
====Class hierarchy====
|-
[[API Panel|Panel]]
|-
:[[API Panel.Position|Position]]
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
::[[API Panel.Position|Morph]]
| width="90%" | Dest
</div>
|-
__TOC__
| colspan="2" | The position or component to update&nbsp;
 
|-
==Parameters==
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
[[Variable Types|HANDLE]] ''Dest''
| width="90%" | Start
:The position or component to update
|-
 
| colspan="2" | The initial position at Step=0&nbsp;
[[Variable Types|HANDLE]] ''Start''
|-
:The initial position at Step=0
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 
| width="90%" | End
[[Variable Types|HANDLE]] ''End''
|-
:The final position at Step=1
| colspan="2" | The final position at Step=1&nbsp;
 
|-
[[Variable Types|FLOAT]] ''Step''
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
:A value from 0 to 1 for the position between Start and End
| width="90%" | Step
 
|-
[[Variable Types|BOOL]] ''CurveArcs''
| colspan="2" | A value from 0 to 1 for the position between Start and End&nbsp;
:True to curve movement if rotation is applied, false for linear movement
|-
:''The default value for this parameter is: '''''1'''
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 
| width="90%" | CurveArcs
 
|-
==Return value==
| colspan="2" | True to curve movement if rotation is applied, false for linear movement&nbsp;
''This call does not return a value''
|-
| 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''
|}




Line 49: Line 52:
===Calling in a calculation===
===Calling in a calculation===
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.Morph(dest, start, end, step, false)</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 examples</span>''

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)