Difference between revisions of "API Mouse.GetClickSide"
From Flowcode Help
Jump to navigationJump to search| Line 24: | Line 24: | ||
This call retrieves the face of the bounding box intersected by the mouse. This is always the closest face to the screen. | 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]] | + | [[file:SIMAPI Mouse.GetPosition Faces.svg|thumb|none|Face numbers]] |
The faces of the bounding box are ordered according to the following table: | The faces of the bounding box are ordered according to the following table: | ||
{| | {| | ||
Revision as of 22:31, 2 August 2013
<sidebar>API contents</sidebar>
Gets the side of the component clicked on, 0 to 5
Contents
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.
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
