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

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 21: Line 21:
 
:Optional position to calculate the distance in
 
:Optional position to calculate the distance in
 
:''The default value for this parameter is: '''''this'''
 
:''The default value for this parameter is: '''''this'''
 +
  
 
==Return value==
 
==Return value==
Line 26: Line 27:
  
 
Returns the distance between two positions
 
Returns the distance between two positions
 +
  
 
==Detailed description==
 
==Detailed description==

Revision as of 01:52, 12 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