Difference between revisions of "API Panel.Collision.GetSingleAxis"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
|||
| (17 intermediate revisions by 3 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;" | '''GetSingleAxis''' | ||
| + | |- | ||
| + | | colspan="2" | Tests whether an object collides with a position | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Pos | ||
| + | |- | ||
| + | | colspan="2" | A component or position to focus the collision around | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Test | ||
| + | |- | ||
| + | | colspan="2" | An object to test collisions with | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | ||
| + | | width="90%" | X | ||
| + | |- | ||
| + | | colspan="2" | Local or world-space X to return | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | ||
| + | | width="90%" | Y | ||
| + | |- | ||
| + | | colspan="2" | Local or world-space Y to return | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | ||
| + | | width="90%" | Z | ||
| + | |- | ||
| + | | colspan="2" | Local or world-space Z to return | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | TargetSpace | ||
| + | |- | ||
| + | | colspan="2" | The target space to calculate X,Y,Z in | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| − | |||
| − | |||
| − | === | + | ==Detailed description== |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | ==Examples== | |
| − | + | ===Calling in a calculation=== | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
| − | * Add to a calculation icon: result = ::Panel.Collision.GetSingleAxis(pos, test, return_x, return_y, return_z, targetspace) | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.GetSingleAxis(pos, test, return_x, return_y, return_z, targetspace)</pre> |
Latest revision as of 11:55, 16 January 2023
|
GetSingleAxis |
| Tests whether an object collides with a position | |
 - HANDLE
|
Pos |
| A component or position to focus the collision around | |
| - HANDLE
|
Test |
| An object to test collisions with | |
 - FLOAT
|
X |
| Local or world-space X to return | |
| - FLOAT
|
Y |
| Local or world-space Y to return | |
| - FLOAT
|
Z |
| Local or world-space Z to return | |
| - HANDLE
|
TargetSpace |
| The target space to calculate X,Y,Z in | |
 - BOOL
|
Return |
Detailed description
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon:
result = ::Panel.Collision.GetSingleAxis(pos, test, return_x, return_y, return_z, targetspace)
