Difference between revisions of "API Panel.Position.GetQuat"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| (18 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <sidebar>API Contents</sidebar> | |
| − | + | Returns the positions quaternion in (X,Y,Z,W) array | |
| − | + | <div style="width:25%; float:right" class="toc"> | |
| − | + | ====Class hierarchy==== | |
| + | [[API Panel|Panel]] | ||
| + | :[[API Panel.Position|Position]] | ||
| + | ::[[API Panel.Position|GetQuat]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[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'' | |
: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== | |
| + | [[Variable Types|FLOAT[]]] | ||
| − | + | Returns the positions quaternion in (X,Y,Z,W) array | |
| − | |||
| − | ===Examples | + | |
| − | + | ==Detailed description== | |
| + | ''<span style="color:red;">No additional information</span>'' | ||
| + | |||
| + | |||
| + | ==Examples== | ||
| + | ===Calling in a calculation=== | ||
* Declare a variable 'result' of type FLOAT[] | * Declare a variable 'result' of type FLOAT[] | ||
| − | * Add to a calculation icon: result = ::Panel.Position.GetQuat(handle, target) | + | * 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]] | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Returns the positions quaternion in (X,Y,Z,W) array
Contents
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
Returns the positions quaternion in (X,Y,Z,W) 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.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.
