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

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
 
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
Returns the positions euler angles in {P,Y,R} array
+
Returns the positions euler angles in (P,Y,R) array
  
 
<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|GetEuler]]
 
::[[API Panel.Position|GetEuler]]
Line 10: Line 11:
  
 
==Parameters==
 
==Parameters==
''[[Variable types|HANDLE]] Handle''
+
[[Variable Types|HANDLE]] ''Handle''
 
:The position or component to read
 
:The position or component to read
 
:''The default value for this parameter is: '''''this'''
 
:''The default value for this parameter is: '''''this'''
  
''[[Variable types|HANDLE]] Target''
+
[[Variable Types|HANDLE]] ''Target''
 
:The position or component to convert relative to
 
:The position or component to convert relative to
 
:''The default value for this parameter is: '''''this'''
 
:''The default value for this parameter is: '''''this'''
 +
  
 
==Return value==
 
==Return value==
[[Variable types|FLOAT[]]]
+
[[Variable Types|FLOAT[]]]
 +
 
 +
Returns the positions euler angles in (P,Y,R) array
  
Returns the positions euler angles in {P,Y,R} array
 
  
 
==Detailed description==
 
==Detailed description==
''No additional information''
+
''<span style="color:red;">No additional information</span>''
 +
 
  
 
==Examples==
 
==Examples==
Line 30: Line 34:
 
* Declare a variable 'result' of type FLOAT[]
 
* Declare a variable 'result' of type FLOAT[]
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.GetEuler(handle, target)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.GetEuler(handle, target)</pre>
 +
 +
===Flowcode example file===
 +
Download {{Fcfile|SIMAPI_Panel_Position_GetEuler.fcfx|SIMAPI_Panel_Position_GetEuler}} and open it in Flowcode v6. In this example a blue cuboid and a LCD are shown on the system panel. When the program starts, the Euler angles of the cuboid are returned into an existing Float Array variable. The Euler angles are then displayed on the LCD display. Be aware in this example the LCD display is showing integer values. The floats are cast to ints. Euler angles are effectively showing the rotational dimensions of the object.
 +
The screenshots below show the effect and also highlight the code used by the example.
 +
 +
 +
 +
[[File:SIMAPI_Panel_Position_GetEuler_Pic0.png]]

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Returns the positions euler angles in (P,Y,R) array

Class hierarchy

Panel

Position
GetEuler

Parameters

HANDLE Handle

The position or component to read
The default value for this parameter is: this

HANDLE Target

The position or component to convert relative to
The default value for this parameter is: this


Return value

FLOAT[]

Returns the positions euler angles in (P,Y,R) array


Detailed description

No additional information


Examples

Calling in a calculation

  • Declare a variable 'result' of type FLOAT[]
  • Add to a calculation icon:
    result = ::Panel.Position.GetEuler(handle, target)

Flowcode example file

Download FC6 Icon.png SIMAPI_Panel_Position_GetEuler and open it in Flowcode v6. In this example a blue cuboid and a LCD are shown on the system panel. When the program starts, the Euler angles of the cuboid are returned into an existing Float Array variable. The Euler angles are then displayed on the LCD display. Be aware in this example the LCD display is showing integer values. The floats are cast to ints. Euler angles are effectively showing the rotational dimensions of the object. The screenshots below show the effect and also highlight the code used by the example.


SIMAPI Panel Position GetEuler Pic0.png