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

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
(XML import API auto-gen)
Line 1: Line 1:
 
wiki page name
 
wiki page name
==Panel.Position.MathGetDistance==
+
Gets the distance between two positions
  
Gets the distance between two positions
 
----
 
  
 
===Parameters===
 
===Parameters===
Line 25: Line 23:
  
 
===Examples===
 
===Examples===
====Calling in a calculation:====
+
====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: result = ::Panel.Position.Math.GetDistance(pos0, pos1, relative)

Revision as of 15:34, 10 May 2013

wiki page name Gets the distance between two positions


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)