API Panel.Collision.GetSinglePos: Difference between revisions
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
Returns the position to move Pos to so it does not collide with Test - null if no collide | Returns the position to move Pos to so it does not collide with Test - null if no collide | ||
<div style="width:25%; float:right" class="toc"> | |||
===Class hierarchy=== | |||
:Panel | |||
::Collision | |||
:::GetSinglePos | |||
</div> | |||
__TOC__ | |||
==Parameters== | |||
''[[Variable types|HANDLE]] Pos'' | ''[[Variable types|HANDLE]] Pos'' | ||
:A component or position to focus the collision around | :A component or position to focus the collision around | ||
| Line 14: | Line 21: | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
==Return value== | |||
[[Variable types|HANDLE]] | [[Variable types|HANDLE]] | ||
Returns the position to move Pos to so it does not collide with Test - null if no collide | Returns the position to move Pos to so it does not collide with Test - null if no collide | ||
==Detailed description== | |||
''No additional information'' | ''No additional information'' | ||
==Examples== | |||
===Calling in a calculation=== | |||
* Declare a variable 'result' of type HANDLE | * Declare a variable 'result' of type HANDLE | ||
* Add to a calculation icon: <pre class="brush:[ | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.GetSinglePos(pos, test, moveaxis)</pre> | ||
Revision as of 16:23, 11 May 2013
<sidebar>API contents</sidebar> Returns the position to move Pos to so it does not collide with Test - null if no collide
Class hierarchy
- Panel
- Collision
- GetSinglePos
- Collision
Parameters
HANDLE Pos
- A component or position to focus the collision around
HANDLE Test
- An object to test collisions with
HANDLE MoveAxis
- The position whose axis will be moved along on collide
- The default value for this parameter is: 0
Return value
Returns the position to move Pos to so it does not collide with Test - null if no collide
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type HANDLE
- Add to a calculation icon:
result = ::Panel.Collision.GetSinglePos(pos, test, moveaxis)