API Panel.Position.Animate: Difference between revisions
XML import of API documentation |
No edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |||
|- | |||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Animate''' | |||
|- | |||
| colspan="2" | Blends positions from two sources to a destination over time | |||
=== | |- | ||
[[ | |- | ||
: | | 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 of the animation | |||
[[ | |- | ||
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | |||
| width="90%" | End | |||
[[ | |- | ||
| colspan="2" | The final position of the animation | |||
|- | |||
[[ | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | ||
| width="90%" | Millisecs | |||
: | |- | ||
| colspan="2" | Time to take to perform the animation | |||
|- | |||
== | | 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 46: | Line 47: | ||
===Calling in a calculation=== | ===Calling in a calculation=== | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.Animate(dest, start, end, millisecs)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.Animate(dest, start, end, millisecs)</pre> | ||
Latest revision as of 11:54, 16 January 2023
|
Animate |
| Blends positions from two sources to a destination over time | |
 - HANDLE
|
Dest |
| The position or component to update | |
| - HANDLE
|
Start |
| The initial position of the animation | |
| - HANDLE
|
End |
| The final position of the animation | |
 - UINT
|
Millisecs |
| Time to take to perform the animation | |
 - NONE
|
Return |
Detailed description
This call animates between two objects, storing the result in a third Dest position. It performs the operation in the background over a specified time.
The closely related Morph call performs this operation allowing for any point on the scale to be stepped to, but it must be called manually by the user to perform an animation.
Animations can be stopped using StopAnimate
Examples
Calling in a calculation
- Add to a calculation icon:
::Panel.Position.Animate(dest, start, end, millisecs)