API Panel.Position.RotateTo - 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

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:13, 15 June 2013

2013-06-15T22:13:59Z

JonnyW at 22:09, 15 June 2013

2013-06-15T22:09:26Z

JonnyW: XML Import to change Variable types into Variable Types

2013-06-10T11:09:11Z

XML Import to change Variable types into Variable Types

Admin: XML import

2013-05-12T21:51:52Z

XML import

Admin: XML import

2013-05-12T01:52:41Z

XML import

← Older revision		Revision as of 11:54, 16 January 2023
Line 61:		Line 61:
	===Calling in a calculation===		===Calling in a calculation===
	* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.RotateTo(handle, pivot, axis, x_pitch, y_yaw, z_roll)</pre>		* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.RotateTo(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 to the given rotation
+|-
+| 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;" | '''RotateTo'''
-====Class hierarchy====
+|-
-[[API Panel|Panel]]
+| colspan="2" | Rotates the object to the given rotation&nbsp;
-:[[API Panel.Position|Position]]
+|-
-::[[API Panel.Position|RotateTo]]
+|-
-</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, Handle if zero&nbsp;
-:The coordinates of the rotation center, Handle if zero
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-[[Variable Types|HANDLE]] ''Axis''
+| width="90%" | Axis
-:An axis to align the angles to, Handle if zero
+|-
+| colspan="2" | An axis to align the angles to, Handle if zero&nbsp;
-[[Variable Types|FLOAT]] ''X_Pitch''
+|-
-:The absolute local X degrees to update with
+| 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 absolute local X degrees to update with&nbsp;
-:The absolute local Y degrees to update with
+|-
-:''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 absolute local Z degrees to update with
+| colspan="2" | The absolute local Y degrees to update with&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 absolute local Z degrees to update with&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 to the given rotation		Rotates the object to the given rotation

← 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 to the given rotation		Rotates the object to the given rotation

@@ Line 1: / Line 1: @@
 <sidebar>API contents</sidebar>
 Rotates the object to the given rotation
@@ Line 58: / Line 60: @@
 * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.Position.RotateTo(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>''

← Older revision		Revision as of 22:13, 15 June 2013
Line 45:		Line 45:


−	If ''Pivot'' or ''Axis'' are zero, world-space ~~is assumed~~. It is advised not to use world-space in a component that is exported, use ''this'' as the coordinate space instead.	+	If ''Pivot'' or ''Axis'' are zero, that parameter is ignored. This is in contrast with most Position calls that treat zero as world-space. It is advised not to use world-space in a component that is exported, use ''this'' as the coordinate space instead.

← Older revision		Revision as of 22:09, 15 June 2013
Line 39:		Line 39:

	==Detailed description==		==Detailed description==
−	''~~<span style="color:red;">No additional information</span>~~''	+	This rotates an object to the exact orientation specified. The orientation is represented as [[Object Rotation\|Euler angles]]. This is typically useful for setting to an exact angle, but is not recommended for incremental changes - Euler angles suffer from ''gimbal lock'' and it can be difficult to maintain an absolute values through incremental changes.
		+
		+
		+	For an incremental change, use [[API Panel.Position.RotateAlong\|RotateAlong]].
		+
		+
		+	If ''Pivot'' or ''Axis'' are zero, world-space is assumed. It is advised not to use world-space in a component that is exported, use ''this'' as the coordinate space instead.
		+
		+
		+	Note that a common mistake is to set the orientation to (0, 0, 0) to reset the ''Handle'' back to its original position. Where as this will work for objects that are originally aligned to the specified axis, this will not work for objects whose initial position is off axis. To reliably restore the orientation of an object, the original position should be read and stored with a call to [[API Panel.Position.Get\|Get]] and the orientation restored using [[API Panel.Position.SetRotation\|SetRotation]].
		+
		+
		+	Note another common mistake is to set the angle relative to the object being rotated. Specifying the same ''Axis'' as ''Handle'' will cause the object to be rotated relative to itself, which may have unexpected results.