API Panel.Position.Math.GetDistance: Difference between revisions
XML import of API documentation |
XML import of API routines for release |
||
| Line 1: | Line 1: | ||
<sidebar>API Contents</sidebar> | <sidebar>API Contents</sidebar> | ||
| Line 20: | Line 19: | ||
:End of line to calculate distance to | :End of line to calculate distance to | ||
[[Variable Types|HANDLE]] '' | [[Variable Types|HANDLE]] ''CoordSpace'' | ||
:Position space to calculate the distance in | :Position space to calculate the distance in | ||
:''The default value for this parameter is: '''''this''' | :''The default value for this parameter is: '''''this''' | ||
| Line 38: | Line 37: | ||
===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: <pre class="brush:[cpp]">result = ::Panel.Position.Math.GetDistance(pos0, pos1, | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.Math.GetDistance(pos0, pos1, coordspace)</pre> | ||
''<span style="color:red;">No additional examples</span>'' | ''<span style="color:red;">No additional examples</span>'' | ||
Revision as of 13:33, 2 September 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 CoordSpace
- Position space 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, coordspace)
No additional examples