API Panel.Position.RotateAlong: Difference between revisions

Revision as of 16:09, 11 May 2013

<sidebar>API contents</sidebar> Rotates the object by the given rotation along an axis

Panel

Position

RotateAlong

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 Axis

An axis to align the angles to

FLOAT X_Pitch

The local X degrees to increment by

The default value for this parameter is: 0

FLOAT Y_Yaw

The local Y degrees to increment by

The default value for this parameter is: 0

FLOAT Z_Roll

The local Z degrees to increment by

The default value for this parameter is: 0

This call does not return a value

No additional information

Add to a calculation icon:

::Panel.Position.RotateAlong(handle, pivot, axis, x_pitch, y_yaw, z_roll)

@@ Line 2: / Line 2: @@
 Rotates the object by the given rotation along an axis
+<div style="width:25%; float:right" class="toc">
+===Class hierarchy===
+:Panel
+::Position
+:::RotateAlong
+</div>
+__TOC__
-===Parameters===
+==Parameters==
 ''[[Variable types|HANDLE]] Handle''
 :The position or component to update
@@ Line 26: / Line 33: @@
 :''The default value for this parameter is: '''''0'''
-===Return value===
+==Return value==
 ''This call does not return a value''
-===Detailed description===
+==Detailed description==
 ''No additional information''
-===Examples===
+==Examples==
-====Calling in a calculation====
+===Calling in a calculation===
-* Add to a calculation icon: <pre class="brush:[C]">::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>