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

From Flowcode Help
Jump to navigationJump to search
(XML Import to change Variable types into Variable Types)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Rotates the object around the X axis
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
<div style="width:25%; float:right" class="toc">
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RotateX'''
−
====Class hierarchy====
+
|-
−
[[API Panel|Panel]]
+
| colspan="2" | Rotates the object around the X axis&nbsp;
−
:[[API Panel.Position|Position]]
+
|-
−
::[[API Panel.Position|RotateX]]
+
|-
−
</div>
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
−
__TOC__
+
| width="90%" | Handle
−
 
+
|-
−
==Parameters==
+
| colspan="2" | The position or component to update&nbsp;
−
[[Variable Types|HANDLE]] ''Handle''
+
|-
−
:The position or component to update
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
−
:''The default value for this parameter is: '''''this'''
+
| width="90%" | PivotHandle
−
 
+
|-
−
[[Variable Types|HANDLE]] ''PivotHandle''
+
| colspan="2" | An optional position to treat as the origin to rotate around&nbsp;
−
:An optional position to treat as the origin to rotate around
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
−
[[Variable Types|FLOAT]] ''Degrees''
+
| width="90%" | Degrees
−
:Number of degrees to rotate by
+
|-
−
 
+
| colspan="2" | Number of degrees to rotate by&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 32: Line 33:
 
The handle must be a valid handle to a component or position, or a quoted (string) name of an object that can be selected on the panel.
 
The handle must be a valid handle to a component or position, or a quoted (string) name of an object that can be selected on the panel.
  
−
The '''PivotHandle''' is an optional position to rotate around. The object will adjust its angle as though it is sliding around the edge of a circle, so at 180 degrees the object will appear 'upside-down' in the same way as a human walking around the globe from the north to south pole.
+
The ''PivotHandle'' is an optional position to rotate around. The object will adjust its angle as though it is sliding around the edge of a circle, so at 180 degrees the object will appear 'upside-down' in the same way as a human walking around the globe from the north to south pole.
  
−
If the Pivot is zero the object rotates around its own center.
+
If the ''PivotHandle'' is zero the object rotates around its own center.
  
 
The image to the right shows a cube with it's axis positions identified.  
 
The image to the right shows a cube with it's axis positions identified.  
Line 56: Line 57:
  
 
===Flowcode example file===
 
===Flowcode example file===
−
Download [[File:SIMAPI_Panel_Position_RotateX_v1.fcf]] and open it in Flowcode v6.
+
Download {{Fcfile|SIMAPI_Panel_Position_RotateX_v1.fcfx|SIMAPI_Panel_Position_RotateX_v1}} and open it in Flowcode v6.
  
−
The sample file [[File:SIMAPI Panel Position RotateXYZ.fcf]] rotates a grouped object around its X, Y, and Z axis.
+
The sample file {{Fcfile|SIMAPI Panel Position RotateXYZ.fcfx|SIMAPI Panel Position RotateXYZ}} rotates a grouped object around its X, Y, and Z axis.

Latest revision as of 11:41, 16 January 2023

Fc9-comp-macro.png RotateX
Rotates the object around the X axis 
Fc9-h32-icon.png - HANDLE Handle
The position or component to update 
Fc9-h32-icon.png - HANDLE PivotHandle
An optional position to treat as the origin to rotate around 
Fc9-f32-icon.png - FLOAT Degrees
Number of degrees to rotate by 
Fc9-void-icon.png - NONE Return


Detailed description

SIMAPI Panel Position Rotate Pic1.png

The rotation call allows an object to be rotated around any point in the target objects local X axis. This has the effect of altering the pitch of the object - in terms of an aeroplane this makes the plane climb or bank.

The handle must be a valid handle to a component or position, or a quoted (string) name of an object that can be selected on the panel.

The PivotHandle is an optional position to rotate around. The object will adjust its angle as though it is sliding around the edge of a circle, so at 180 degrees the object will appear 'upside-down' in the same way as a human walking around the globe from the north to south pole.

If the PivotHandle is zero the object rotates around its own center.

The image to the right shows a cube with it's axis positions identified.

Calling the simulation api Panel.Position.RotateX(MyCube,MyCube,1) will rotate the object in one-degree steps along it's X-axis as shown by the red rotation arc. To rotate the cube in a counter direction simply specify a negative number for the degrees parameter.

The screenshot from Flowcode v6 below shows a cuboid with it's internal axis shown (red is the X-axis line), and also a circle that cuts right through the cuboid's X-axis (see example section below for links to the file) When the program runs the cuboid rotates along it's X axis. Note also incidentally the cuboids axis is also the same as the world axis but this might not always be the case.

SIMAPI Panel Position Rotate Pic2.png


See also

Object Rotation

Local and World Space

Examples

Calling in a calculation

  • Add to a calculation icon: 
    ::Panel.Position.RotateX(handle, pivothandle, degrees)

Flowcode example file

Download FC6 Icon.png SIMAPI_Panel_Position_RotateX_v1 and open it in Flowcode v6.

The sample file FC6 Icon.png SIMAPI Panel Position RotateXYZ rotates a grouped object around its X, Y, and Z axis.

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