CollisionType Class Reference

Represents a type of collision. More...

#include <CollisionType.h>

Public Member Functions
	CollisionType ()
	Instantiate a collision type object.
virtual	~CollisionType ()
CollisionType &	operator= (const CollisionType &type)
bool	operator== (const CollisionType &type) const
bool	operator!= (const CollisionType &type) const
bool	operator< (const CollisionType &type) const
bool	operator> (const CollisionType &type) const
const CollisionType	operator| (const CollisionType &type) const
CollisionType &	operator|= (const CollisionType &type)
const CollisionType	operator& (const CollisionType &type) const
CollisionType &	operator&= (const CollisionType &type)
const CollisionType	operator^ (const CollisionType &type) const
CollisionType &	operator^= (const CollisionType &type)
bool	Contains (const CollisionType &type) const
	Check if the collision type contains a specific type.

Static Public Attributes
static const CollisionType	None = CollisionType(0)
static const CollisionType	Player = CollisionType(1 << 0)
static const CollisionType	Enemy = CollisionType(1 << 1)
static const CollisionType	Ship = CollisionType(1 << 2)
static const CollisionType	Projectile = CollisionType(1 << 3)

Protected Member Functions
	CollisionType (const unsigned short value)
	Instantiate a collision type object with a specific value.

Detailed Description

Represents a type of collision.

Each collision type is represented by a unique bit-mask value. This allows for complex types without the need for a large number of unique values. It basically allows for a single number to represent multiple boolean values. For example, a collision type "player projectile" would be created by combining the "player" and "projectile" types, while an "enemy projectile" would be created by combining the "enemy" and "projectile" types.

Definition at line 11 of file CollisionType.h.

Constructor & Destructor Documentation

CollisionType() [1/2]

CollisionType::CollisionType ( )

inline

Instantiate a collision type object.

Definition at line 17 of file CollisionType.h.

~CollisionType()

virtual CollisionType::~CollisionType ( )

inlinevirtual

Definition at line 18 of file CollisionType.h.

CollisionType() [2/2]

CollisionType::CollisionType ( const unsigned short value )

inlineprotected

Instantiate a collision type object with a specific value.

Parameters

value

The value of the collision type.

Definition at line 104 of file CollisionType.h.

Member Function Documentation

Contains()

bool CollisionType::Contains ( const CollisionType & type ) const

inline

Check if the collision type contains a specific type.

Parameters

type	The type to check.

Returns

True if the type is contained within the collision type.

Definition at line 94 of file CollisionType.h.

operator!=()

bool CollisionType::operator!= ( const CollisionType & type ) const

inline

Definition at line 40 of file CollisionType.h.

operator&()

const CollisionType CollisionType::operator& ( const CollisionType & type ) const

inline

Definition at line 67 of file CollisionType.h.

operator&=()

CollisionType & CollisionType::operator&= ( const CollisionType & type )

inline

Definition at line 72 of file CollisionType.h.

operator<()

bool CollisionType::operator< ( const CollisionType & type ) const

inline

Definition at line 45 of file CollisionType.h.

operator=()

CollisionType & CollisionType::operator= ( const CollisionType & type )

inline

Definition at line 29 of file CollisionType.h.

operator==()

bool CollisionType::operator== ( const CollisionType & type ) const

inline

Definition at line 35 of file CollisionType.h.

operator>()

bool CollisionType::operator> ( const CollisionType & type ) const

inline

Definition at line 50 of file CollisionType.h.

operator^()

const CollisionType CollisionType::operator^ ( const CollisionType & type ) const

inline

Definition at line 79 of file CollisionType.h.

operator^=()

CollisionType & CollisionType::operator^= ( const CollisionType & type )

inline

Definition at line 84 of file CollisionType.h.

operator|()

const CollisionType CollisionType::operator| ( const CollisionType & type ) const

inline

Definition at line 55 of file CollisionType.h.

operator|=()

CollisionType & CollisionType::operator|= ( const CollisionType & type )

inline

Definition at line 60 of file CollisionType.h.

Member Data Documentation

Enemy

const CollisionType CollisionType::Enemy = CollisionType(1 << 1)

static

Definition at line 24 of file CollisionType.h.

None

const CollisionType CollisionType::None = CollisionType(0)

static

Definition at line 21 of file CollisionType.h.

Player

const CollisionType CollisionType::Player = CollisionType(1 << 0)

static

Definition at line 23 of file CollisionType.h.

Projectile

const CollisionType CollisionType::Projectile = CollisionType(1 << 3)

static

Definition at line 27 of file CollisionType.h.

Ship

const CollisionType CollisionType::Ship = CollisionType(1 << 2)

static

Definition at line 26 of file CollisionType.h.

---

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

• doxy_src/SpaceFighter/CollisionType.h
• doxy_src/SpaceFighter/CollisionType.cpp