Difference between revisions of "API Panel.Position.Math.GetDistance"

From Flowcode Help
Jump to navigationJump to search
(XML Import to change Variable types into Variable Types)
(XML import)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Gets the distance between two positions
 
Gets the distance between two positions
  
Line 18: Line 18:
 
:End of line to calculate distance to
 
:End of line to calculate distance to
  
[[Variable Types|HANDLE]] ''Relative''
+
[[Variable Types|HANDLE]] ''CoordSpace''
:Optional position to calculate the distance in
+
:Position space to calculate the distance in
 
:''The default value for this parameter is: '''''this'''
 
:''The default value for this parameter is: '''''this'''
  
Line 36: Line 36:
 
===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:[cpp]">result = ::Panel.Position.Math.GetDistance(pos0, pos1, relative)</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.Math.GetDistance(pos0, pos1, coordspace)</pre>
  
''<span style="color:red;">No additional information</span>''
+
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Gets the distance between two positions

Class hierarchy

Panel

Position
Math
GetDistance

Parameters

HANDLE Pos0

Start of line to calculate distance from

HANDLE Pos1

End of line to calculate distance to

HANDLE CoordSpace

Position space to calculate the distance in
The default value for this parameter is: this


Return value

FLOAT

Returns the distance between two positions


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.Math.GetDistance(pos0, pos1, coordspace)

No additional examples