Jump to content

API Panel.Position.GetQuat: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import of API auto-gen
Admin (talk | contribs)
XML import
Line 2: Line 2:
Returns the positions quaternion in {X,Y,Z,W} array
Returns the positions quaternion in {X,Y,Z,W} array


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


===Parameters===
==Parameters==
''[[Variable types|HANDLE]] Handle''
''[[Variable types|HANDLE]] Handle''
:The position or component to read
:The position or component to read
Line 12: Line 19:
:''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 quaternion in {X,Y,Z,W} array
Returns the positions quaternion in {X,Y,Z,W} array


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


===Examples===
==Examples==
====Calling in a calculation====
===Calling in a calculation===
* Declare a variable 'result' of type FLOAT[]
* Declare a variable 'result' of type FLOAT[]
* Add to a calculation icon: <pre class="brush:[C]">result = ::Panel.Position.GetQuat(handle, target)</pre>
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.GetQuat(handle, target)</pre>

Revision as of 16:10, 11 May 2013

<sidebar>API contents</sidebar> Returns the positions quaternion in {X,Y,Z,W} array

Class hierarchy

Panel
Position
GetQuat

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 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)