API Panel.Position.RotateTo: Difference between revisions
XML import |
XML import |
||
| Line 3: | Line 3: | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
===Class hierarchy===[[API Panel|Panel]] | ====Class hierarchy==== | ||
[[API Panel|Panel]] | |||
:[[API Panel.Position|Position]] | :[[API Panel.Position|Position]] | ||
::[[API Panel.Position|RotateTo]] | ::[[API Panel.Position|RotateTo]] | ||
| Line 10: | Line 11: | ||
==Parameters== | ==Parameters== | ||
[[Variable types|HANDLE]] ''Handle'' | |||
:The position or component to update | :The position or component to update | ||
:''The default value for this parameter is: '''''this''' | :''The default value for this parameter is: '''''this''' | ||
[[Variable types|HANDLE]] ''Pivot'' | |||
:The coordinates of the rotation center, Handle if zero | :The coordinates of the rotation center, Handle if zero | ||
[[Variable types|HANDLE]] ''Axis'' | |||
:An axis to align the angles to, Handle if zero | :An axis to align the angles to, Handle if zero | ||
[[Variable types|FLOAT]] ''X_Pitch'' | |||
:The absolute local X degrees to update with | :The absolute local X degrees to update with | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
[[Variable types|FLOAT]] ''Y_Yaw'' | |||
:The absolute local Y degrees to update with | :The absolute local Y degrees to update with | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
[[Variable types|FLOAT]] ''Z_Roll'' | |||
:The absolute local Z degrees to update with | :The absolute local Z degrees to update with | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
| Line 36: | Line 37: | ||
==Detailed description== | ==Detailed description== | ||
''No additional information'' | ''<span style="color:red;">No additional information</span>'' | ||
==Examples== | ==Examples== | ||
===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 information</span>'' | |||
Revision as of 22:08, 11 May 2013
<sidebar>API contents</sidebar> Rotates the object to the given rotation
Parameters
HANDLE Handle
- The position or component to update
- The default value for this parameter is: this
HANDLE Pivot
- The coordinates of the rotation center, Handle if zero
HANDLE Axis
- An axis to align the angles to, Handle if zero
FLOAT X_Pitch
- The absolute local X degrees to update with
- The default value for this parameter is: 0
FLOAT Y_Yaw
- The absolute local Y degrees to update with
- The default value for this parameter is: 0
FLOAT Z_Roll
- The absolute local Z degrees to update with
- The default value for this parameter is: 0
Return value
This call does not return a value
Detailed description
No additional information
Examples
Calling in a calculation
- Add to a calculation icon:
::Panel.Position.RotateTo(handle, pivot, axis, x_pitch, y_yaw, z_roll)
No additional information