API Panel.Position.RotateAlong - Revision history

Wiki bot at 11:54, 16 January 2023

2023-01-16T11:54:50Z

Wiki bot at 11:41, 16 January 2023

2023-01-16T11:41:23Z

JonnyW: XML import

2014-01-16T15:57:55Z

XML import

ReeceL at 13:57, 12 September 2013

2013-09-12T13:57:00Z

JonnyW: XML import of API documentation

2013-08-09T14:27:29Z

XML import of API documentation

JonnyW: XML import of updated API docs

2013-06-17T09:58:04Z

XML import of updated API docs

JonnyW at 22:21, 15 June 2013

2013-06-15T22:21:37Z

JonnyW: XML Import to change Variable types into Variable Types

2013-06-10T11:09:10Z

XML Import to change Variable types into Variable Types

ReeceL at 09:33, 7 June 2013

2013-06-07T09:33:27Z

JonnyW: /* Detailed description */

2013-05-22T22:29:54Z

Detailed description

← Older revision		Revision as of 11:54, 16 January 2023
Line 60:		Line 60:
	===Calling in a calculation===		===Calling in a calculation===
	* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.RotateAlong(handle, pivot, axis, x_pitch, y_yaw, z_roll)</pre>		* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.RotateAlong(handle, pivot, axis, x_pitch, y_yaw, z_roll)</pre>
−
−	~~''<span style="color:red;">No additional examples</span>''~~

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Rotates the object by the given rotation along an 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;" | '''RotateAlong'''
-====Class hierarchy====
+|-
-[[API Panel|Panel]]
+| colspan="2" | Rotates the object by the given rotation along an axis&nbsp;
-:[[API Panel.Position|Position]]
+|-
-::[[API Panel.Position|RotateAlong]]
+|-
-</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%" | Pivot
+|-
-[[Variable Types|HANDLE]] ''Pivot''
+| colspan="2" | The coordinates of the rotation center&nbsp;
-:The coordinates of the rotation center
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-[[Variable Types|HANDLE]] ''Axis''
+| width="90%" | Axis
-:An axis to align the angles to
+|-
+| colspan="2" | An axis to align the angles to&nbsp;
-[[Variable Types|FLOAT]] ''X_Pitch''
+|-
-:The local X degrees to increment by
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
-:''The default value for this parameter is: '''''0'''
+| width="90%" | X_Pitch
+|-
-[[Variable Types|FLOAT]] ''Y_Yaw''
+| colspan="2" | The local X degrees to increment by&nbsp;
-:The local Y degrees to increment by
+|-
-:''The default value for this parameter is: '''''0'''
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" | Y_Yaw
-[[Variable Types|FLOAT]] ''Z_Roll''
+|-
-:The local Z degrees to increment by
+| colspan="2" | The local Y degrees to increment by&nbsp;
-:''The default value for this parameter is: '''''0'''
+|-
+| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+| width="90%" | Z_Roll
-==Return value==
+|-
-''This call does not return a value''
+| colspan="2" | The local Z degrees to increment by&nbsp;

← Older revision		Revision as of 15:57, 16 January 2014
Line 1:		Line 1:
−
−
	<sidebar>API Contents</sidebar>		<sidebar>API Contents</sidebar>
	Rotates the object by the given rotation along an axis		Rotates the object by the given rotation along an axis

@@ Line 44: / Line 44: @@
 The rotation calls allow an object to be [[Object Rotation|rotated]] around any point in any axis.
-The ''Handle'' must be a valid handle to a component or [[Position Object|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 [[Object Position|position]], or a quoted (string) name of an object that can be selected on the panel.
 An object can rotate around it's own '''axis''', or around the axis of another object's axis(x,y,x). An axis is the direction an object is facing.

← 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 by the given rotation along an axis		Rotates the object by the given rotation along an axis

@@ Line 1: / Line 1: @@
 <sidebar>API contents</sidebar>
 Rotates the object by the given rotation along an axis
@@ Line 57: / Line 59: @@
 * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.RotateAlong(handle, pivot, axis, x_pitch, y_yaw, z_roll)</pre>
-''<span style="color:red;">No additional information</span>''
+''<span style="color:red;">No additional examples</span>''

@@ Line 42: / Line 42: @@
 The rotation calls allow an object to be [[Object Rotation|rotated]] around any point in any axis.
-The '''Handle''' must be a valid handle to a component or [[Position Object|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 Object|position]], or a quoted (string) name of an object that can be selected on the panel.
 An object can rotate around it's own '''axis''', or around the axis of another object's axis(x,y,x). An axis is the direction an object is facing.
-The '''Pivot''' is an optional component or 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 ''Pivot'' is a component or 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 ''Pivot'' is zero the object rotates around its own center.
 ==Examples==

@@ Line 40: / Line 40: @@
 ==Detailed description==
 [[File:SIMAPI_Panel_Position_Rotate_Pic1.png|thumb|200px|right|Rotation around X]]
-The rotation calls allow an object to be [[Object rotation|rotated]] around any point in any axis.
+The rotation calls allow an object to be [[Object Rotation|rotated]] around any point in any axis.
 The '''Handle''' must be a valid handle to a component or [[Position Object|position]], or a quoted (string) name of an object that can be selected on the panel.