Difference between revisions of "API Panel.Position.RotateAlong"

From Flowcode Help
Jump to navigationJump to search
(XML import API auto-gen)
(XML import of API auto-gen)
Line 34: Line 34:
 
===Examples===
 
===Examples===
 
====Calling in a calculation====
 
====Calling in a calculation====
* Add to a calculation icon: ::Panel.Position.RotateAlong(handle, pivot, axis, x_pitch, y_yaw, z_roll)
+
* Add to a calculation icon: <pre class="brush:[C]">::Panel.Position.RotateAlong(handle, pivot, axis, x_pitch, y_yaw, z_roll)</pre>

Revision as of 15:35, 10 May 2013

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


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 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

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.RotateAlong(handle, pivot, axis, x_pitch, y_yaw, z_roll)