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

From Flowcode Help
Jump to navigationJump to search
(XML import of new API docs)
Line 1: Line 1:
 +
 +
 
<sidebar>API contents</sidebar>
 
<sidebar>API contents</sidebar>
Returns the positions coordinates in {X,Y,Z} array
+
Returns the positions coordinates in (X,Y,Z) array
  
 
<div style="width:25%; float:right" class="toc">
 
<div style="width:25%; float:right" class="toc">
Line 23: Line 25:
 
[[Variable types|FLOAT[]]]
 
[[Variable types|FLOAT[]]]
  
Returns the positions coordinates in {X,Y,Z} array
+
Returns the positions coordinates in (X,Y,Z) array
  
  

Revision as of 13:23, 22 May 2013


<sidebar>API contents</sidebar> Returns the positions coordinates in (X,Y,Z) array

Class hierarchy

Panel

Position
GetCoords

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 coordinates in (X,Y,Z) 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.GetCoords(handle, target)

Flowcode example file

Download File:SIMAPI Panel Position GetCoords.fcf and open it in Flowcode v6. In this example a sphere and a LCD are shown on the system panel. When the program starts, the position of the sphere is returned into an existing Float Array variable containing the X,Y,Z coordinates. The coordinates 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. The screenshots below show the effect and also highlight the code used by the example.


SIMAPI Panel Position GetCoords Pic0.png