Difference between revisions of "API Panel.Position.Morph"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Blends positions from two sources to a destination | Blends positions from two sources to a destination | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ====Class hierarchy==== | ||
| + | [[API Panel|Panel]] | ||
| + | :[[API Panel.Position|Position]] | ||
| + | ::[[API Panel.Position|Morph]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|HANDLE]] ''Dest'' | |
:The position or component to update | :The position or component to update | ||
| − | + | [[Variable Types|HANDLE]] ''Start'' | |
:The initial position at Step=0 | :The initial position at Step=0 | ||
| − | + | [[Variable Types|HANDLE]] ''End'' | |
:The final position at Step=1 | :The final position at Step=1 | ||
| − | + | [[Variable Types|FLOAT]] ''Step'' | |
:A value from 0 to 1 for the position between Start and End | :A value from 0 to 1 for the position between Start and End | ||
| − | + | [[Variable Types|BOOL]] ''CurveArcs'' | |
| + | :True to curve movement if rotation is applied, false for linear movement | ||
| + | :''The default value for this parameter is: '''''1''' | ||
| + | |||
| + | |||
| + | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
| − | |||
| − | |||
| − | ===Examples | + | ==Detailed description== |
| − | + | This call smoothly interpolates between two objects, storing the result in a third ''Dest'' position. | |
| − | * Add to a calculation icon: <pre class="brush:[ | + | |
| + | [[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== | ||
| + | ===Calling in a calculation=== | ||
| + | * 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 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Blends positions from two sources to a destination
Contents
Parameters
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
- The default value for this parameter is: 1
Return value
This call does not return a value
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)
No additional examples
