API Panel.Position.Math.GetDistance: Difference between revisions
XML import API changes |
XML Import to change Variable types into Variable Types |
||
| Line 12: | Line 12: | ||
==Parameters== | ==Parameters== | ||
[[Variable | [[Variable Types|HANDLE]] ''Pos0'' | ||
:Start of line to calculate distance from | :Start of line to calculate distance from | ||
[[Variable | [[Variable Types|HANDLE]] ''Pos1'' | ||
:End of line to calculate distance to | :End of line to calculate distance to | ||
[[Variable | [[Variable Types|HANDLE]] ''Relative'' | ||
: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''' | ||
| Line 24: | Line 24: | ||
==Return value== | ==Return value== | ||
[[Variable | [[Variable Types|FLOAT]] | ||
Returns the distance between two positions | Returns the distance between two positions | ||
Revision as of 11:09, 10 June 2013
<sidebar>API contents</sidebar> 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
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