Jump to content

API Panel.Position.RotateTo: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import of API auto-gen
Admin (talk | contribs)
XML import
Line 2: Line 2:
Rotates the object to the given rotation
Rotates the object to the given rotation


<div style="width:25%; float:right" class="toc">
===Class hierarchy===
:Panel
::Position
:::RotateTo
</div>
__TOC__


===Parameters===
==Parameters==
''[[Variable types|HANDLE]] Handle''
''[[Variable types|HANDLE]] Handle''
:The position or component to update
:The position or component to update
Line 26: Line 33:
:''The default value for this parameter is: '''''0'''
:''The default value for this parameter is: '''''0'''


===Return value===
==Return value==
''This call does not return a value''
''This call does not return a value''


===Detailed description===
==Detailed description==
''No additional information''
''No additional information''


===Examples===
==Examples==
====Calling in a calculation====
===Calling in a calculation===
* Add to a calculation icon: <pre class="brush:[C]">::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>

Revision as of 16:09, 11 May 2013

<sidebar>API contents</sidebar> Rotates the object to the given rotation

Class hierarchy

Panel
Position
RotateTo

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)