1. Home
  2. Documentation
  3. API
  4. ColliderManager Class Reference

ColliderManager Class Reference

#include <ColliderManager.h>

Inheritance diagram for ColliderManager:
ComponentManager

# Public Member Functions

void constructor ()
 Class' constructor.
override uint32 getType ()
override void enable ()
 Enable the manager.
override void disable ()
 Disable the manager.
override Collider create (Entity owner, const ColliderSpec *colliderSpec)
uint32 update ()
 Update colliders and test collisions.
void setCheckCollidersOutOfCameraRange (bool value)
void showColliders ()
 Make the colliders visible by the usage of wireframes.
void hideColliders ()
 Make the colliders invisible by hiding their wireframes.
void print (int32 x, int32 y)

# Protected Attributes

bool checkCollidersOutOfCameraRange
 If false, colliders out of camera's range are culled of from collision testing.

# Additional Inherited Members

- Private Member Functions inherited from ComponentManager
void constructor ()
 Class' constructor.
void destroyAllComponents ()
 Destroy all the manager's components.
virtual Component create (Entity owner, const ComponentSpec *componentSpec)=0
virtual void purgeComponents ()
 Force the purging of deleted components.
virtual bool areComponentsVisual ()
- Static Private Member Functions inherited from ComponentManager
static Component createComponent (Entity owner, const ComponentSpec *componentSpec)
static void destroyComponent (Entity owner, Component component)
static Component addComponent (Entity owner, const ComponentSpec *componentSpec)
static void removeComponent (Entity owner, Component component)
static void addComponents (Entity owner, ComponentSpec **componentSpecs, uint32 componentType)
static void removeComponents (Entity owner, uint32 componentType)
static void createComponents (Entity owner, ComponentSpec **componentSpecs)
static void destroyComponents (Entity owner)
static Component getComponentAtIndex (Entity owner, uint32 componentType, int16 componentIndex)
static void getComponents (Entity owner, uint32 componentType, VirtualList components)
static bool getComponentsOfClass (Entity owner, ClassPointer classPointer, VirtualList components, uint32 componentType)
static uint16 getComponentsCount (Entity owner, uint32 componentType)
static void propagateCommand (int32 command, Entity owner, uint32 componentType,...)
static bool calculateRightBox (Entity owner, RightBox *rightBox)
- Private Attributes inherited from ComponentManager
VirtualList components
 List of components.
bool locked
 Flag to prevent the manipulation of the components list.

# Detailed Description

Class ColliderManager

Inherits from ComponentManager

Manages the colliders in the game states.

Definition at line 42 of file ColliderManager.h.

# Member Function Documentation

# constructor()

void ColliderManager::constructor ( )

Class' constructor.

Definition at line 306 of file ColliderManager.c.

# create()

Collider ColliderManager::create ( Entity owner,
const ColliderSpec * colliderSpec )

Create a collider with the provided spec.

Parameters
ownerObject to which the collider will attach to
colliderSpecSpec to use to create the collider
Returns
Created collider

Definition at line 84 of file ColliderManager.c.

# disable()

void ColliderManager::disable ( )
virtual

Disable the manager.

Reimplemented from ComponentManager.

Definition at line 72 of file ColliderManager.c.

# enable()

void ColliderManager::enable ( )
virtual

Enable the manager.

Reimplemented from ComponentManager.

Definition at line 65 of file ColliderManager.c.

# getType()

uint32 ColliderManager::getType ( )
virtual

Retrieve the compoment type that the manager manages.

Returns
Component type

Implements ComponentManager.

Definition at line 58 of file ColliderManager.c.

# hideColliders()

void ColliderManager::hideColliders ( )

Make the colliders invisible by hiding their wireframes.

# print()

void ColliderManager::print ( int32 x,
int32 y )

Print the manager's statistics.

Parameters
xScreen x coordinate where to print
yScreen y coordinate where to print

Definition at line 267 of file ColliderManager.c.

# setCheckCollidersOutOfCameraRange()

void ColliderManager::setCheckCollidersOutOfCameraRange ( bool value)

Set if the colliders out of camera's range are culled of from collision testing.

Parameters
valueIf false, colliders out of camera's range are culled of from collision testing

Definition at line 233 of file ColliderManager.c.

# showColliders()

void ColliderManager::showColliders ( )

Make the colliders visible by the usage of wireframes.

# update()

uint32 ColliderManager::update ( )

Update colliders and test collisions.

Definition at line 96 of file ColliderManager.c.

# Member Data Documentation

# checkCollidersOutOfCameraRange

bool ColliderManager::checkCollidersOutOfCameraRange
protected

If false, colliders out of camera's range are culled of from collision testing.

Definition at line 47 of file ColliderManager.h.


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