AlphaFramework API  1.0.3
Public Member Functions | List of all members
AlphaFramework.World.Components.Collision< TCoordinates > Class Template Referenceabstract

Controls how EntityBase<TCoordinates,TTemplate>s occupy space around them. More...

Inheritance diagram for AlphaFramework.World.Components.Collision< TCoordinates >:

Public Member Functions

override string ToString ()
 
abstract bool CollisionTest (TCoordinates point, float rotation)
 Determines whether a a certain point lies within the collision body. More...
 
abstract bool CollisionTest (Quadrangle area, float rotation)
 Determines whether a certain area lies within the collision body. More...
 
Collision< TCoordinates > Clone ()
 Creates a copy of this Collision<TCoordinates>. More...
 

Detailed Description

Controls how EntityBase<TCoordinates,TTemplate>s occupy space around them.

Type Constraints
TCoordinates :struct 

Member Function Documentation

◆ Clone()

Collision<TCoordinates> AlphaFramework.World.Components.Collision< TCoordinates >.Clone ( )
inline

Creates a copy of this Collision<TCoordinates>.

Returns
The cloned Collision<TCoordinates>.

◆ CollisionTest() [1/2]

abstract bool AlphaFramework.World.Components.Collision< TCoordinates >.CollisionTest ( TCoordinates  point,
float  rotation 
)
pure virtual

Determines whether a a certain point lies within the collision body.

Parameters
pointThe point to check for collision in entity space.
rotationHow the collision body shall be rotated before performing the collision test.
Returns
true if point does collide with the body, false otherwise.

◆ CollisionTest() [2/2]

abstract bool AlphaFramework.World.Components.Collision< TCoordinates >.CollisionTest ( Quadrangle  area,
float  rotation 
)
pure virtual

Determines whether a certain area lies within the collision body.

Parameters
areaThe area to check for collision in entity space.
rotationHow the collision body shall be rotated before performing the collision test.
Returns
true if area does collide with the body, false otherwise.

The documentation for this class was generated from the following file: