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) |
||
| Line 2: | Line 2: | ||
Gets the distance between two positions | Gets the distance between two positions | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ===Class hierarchy=== | ||
| + | :Panel | ||
| + | ::Position | ||
| + | :::Math | ||
| + | ::::GetDistance | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
''[[Variable types|HANDLE]] Pos0'' | ''[[Variable types|HANDLE]] Pos0'' | ||
:Start of line to calculate distance from | :Start of line to calculate distance from | ||
| Line 14: | Line 22: | ||
:''The default value for this parameter is: '''''this''' | :''The default value for this parameter is: '''''this''' | ||
| − | + | ==Return value== | |
[[Variable types|FLOAT]] | [[Variable types|FLOAT]] | ||
Returns the distance between two positions | Returns the distance between two positions | ||
| − | + | ==Detailed description== | |
''No additional information'' | ''No additional information'' | ||
| − | + | ==Examples== | |
| − | + | ===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:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.Math.GetDistance(pos0, pos1, relative)</pre> |
Revision as of 16:12, 11 May 2013
<sidebar>API contents</sidebar> Gets the distance between two positions
Class hierarchy
- Panel
- Position
- Math
- GetDistance
- Math
- Position
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)
