Jump to content

API Panel.Position.Math.GetDistance: Difference between revisions

From Flowcode Help
← Older edit

JonnyW (talk | contribs)

3,997 edits
Admin (talk | contribs)
3,524 edits
XML import API auto-gen
JonnyW (talk | contribs)
3,997 edits
XML import
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
API contents
<sidebar>API Contents</sidebar>
Gets the distance between two positions
Gets the distance between two positions


<div style="width:25%; float:right" class="toc">
====Class hierarchy====
[[API Panel|Panel]]
:[[API Panel.Position|Position]]
::[[API Panel.Position.Math|Math]]
:::[[API Panel.Position.Math|GetDistance]]
</div>
__TOC__


===Parameters===
==Parameters==
''[[Variable types|HANDLE]] Pos0''
[[Variable Types|HANDLE]] ''Pos0''
:Start of line to calculate distance from
:Start of line to calculate distance from


''[[Variable types|HANDLE]] Pos1''
[[Variable Types|HANDLE]] ''Pos1''
: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'''


===Return value===
 
[[Variable types|FLOAT]]
==Return value==
[[Variable Types|FLOAT]]


Returns the distance between two positions
Returns the distance between two positions


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


===Examples===
==Detailed description==
====Calling in a calculation====
''<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.Math.GetDistance(pos0, pos1, relative)
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.Math.GetDistance(pos0, pos1, coordspace)</pre>
 
''<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

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_Panel.Position.Math.GetDistance&oldid=13848"