Difference between revisions of "API Panel.Collision.TestTable"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
| (14 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <sidebar>API Contents</sidebar> | |
Tests whether an object collides with the table top, returns Z distance to move to rest on the table | Tests whether an object collides with the table top, returns Z distance to move to rest on the table | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ====Class hierarchy==== | ||
| + | [[API Panel|Panel]] | ||
| + | :[[API Panel.Collision|Collision]] | ||
| + | ::[[API Panel.Collision|TestTable]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|HANDLE]] ''Pos'' | |
:A component or position to focus the collision around | :A component or position to focus the collision around | ||
| − | + | ||
| − | [[Variable | + | ==Return value== |
| + | [[Variable Types|FLOAT]] | ||
Returns Z distance to move to rest on the table | Returns Z distance to move to rest on the table | ||
| − | |||
| − | |||
| − | ===Examples | + | ==Detailed description== |
| − | + | This calculates the distance between the lowest point on the objects bounding box and the table top, which is an infinite plane with Z = 0. | |
| + | [[File:API Panel.Collision.TestTable Diff.svg|thumb|none|200px|Distance to the table]] | ||
| + | |||
| + | The value returned is the distance to move in Z in order for the lowest point to lie on the table top. Note that this is not the same as the distance ''from'' the table which would be positive if the object was above the table, where as this would return the negative distance as the object would need to move down | ||
| + | |||
| + | |||
| + | ==Examples== | ||
| + | ===Calling in a calculation=== | ||
* Declare a variable 'result' of type FLOAT | * Declare a variable 'result' of type FLOAT | ||
| − | * Add to a calculation icon: result = ::Panel.Collision.TestTable(pos) | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.TestTable(pos)</pre> |
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Tests whether an object collides with the table top, returns Z distance to move to rest on the table
Contents
Parameters
HANDLE Pos
- A component or position to focus the collision around
Return value
Returns Z distance to move to rest on the table
Detailed description
This calculates the distance between the lowest point on the objects bounding box and the table top, which is an infinite plane with Z = 0.
The value returned is the distance to move in Z in order for the lowest point to lie on the table top. Note that this is not the same as the distance from the table which would be positive if the object was above the table, where as this would return the negative distance as the object would need to move down
Examples
Calling in a calculation
- Declare a variable 'result' of type FLOAT
- Add to a calculation icon:
result = ::Panel.Collision.TestTable(pos)
No additional examples
