Difference between revisions of "API Panel.Position.Math.GetDistance"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| Line 3: | Line 3: | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy===[[API Panel|Panel]] | + | ====Class hierarchy==== |
| + | [[API Panel|Panel]] | ||
:[[API Panel.Position|Position]] | :[[API Panel.Position|Position]] | ||
::[[API Panel.Position.Math|Math]] | ::[[API Panel.Position.Math|Math]] | ||
| Line 11: | Line 12: | ||
==Parameters== | ==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]] ''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 27: | Line 28: | ||
==Detailed description== | ==Detailed description== | ||
| − | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
==Examples== | ==Examples== | ||
| Line 33: | Line 35: | ||
* 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, 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 information</span>'' | ||
Revision as of 22:08, 11 May 2013
<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 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
