Difference between revisions of "Component: Motion Helper (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 | 1.1 |- | width="20%" style="color:gray...")
 
 
(10 intermediate revisions by the same user not shown)
Line 15: Line 15:
 
Helper for building components which require simulation of constant motion. Linked objects can be issued speed and acceleration parameters, and will then be animated automatically until another command is issued. The helper can control motion for up to four objects simultaneously, all with their own discrete motion settings.  
 
Helper for building components which require simulation of constant motion. Linked objects can be issued speed and acceleration parameters, and will then be animated automatically until another command is issued. The helper can control motion for up to four objects simultaneously, all with their own discrete motion settings.  
  
−
==Component Pack==
+
==Component Source Code==
  
−
FREE
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Motion_Helper.fcfx FC_Comp_Source_Motion_Helper.fcfx]
 +
 
 +
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Motion_Helper.fcfx FC_Comp_Source_Motion_Helper.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
  
Line 32: Line 48:
  
 
==Examples==
 
==Examples==
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
  
Line 45: Line 75:
 
{{Fcfile|Motion.fcfx|Motion}}
 
{{Fcfile|Motion.fcfx|Motion}}
  
−
==Downloadable macro reference==
 
  
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
==Macro reference==
 +
 +
===RegisterTarget===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 80: Line 121:
  
  
 +
===SetAcceleration===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 103: Line 145:
  
  
 +
===SetSpeed===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 126: Line 169:
  
  
 +
===UnregisterAll===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UnregisterTarget'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UnregisterAll'''
 
|-
 
|-
−
| colspan="2" | Remove a target from the list of links. 
+
| colspan="2" | Totally clear the list of registered objects 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 
−
| width="90%" | Target
 
 
|-
 
|-
−
| colspan="2" | Handle of the object to remove 
 
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 144: Line 183:
  
  
 +
===UnregisterTarget===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UnregisterAll'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UnregisterTarget'''
 +
|-
 +
| colspan="2" | Remove a target from the list of links. 
 
|-
 
|-
−
| colspan="2" | Totally clear the list of registered objects 
 
 
|-
 
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Target
 +
|-
 +
| colspan="2" | Handle of the object to remove 
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
−
 
−
 
  
  
Line 176: Line 219:
 
|-
 
|-
 
| colspan="2" | Decide what action to take when simulation stops. No Action - Animation is paused, continues from this position when simulation restarts Return to start - all object returned to their start positions, current speed resumes on simulation start. Clear speeds - objects retain their position, but speed is set to zero. Return and clear - objects return to start position and have theri speed set to zero.  
 
| colspan="2" | Decide what action to take when simulation stops. No Action - Animation is paused, continues from this position when simulation restarts Return to start - all object returned to their start positions, current speed resumes on simulation start. Clear speeds - objects retain their position, but speed is set to zero. Return and clear - objects return to start position and have theri speed set to zero.  
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
 
−
|-
 
 
|}
 
|}

Latest revision as of 13:12, 7 February 2023

Author Matrix Ltd
Version 1.1
Category Misc


Motion Helper component

Helper for building components which require simulation of constant motion. Linked objects can be issued speed and acceleration parameters, and will then be animated automatically until another command is issued. The helper can control motion for up to four objects simultaneously, all with their own discrete motion settings.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_Motion_Helper.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_Motion_Helper.fcfx

Detailed description

No detailed description exists yet for this component

Examples

Example showing how to use the motion helper component to easily assign motion to items on the panel. FC6 Icon.png Motion






Macro reference

RegisterTarget

Fc9-comp-macro.png RegisterTarget
Add a new object to the list of objects which the motion helper is animating. Up to four objects can be animated by each Motion Helper.  
Fc9-h32-icon.png - HANDLE Target
Handle of the target to link to. 
Fc9-h32-icon.png - HANDLE AxisObject
Axis object for this definition 
Fc9-u8-icon.png - BYTE Axis
Axis to move along/around (0=X, 1=Y, 2=Z) 
Fc9-u8-icon.png - BYTE Type
Motion type (0=Rotary, 1=Linear) 
Fc9-void-icon.png - VOID Return


SetAcceleration

Fc9-comp-macro.png SetAcceleration
Sets the acceleration for the target object. This sets how quickly the object reaches its new speed following a call to SetSpeed. NB) The object must be one of those registered using RegisterTarget. 
Fc9-h32-icon.png - HANDLE Target
Handle of the object to set the acceleration for. 
Fc9-f32-icon.png - FLOAT Acceleration
Time in milliseconds to reach a new speed. 
Fc9-void-icon.png - VOID Return


SetSpeed

Fc9-comp-macro.png SetSpeed
Set a new target speed for this object. Will use the acceleration parameter to set how long it will take to reach the new speed. NB) The object must be one of those previously declared using RegisterTarget 
Fc9-h32-icon.png - HANDLE Target
Target object to set the speed for. 
Fc9-f32-icon.png - FLOAT Speed
Target speed. World units per second or degrees per second. 
Fc9-void-icon.png - VOID Return


UnregisterAll

Fc9-comp-macro.png UnregisterAll
Totally clear the list of registered objects 
Fc9-void-icon.png - VOID Return


UnregisterTarget

Fc9-comp-macro.png UnregisterTarget
Remove a target from the list of links. 
Fc9-h32-icon.png - HANDLE Target
Handle of the object to remove 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-21-icon.png Frame Interval
Time interval between animation frames. Does not affect the speed of motion, only the rate of screen updates. 
Fc9-type-16-icon.png On Stop
Decide what action to take when simulation stops. No Action - Animation is paused, continues from this position when simulation restarts Return to start - all object returned to their start positions, current speed resumes on simulation start. Clear speeds - objects retain their position, but speed is set to zero. Return and clear - objects return to start position and have theri speed set to zero.  
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Motion_Helper_(Misc)&oldid=38240"