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

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import API changes)
Line 25: Line 25:
 
==Return value==
 
==Return value==
 
[[Variable types|FLOAT]]
 
[[Variable types|FLOAT]]
 +
 
Returns the distance between two positions
 
Returns the distance between two positions
  

Revision as of 13:14, 14 May 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

Optional position 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 information