Difference between revisions of "Component: Animator (Misc)"
From Flowcode Help
Jump to navigationJump to search (Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd |- | width="20%" style="color:gray;" | Version | 2.0 |- | width="20%" style="color:gray...") |
|||
| (10 intermediate revisions by the same user not shown) | |||
| Line 15: | Line 15: | ||
Basic animation and physics simulation for a single object. The target object can be set in motion by a simulation macro call, and will then continue in motion under the control of the animator. Boundaries can be set beyond which the object cannot move, and the behaviour of the object defined when it meets them. Simple simulation of gravity and friction are also possible. | Basic animation and physics simulation for a single object. The target object can be set in motion by a simulation macro call, and will then continue in motion under the control of the animator. Boundaries can be set beyond which the object cannot move, and the behaviour of the object defined when it meets them. Simple simulation of gravity and friction are also possible. | ||
| − | ==Component | + | ==Component Source Code== |
| − | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_animator.fcfx FC_Comp_Source_animator.fcfx] | |
| + | |||
| + | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_animator.fcfx FC_Comp_Source_animator.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 32: | Line 48: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| Line 46: | Line 76: | ||
[[File:Animator.jpg]] | [[File:Animator.jpg]] | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Macro reference== | ||
| + | |||
| + | ===SetSpeed=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| Line 109: | Line 137: | ||
| + | ===Stop=== | ||
| + | {| 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;" | '''Stop''' | ||
| + | |- | ||
| + | | colspan="2" | Stops the motion of the object - it will retain its position unless simulation is stopped with 'Return to Zero' selected. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| Line 138: | Line 178: | ||
|- | |- | ||
| colspan="2" | What to do when simulation stops. Freeze - the motion is paused. Position and speed are retained, simulation resumes with these settings. Return to Zero - the object returns to the start position, but its speed is remembered. Zero speed - the object keeps its final position, but the speed is set to zero. Return and Zero - the object retuirns to the start position, and speed is set to zero. | | colspan="2" | What to do when simulation stops. Freeze - the motion is paused. Position and speed are retained, simulation resumes with these settings. Return to Zero - the object returns to the start position, but its speed is remembered. Zero speed - the object keeps its final position, but the speed is set to zero. Return and Zero - the object retuirns to the start position, and speed is set to zero. | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Physics | ||
| + | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | ||
| Line 153: | Line 197: | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Bound X | ||
| + | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| Line 159: | Line 207: | ||
| colspan="2" | Set the behaviour when the object reaches minimum or maximum boundaries (set below unless "off") Off - no boundaries, the object can continue along this axis indefinitely. Stop - motion stops when the boundary is reached. Wrap - when 'min' is reached, the object re-appears at 'max', and vice versa. Bounce - the object reverses direction in this axis. | | colspan="2" | Set the behaviour when the object reaches minimum or maximum boundaries (set below unless "off") Off - no boundaries, the object can continue along this axis indefinitely. Stop - motion stops when the boundary is reached. Wrap - when 'min' is reached, the object re-appears at 'max', and vice versa. Bounce - the object reverses direction in this axis. | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] |
| − | | width="90%" | | + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Bound Y |
|- | |- | ||
| − | |||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| Line 169: | Line 216: | ||
| colspan="2" | Set the behaviour when the object reaches minimum or maximum boundaries (set below unless "off") Off - no boundaries, the object can continue along this axis indefinitely. Stop - motion stops when the boundary is reached. Wrap - when 'min' is reached, the object re-appears at 'max', and vice versa. Bounce - the object reverses direction in this axis. | | colspan="2" | Set the behaviour when the object reaches minimum or maximum boundaries (set below unless "off") Off - no boundaries, the object can continue along this axis indefinitely. Stop - motion stops when the boundary is reached. Wrap - when 'min' is reached, the object re-appears at 'max', and vice versa. Bounce - the object reverses direction in this axis. | ||
|- | |- | ||
| − | | width="10%" align="center" style="background-color:# | + | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] |
| − | | width="90%" style="background-color:# | + | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Bound Z |
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] |
| − | | width="90% | + | | width="90%" | Mode |
|- | |- | ||
| + | | colspan="2" | Set the behaviour when the object reaches minimum or maximum boundaries (set below unless "off") Off - no boundaries, the object can continue along this axis indefinitely. Stop - motion stops when the boundary is reached. Wrap - when 'min' is reached, the object re-appears at 'max', and vice versa. Bounce - the object reverses direction in this axis. | ||
|} | |} | ||
Latest revision as of 13:13, 7 February 2023
| Author | Matrix Ltd |
| Version | 2.0 |
| Category | Misc |
Contents
Animator component
Basic animation and physics simulation for a single object. The target object can be set in motion by a simulation macro call, and will then continue in motion under the control of the animator. Boundaries can be set beyond which the object cannot move, and the behaviour of the object defined when it meets them. Simple simulation of gravity and friction are also possible.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_animator.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_animator.fcfx
Detailed description
No detailed description exists yet for this component
Examples
Simple example showing how to use the animator component to simulate the movement of several panel items.
Animation
Macro reference
SetSpeed
|
SetSpeed |
| Set the linear and rotational velocity of the object. Motion continues without any further intervention, subject to the friction, gravity and boundary settings. | |
 - FLOAT
|
AlongX |
| Speed along the X-axis. World units per second. | |
| - FLOAT
|
AlongY |
| Speed along the Y-axis. World units per second. | |
| - FLOAT
|
AlongZ |
| Speed along the Z-axis. World units per second. | |
| - FLOAT
|
AroundX |
| Rotational speed around the X-axis. Degrees per second. | |
| - FLOAT
|
AroundY |
| Rotational speed around the Y-axis. Degrees per second. | |
| - FLOAT
|
AroundZ |
| Rotational speed around the Z-axis. Degrees per second. | |
| - FLOAT
|
Acceleration |
| Time in milliseconds to accelerate to the new speed.settings. | |
 - VOID
|
Return |
Stop
|
|
Stop |
| Stops the motion of the object - it will retain its position unless simulation is stopped with 'Return to Zero' selected. | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Target |
| The object that the animator is to move. | |
|
Axis |
| Reference frame for the axes of motion. Object - use the target's own axes e.g. a vehicle,which always moves in the direction it is pointing. World - use the world axes of the system panel - e.g. when using the 'gravity' setting. | |
|
Interval (ms) |
| The amount of time between frames in milliseconds. This does not change the speed of travel, only the regularity of screen updates. | |
|
|
On Stop |
| What to do when simulation stops. Freeze - the motion is paused. Position and speed are retained, simulation resumes with these settings. Return to Zero - the object returns to the start position, but its speed is remembered. Zero speed - the object keeps its final position, but the speed is set to zero. Return and Zero - the object retuirns to the start position, and speed is set to zero. | |
|
Physics |
|
Gravity |
| Simple simulation of accelleration due to gravity. Always acts along the negative X world axis ("down"). Range... 0.0 - no gravity. > 0 - a pul along the downward Z-axis. | |
|
|
Friction |
| Simple friction simulation. Once a steady state is reached after any SetSpeed macro, the velocities will exponentially decay away. 0.0...No friction, movements continue until stopped by macro or simulation end. 1.0...Infinite friction - object will stop dead as soon as SetSpeed acceleration is complete. | |
|
Collisions |
|
|
Bound X |
|
|
Mode |
| Set the behaviour when the object reaches minimum or maximum boundaries (set below unless "off") Off - no boundaries, the object can continue along this axis indefinitely. Stop - motion stops when the boundary is reached. Wrap - when 'min' is reached, the object re-appears at 'max', and vice versa. Bounce - the object reverses direction in this axis. | |
|
|
Bound Y |
|
|
Mode |
| Set the behaviour when the object reaches minimum or maximum boundaries (set below unless "off") Off - no boundaries, the object can continue along this axis indefinitely. Stop - motion stops when the boundary is reached. Wrap - when 'min' is reached, the object re-appears at 'max', and vice versa. Bounce - the object reverses direction in this axis. | |
|
|
Bound Z |
|
|
Mode |
| Set the behaviour when the object reaches minimum or maximum boundaries (set below unless "off") Off - no boundaries, the object can continue along this axis indefinitely. Stop - motion stops when the boundary is reached. Wrap - when 'min' is reached, the object re-appears at 'max', and vice versa. Bounce - the object reverses direction in this axis. | |
