Difference between revisions of "API Panel.Position.Animate"

From Flowcode Help
Jump to navigationJump to search
(XML import of API documentation)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
+
|-
<sidebar>API Contents</sidebar>
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
Blends positions from two sources to a destination over time
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Animate'''
 
+
|-
<div style="width:25%; float:right" class="toc">
+
| colspan="2" | Blends positions from two sources to a destination over time&nbsp;
====Class hierarchy====
+
|-
[[API Panel|Panel]]
+
|-
:[[API Panel.Position|Position]]
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
::[[API Panel.Position|Animate]]
+
| 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 of the animation&nbsp;
[[Variable Types|HANDLE]] ''Start''
+
|-
:The initial position of the animation
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 
+
| width="90%" | End
[[Variable Types|HANDLE]] ''End''
+
|-
:The final position of the animation
+
| colspan="2" | The final position of the animation&nbsp;
 
+
|-
[[Variable Types|UINT]] ''Millisecs''
+
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
:Time to take to perform the animation
+
| width="90%" | Millisecs
:''The default value for this parameter is: '''''1000'''
+
|-
 
+
| colspan="2" | Time to take to perform the animation&nbsp;
 
+
|-
==Return value==
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
''This call does not return a value''
+
| 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>
 
''<span style="color:red;">No additional examples</span>''
 

Latest revision as of 11:54, 16 January 2023

Fc9-comp-macro.png Animate
Blends positions from two sources to a destination over time 
Fc9-h32-icon.png - HANDLE Dest
The position or component to update 
Fc9-h32-icon.png - HANDLE Start
The initial position of the animation 
Fc9-h32-icon.png - HANDLE End
The final position of the animation 
Fc9-u16-icon.png - UINT Millisecs
Time to take to perform the animation 
Fc9-void-icon.png - 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.

Interpolation from 0 to 1


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)