Difference between revisions of "API Mouse.GetPosition"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
Gets the position of the mouse, intersecting with a component or the viewing plane
 
Gets the position of the mouse, intersecting with a component or the viewing plane
  
 +
<div style="width:25%; float:right" class="toc">
 +
===Class hierarchy===
 +
:Mouse
 +
::GetPosition
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
 
''This function has no parameters''
 
''This function has no parameters''
  
===Return value===
+
==Return value==
 
[[Variable types|HANDLE]]
 
[[Variable types|HANDLE]]
  
 
Returns the position of the mouse, intersecting with a component or the viewing plane
 
Returns the position of the mouse, intersecting with a component or the viewing plane
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====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:[C]">result = ::Mouse.GetPosition()</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Mouse.GetPosition()</pre>

Revision as of 16:38, 11 May 2013

<sidebar>API contents</sidebar> Gets the position of the mouse, intersecting with a component or the viewing plane

Class hierarchy

Mouse
GetPosition

Parameters

This function has no parameters

Return value

HANDLE

Returns the position of the mouse, intersecting with a component or the viewing plane

Detailed description

No additional information

Examples

Calling in a calculation

  • Declare a variable 'result' of type HANDLE
  • Add to a calculation icon:
    result = ::Mouse.GetPosition()