API Panel.Position.GetQuat: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	GetQuat
Returns the positions quaternion in (X,Y,Z,W) array
- HANDLE	Handle
The position or component to read
- HANDLE	Target
The position or component to convert relative to
- FLOAT[]	Return

Detailed description

Examples

Calling in a calculation

Declare a variable 'result' of type FLOAT[]

Add to a calculation icon:

result = ::Panel.Position.GetQuat(handle, target)

Flowcode example file

Download SIMAPI_Panel_Position_GetQuat 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, a wikipedia:Quaternion of the cuboid is returned into an existing Float Array variable. The Quaternion values are then displayed on the LCD display.

The screenshots below show the effect and also highlight the code used by the example.

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Returns the positions quaternion in {X,Y,Z,W} array
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''GetQuat'''
+|-
+| colspan="2" | Returns the positions quaternion in (X,Y,Z,W) array&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Handle
+|-
+| colspan="2" | The position or component to read&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Target
+|-
+| colspan="2" | The position or component to convert relative to&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT[]
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<div style="width:25%; float:right" class="toc">
-===Class hierarchy===
-:Panel
-::Position
-:::GetQuat
-</div>
-__TOC__
-==Parameters==
+==Detailed description==
-''[[Variable types|HANDLE]] Handle''
-:The position or component to read
-:''The default value for this parameter is: '''''this'''
-''[[Variable types|HANDLE]] Target''
-:The position or component to convert relative to
-:''The default value for this parameter is: '''''this'''
-==Return value==
-[[Variable types|FLOAT[]]]
-Returns the positions quaternion in {X,Y,Z,W} array
-==Detailed description==
-''No additional information''
 ==Examples==
@@ Line 31: / Line 30: @@
 * Declare a variable 'result' of type FLOAT[]
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.GetQuat(handle, target)</pre>
+===Flowcode example file===
+Download {{Fcfile|SIMAPI_Panel_Position_GetQuat.fcfx|SIMAPI_Panel_Position_GetQuat}} 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, a [[wikipedia:Quaternion]] of the cuboid is returned into an existing Float Array variable. The Quaternion values are then displayed on the LCD display.
+The screenshots below show the effect and also highlight the code used by the example.
+[[File:SIMAPI_Panel_Position_GetQuat_Pic0.png|800px]]

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation

Flowcode example file