API Panel.Position.Math.GetDistance: Difference between revisions
XML Import to change Variable types into Variable Types |
XML import of updated API docs |
||
| Line 1: | Line 1: | ||
<sidebar>API contents</sidebar> | <sidebar>API contents</sidebar> | ||
Gets the distance between two positions | Gets the distance between two positions | ||
| Line 19: | Line 21: | ||
[[Variable Types|HANDLE]] ''Relative'' | [[Variable Types|HANDLE]] ''Relative'' | ||
: | :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 40: | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.Math.GetDistance(pos0, pos1, relative)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.Math.GetDistance(pos0, pos1, relative)</pre> | ||
''<span style="color:red;">No additional | ''<span style="color:red;">No additional examples</span>'' | ||
Revision as of 09:58, 17 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
- 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, relative)
No additional examples