Difference between revisions of "API Panel.Position.Morph"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
|||
| (13 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | Blends positions from two sources to a destination | + | |- |
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Morph''' | ||
| + | |- | ||
| + | | colspan="2" | Blends positions from two sources to a destination | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Dest | ||
| + | |- | ||
| + | | colspan="2" | The position or component to update | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Start | ||
| + | |- | ||
| + | | colspan="2" | The initial position at Step=0 | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | End | ||
| + | |- | ||
| + | | colspan="2" | The final position at Step=1 | ||
| + | |- | ||
| + | | 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 | ||
| + | |- | ||
| + | | 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 | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | == | + | ==Detailed description== |
| − | '' | + | This call smoothly interpolates between two objects, storing the result in a third ''Dest'' position. |
| − | |||
| − | + | [[File:SIMAPI Panel.Position.Morph.svg|350px]] | |
| − | |||
| − | |||
| − | |||
| − | '' | + | 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 [[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. | |
| − | '' | ||
| − | + | ||
| − | + | ==Examples== | |
| − | * Add to a calculation icon: ::Panel.Position.Morph(dest, start, end, step) | + | ===Calling in a calculation=== |
| + | * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.Morph(dest, start, end, step, false)</pre> | ||
Latest revision as of 11:54, 16 January 2023
|
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)
