API Panel.Collision.GetSingleAxis: Difference between revisions
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|GetSingleAxis]] | ::[[API Panel.Collision|GetSingleAxis]] | ||
| 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|FLOAT]] ''X'' | |||
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
:Local or world-space X to return | :Local or world-space X to return | ||
[[Variable types|FLOAT]] ''Y'' | |||
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
:Local or world-space Y to return | :Local or world-space Y to return | ||
[[Variable types|FLOAT]] ''Z'' | |||
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
:Local or world-space Z to return | :Local or world-space Z to return | ||
[[Variable types|HANDLE]] ''TargetSpace'' | |||
:The target space to calculate X,Y,Z in | :The target space to calculate X,Y,Z in | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
| Line 35: | Line 36: | ||
[[Variable types|BOOL]] | [[Variable types|BOOL]] | ||
No additional information | ''<span style="color:red;">No additional information</span>'' | ||
==Detailed description== | ==Detailed description== | ||
''No additional information'' | ''<span style="color:red;">No additional information</span>'' | ||
==Examples== | ==Examples== | ||
| Line 44: | Line 48: | ||
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.GetSingleAxis(pos, test, return_x, return_y, return_z, targetspace)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Collision.GetSingleAxis(pos, test, return_x, return_y, return_z, targetspace)</pre> | ||
''<span style="color:red;">No additional information</span>'' | |||
Revision as of 22:08, 11 May 2013
<sidebar>API contents</sidebar> Tests whether an object collides with a position
Parameters
HANDLE Pos
- A component or position to focus the collision around
HANDLE Test
- An object to test collisions with
FLOAT X
- This parameter is returned back to the caller
- Local or world-space X to return
FLOAT Y
- This parameter is returned back to the caller
- Local or world-space Y to return
FLOAT Z
- This parameter is returned back to the caller
- Local or world-space Z to return
HANDLE TargetSpace
- The target space to calculate X,Y,Z in
- The default value for this parameter is: 0
Return value
No additional information
Detailed description
No additional information
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)
No additional information