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

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML Import to change Variable types into Variable Types)
Line 11: Line 11:
  
 
==Parameters==
 
==Parameters==
[[Variable types|HANDLE]] ''Handle''
+
[[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''
+
[[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''
+
[[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''
+
[[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''
+
[[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''
+
[[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'''

Revision as of 11:09, 10 June 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)

No additional information