API Panel.Position.Math.GetDistance

From Flowcode Help
Revision as of 21:21, 11 May 2013 by Admin (talk | contribs) (XML import)
Jump to navigationJump to search

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