Difference between revisions of "API Panel.Position.Math.GetDiff"

From Flowcode Help
Jump to navigationJump to search
(XML import of API documentation)
(XML import of API routines for release)
Line 20: Line 20:
 
:The position to subrtact from Pos
 
:The position to subrtact from Pos
  
[[Variable Types|HANDLE]] ''Relative''
+
[[Variable Types|HANDLE]] ''CoordSpace''
 
:Position space to calculate the difference in
 
:Position space to calculate the difference in
 
:''The default value for this parameter is: '''''this'''
 
:''The default value for this parameter is: '''''this'''
Line 38: Line 38:
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Declare a variable 'result' of type HANDLE
 
* Declare a variable 'result' of type HANDLE
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.Math.GetDiff(pos, sub, relative)</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.Math.GetDiff(pos, sub, 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 difference between two positions

Class hierarchy

Panel

Position
Math
GetDiff

Parameters

HANDLE Pos

Position to act as the minuend to calculate position from

HANDLE Sub

The position to subrtact from Pos

HANDLE CoordSpace

Position space to calculate the difference in
The default value for this parameter is: this


Return value

HANDLE

Returns the difference between two positions


Detailed description

No additional information


Examples

Calling in a calculation

  • Declare a variable 'result' of type HANDLE
  • Add to a calculation icon:
    result = ::Panel.Position.Math.GetDiff(pos, sub, coordspace)

No additional examples