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

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
 
(19 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
API contents
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Moves the object by the given offset relative to its parent along an axis
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MoveAlong'''
 +
|-
 +
| colspan="2" | Moves the object by the given offset relative to its parent along an axis 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Handle
 +
|-
 +
| colspan="2" | The position or component to update 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Axis
 +
|-
 +
| colspan="2" | A position or component representing the X,Y,Z axis to move in 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | X
 +
|-
 +
| colspan="2" | Local coordinate X to increment by 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Y
 +
|-
 +
| colspan="2" | Local coordinate Y to increment by 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Z
 +
|-
 +
| colspan="2" | Local coordinate Z to increment by 
 +
|-
 +
| 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''
 +
|}
  
  
−
===Parameters===
+
==Detailed description==
−
''[[Variable types|HANDLE]] Handle''
+
This adjusts the ''Handle'' position by moving it along the specified ''Axis'' a number of units in the X, Y and Z directions.
−
:The position or component to update
 
−
:''The default value for this parameter is: '''''this'''
 
  
−
''[[Variable types|HANDLE]] Axis''
 
−
:A position or component representing the X,Y,Z axis to move in
 
  
−
''[[Variable types|FLOAT]] X''
+
If the ''Axis'' is zero then world space is assumed. Under typical usage 'this' would be a common axis, representing the object space of the component.
−
:Local coordinate X to increment by
 
−
:''The default value for this parameter is: '''''0'''
 
  
−
''[[Variable types|FLOAT]] Y''
 
−
:Local coordinate Y to increment by
 
−
:''The default value for this parameter is: '''''0'''
 
  
−
''[[Variable types|FLOAT]] Z''
+
==Examples==
−
:Local coordinate Z to increment by
+
===Calling in a calculation===
−
:''The default value for this parameter is: '''''0'''
+
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.MoveAlong(handle, axis, x, y, z)</pre>
  
−
===Return value===
 
−
''This call does not return a value''
 
  
−
===Detailed description===
+
===Flowcode example file===
−
''No additional information''
+
Download {{Fcfile|SIMAPI_Panel_Position_MoveAlong.fcfx|SIMAPI_Panel_Position_MoveAlong}} and open it in Flowcode v6. In this example, there are three cubiods that represent Axis X,Y,Z. Note they are coloured exactly as the panel axis indicator which represents your viewing position. There is a sphere also on the panel. The sphere moves first along the X-Axis 100 units then back to it's original position, then does the same for the Y and Z axis. Note - to see the sphere moving along the Z axis you will need to turn on perspective or change the viewing plane with via the panel axis indicator.
  
−
===Examples===
+
The screenshots below show the effect and also highlight the code used by the example.
−
====Calling in a calculation====
+
 
−
* Add to a calculation icon: ::Panel.Position.MoveAlong(handle, axis, x, y, z)
+
[[File:SIMAPI_Panel_Position_MoveAlong_Pic1.png]][[File:SIMAPI_Panel_Position_MoveAlong_Pic2.png]][[File:SIMAPI_Panel_Position_MoveAlong_Pic3.png]][[File:SIMAPI_Panel_Position_MoveAlong_Pic4.png]]
 +
 
 +
[[File:SIMAPI_Panel_Position_MoveAlong_Pic0.png]]

Latest revision as of 11:41, 16 January 2023

Fc9-comp-macro.png MoveAlong
Moves the object by the given offset relative to its parent along an axis 
Fc9-h32-icon.png - HANDLE Handle
The position or component to update 
Fc9-h32-icon.png - HANDLE Axis
A position or component representing the X,Y,Z axis to move in 
Fc9-f32-icon.png - FLOAT X
Local coordinate X to increment by 
Fc9-f32-icon.png - FLOAT Y
Local coordinate Y to increment by 
Fc9-f32-icon.png - FLOAT Z
Local coordinate Z to increment by 
Fc9-void-icon.png - NONE Return


Detailed description

This adjusts the Handle position by moving it along the specified Axis a number of units in the X, Y and Z directions.


If the Axis is zero then world space is assumed. Under typical usage 'this' would be a common axis, representing the object space of the component.


Examples

Calling in a calculation

  • Add to a calculation icon: 
    ::Panel.Position.MoveAlong(handle, axis, x, y, z)


Flowcode example file

Download FC6 Icon.png SIMAPI_Panel_Position_MoveAlong and open it in Flowcode v6. In this example, there are three cubiods that represent Axis X,Y,Z. Note they are coloured exactly as the panel axis indicator which represents your viewing position. There is a sphere also on the panel. The sphere moves first along the X-Axis 100 units then back to it's original position, then does the same for the Y and Z axis. Note - to see the sphere moving along the Z axis you will need to turn on perspective or change the viewing plane with via the panel axis indicator.

The screenshots below show the effect and also highlight the code used by the example.

SIMAPI Panel Position MoveAlong Pic1.pngSIMAPI Panel Position MoveAlong Pic2.pngSIMAPI Panel Position MoveAlong Pic3.pngSIMAPI Panel Position MoveAlong Pic4.png

SIMAPI Panel Position MoveAlong Pic0.png

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Panel.Position.MoveAlong&oldid=29789"