API Mouse.GetClickSide: Difference between revisions
XML import of updated API docs |
No edit summary |
||
| Line 2: | Line 2: | ||
<sidebar>API contents</sidebar> | <sidebar>API contents</sidebar> | ||
Gets the side of the component clicked on, 0 to | Gets the side of the component clicked on, 0 to 5 | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| Line 18: | Line 18: | ||
[[Variable Types|BYTE]] | [[Variable Types|BYTE]] | ||
Returns the side of the component clicked on, 0 to | Returns the side of the component clicked on, 0 to 5 | ||
==Detailed description== | ==Detailed description== | ||
This call retrieves the face of the bounding box intersected by the mouse. This is always the closest face to the screen. | |||
[[SIMAPI Mouse.GetPosition Faces.svg|thumb|none|Face numbers]] | |||
The faces of the bounding box are ordered according to the following table: | |||
{| | |||
|- | |||
!Face | |||
!Position | |||
|- | |||
|0 | |||
|XY plane, Z=-1 | |||
|- | |||
|1 | |||
|YZ plane, X=-1 | |||
|- | |||
|2 | |||
|XZ plane, Y=-1 | |||
|- | |||
|3 | |||
|XZ plane, Y=1 | |||
|- | |||
|4 | |||
|YZ plane, X=1 | |||
|- | |||
|5 | |||
|XY plane, Z=1 | |||
|} | |||
Each face, when added to the opposite face on the cube, adds up to 5 (so each YZ face = 1 + 4 = 5). | |||
Revision as of 22:30, 2 August 2013
<sidebar>API contents</sidebar>
Gets the side of the component clicked on, 0 to 5
Parameters
This function has no parameters
Return value
Returns the side of the component clicked on, 0 to 5
Detailed description
This call retrieves the face of the bounding box intersected by the mouse. This is always the closest face to the screen.
thumb|none|Face numbers The faces of the bounding box are ordered according to the following table:
| Face | Position |
|---|---|
| 0 | XY plane, Z=-1 |
| 1 | YZ plane, X=-1 |
| 2 | XZ plane, Y=-1 |
| 3 | XZ plane, Y=1 |
| 4 | YZ plane, X=1 |
| 5 | XY plane, Z=1 |
Each face, when added to the opposite face on the cube, adds up to 5 (so each YZ face = 1 + 4 = 5).
Examples
Calling in a calculation
- Declare a variable 'result' of type BYTE
- Add to a calculation icon:
result = ::Mouse.GetClickSide()
No additional examples