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) |
||
(15 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | + | <sidebar>API Contents</sidebar> | |
− | + | Gets the distance between two positions | |
− | + | <div style="width:25%; float:right" class="toc"> | |
− | + | ====Class hierarchy==== | |
+ | [[API Panel|Panel]] | ||
+ | :[[API Panel.Position|Position]] | ||
+ | ::[[API Panel.Position.Math|Math]] | ||
+ | :::[[API Panel.Position.Math|GetDistance]] | ||
+ | </div> | ||
+ | __TOC__ | ||
− | + | ==Parameters== | |
− | + | [[Variable Types|HANDLE]] ''Pos0'' | |
:Start of line to calculate distance from | :Start of line to calculate distance from | ||
− | + | [[Variable Types|HANDLE]] ''Pos1'' | |
:End of line to calculate distance to | :End of line to calculate distance to | ||
− | + | [[Variable Types|HANDLE]] ''CoordSpace'' | |
− | : | + | :Position space to calculate the distance in |
:''The default value for this parameter is: '''''this''' | :''The default value for this parameter is: '''''this''' | ||
− | + | ||
− | [[Variable | + | ==Return value== |
+ | [[Variable Types|FLOAT]] | ||
Returns the distance between two positions | Returns the distance between two positions | ||
− | |||
− | |||
− | ===Examples | + | ==Detailed description== |
− | + | ''<span style="color:red;">No additional information</span>'' | |
+ | |||
+ | |||
+ | ==Examples== | ||
+ | ===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, | + | * 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>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets the distance between two positions
Contents
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