API Panel.Position.Animate: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	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)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Blends positions from two sources to a destination over time
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" class="mtx-class-macrohead" | '''Animate'''
-====Class hierarchy====
+|-
-[[API Panel|Panel]]
+| colspan="2" | Blends positions from two sources to a destination over time&nbsp;
-:[[API Panel.Position|Position]]
+|-
-::[[API Panel.Position|Animate]]
+|-
-</div>
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-__TOC__
+| width="90%" | Dest
+|-
-==Parameters==
+| colspan="2" | The position or component to update&nbsp;
-[[Variable Types|HANDLE]] ''Dest''
+|-
-:The position or component to update
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Start
-[[Variable Types|HANDLE]] ''Start''
+|-
-:The initial position of the animation
+| colspan="2" | The initial position of the animation&nbsp;
+|-
-[[Variable Types|HANDLE]] ''End''
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-:The final position of the animation
+| width="90%" | End
+|-
-[[Variable Types|UINT]] ''Millisecs''
+| colspan="2" | The final position of the animation&nbsp;
-:Time to take to perform the animation
+|-
-:''The default value for this parameter is: '''''1000'''
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | Millisecs
+|-
-==Return value==
+| colspan="2" | Time to take to perform the animation&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 44: / Line 47: @@
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.Animate(dest, start, end, millisecs)</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