API Panel.Position.RotateX - Revision history

Wiki bot at 11:41, 16 January 2023

2023-01-16T11:41:24Z

JonnyW: XML import

2014-01-16T15:57:55Z

XML import

ReeceL at 13:31, 20 September 2013

2013-09-20T13:31:58Z

JonnyW: XML import of API documentation

2013-08-09T14:27:29Z

XML import of API documentation

JonnyW at 22:15, 15 June 2013

2013-06-15T22:15:25Z

JonnyW: XML Import to change Variable types into Variable Types

2013-06-10T11:09:11Z

XML Import to change Variable types into Variable Types

ReeceL at 09:36, 7 June 2013

2013-06-07T09:36:33Z

ReeceL at 09:28, 7 June 2013

2013-06-07T09:28:24Z

JonnyW: /* Detailed description */

2013-05-22T22:26:28Z

Detailed description

JonnyW: /* Detailed description */

2013-05-22T22:21:40Z

Detailed description

@@ 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 1: / Line 1: @@
 <sidebar>API Contents</sidebar>
 Rotates the object around the X axis
@@ Line 58: / Line 56: @@
 ===Flowcode example file===
-Download [[File:SIMAPI_Panel_Position_RotateX_v1.fcfx]] 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.fcfx]] 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.

@@ Line 58: / Line 58: @@
 ===Flowcode example file===
-Download [[File:SIMAPI_Panel_Position_RotateX_v1.fcf]] and open it in Flowcode v6.
+Download [[File:SIMAPI_Panel_Position_RotateX_v1.fcfx]] 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 [[File:SIMAPI Panel Position RotateXYZ.fcfx]] rotates a grouped object around its X, Y, and Z axis.

← Older revision		Revision as of 14:27, 9 August 2013
Line 1:		Line 1:
−	<sidebar>API ~~contents~~</sidebar>	+
		+
		+	<sidebar>API Contents</sidebar>
	Rotates the object around the X axis		Rotates the object around the X axis

@@ Line 32: / Line 32: @@
 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.

@@ Line 30: / Line 30: @@
 ==Detailed description==
 [[file:SIMAPI_Panel_Position_Rotate_Pic1.png|375px|right]]
-The rotation call allows an object to be [[Object rotation|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 rotation call allows an object to be [[Object Rotation|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.

@@ Line 49: / Line 49: @@
 ===See also===
-[[Object rotation]]
+[[Object Rotation]]
-[[Local and world space]]
+[[Local and World Space]]
 ==Examples==

@@ Line 38: / Line 38: @@
 If the Pivot is zero the object rotates around its own center.
-The '''axis''' is the alignment to rotate around. Specifying zero will cause the object to rotate around its own axis.
+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.