Difference between revisions of "API Mouse.GetClickSide"
From Flowcode Help
Jump to navigationJump to search (XML import of updated API docs) |
|||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetClickSide''' | ||
| + | |- | ||
| + | | colspan="2" | Gets the side of the component clicked on, 0 to 5 | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| − | + | ==Detailed description== | |
| − | + | This call retrieves the face of the bounding box intersected by the mouse. This is always the closest face to the screen. | |
| − | + | [[file: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). | ||
| Line 29: | Line 47: | ||
* Declare a variable 'result' of type BYTE | * Declare a variable 'result' of type BYTE | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Mouse.GetClickSide()</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Mouse.GetClickSide()</pre> | ||
| − | |||
| − | |||
Latest revision as of 11:55, 16 January 2023
|
GetClickSide |
| Gets the side of the component clicked on, 0 to 5 | |
 - BYTE
|
Return |
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()
