Jump to content

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

From Flowcode Help
JonnyW (talk | contribs)
XML import of updated API docs
JonnyW (talk | contribs)
XML import of API documentation
Line 1: Line 1:




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



Revision as of 14:27, 9 August 2013


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

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

No additional examples