Difference between revisions of "API Panel.Collision.GetSinglePos"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| Line 3: | Line 3: | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy===[[API Panel|Panel]] | + | ====Class hierarchy==== |
| + | [[API Panel|Panel]] | ||
:[[API Panel.Collision|Collision]] | :[[API Panel.Collision|Collision]] | ||
::[[API Panel.Collision|GetSinglePos]] | ::[[API Panel.Collision|GetSinglePos]] | ||
| Line 10: | Line 11: | ||
==Parameters== | ==Parameters== | ||
| − | + | [[Variable types|HANDLE]] ''Pos'' | |
:A component or position to focus the collision around | :A component or position to focus the collision around | ||
| − | + | [[Variable types|HANDLE]] ''Test'' | |
:An object to test collisions with | :An object to test collisions with | ||
| − | + | [[Variable types|HANDLE]] ''MoveAxis'' | |
:The position whose axis will be moved along on collide | :The position whose axis will be moved along on collide | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
| Line 26: | Line 27: | ||
==Detailed description== | ==Detailed description== | ||
| − | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
==Examples== | ==Examples== | ||
| Line 32: | Line 34: | ||
* Declare a variable 'result' of type HANDLE | * Declare a variable 'result' of type HANDLE | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.GetSinglePos(pos, test, moveaxis)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.GetSinglePos(pos, test, moveaxis)</pre> | ||
| + | |||
| + | ''<span style="color:red;">No additional information</span>'' | ||
Revision as of 22:08, 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
Contents
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)
No additional information
