CollisionCircle Class Reference

#include <CollisionCircle.h>

Inherits CollisionObject.

Collaboration diagram for CollisionCircle:

[legend]

List of all members.

Public Member Functions
	CollisionCircle (float radius)
virtual	~CollisionCircle ()
void	setRadius (float radius)
float	getRadius ()
virtual std::string	getType ()
Protected Member Functions
virtual bool	canCheckCollision (CollisionObject *opponent)
virtual std::vector < CollisionData * > &	checkCollisionInternal (CollisionObject *opponent, std::vector< CollisionData * > &dst, bool changeOrder)
std::vector< CollisionData * > &	checkCollisionWithCircle (CollisionCircle *opponent, std::vector< CollisionData * > &dst, bool changeOrder)
Protected Attributes
float	radius
	Radius of the Collision Circle.

---

Constructor & Destructor Documentation

CollisionCircle::CollisionCircle

(

float

radius

)

Constructor initializes radius.

Parameters:

radius

Radius of the CollisionCircle

CollisionCircle::~CollisionCircle

(

)

[virtual]

Empty destructor.

---

Member Function Documentation

bool CollisionCircle::canCheckCollision

(

CollisionObject *

opponent

)

[protected, virtual]

Checks if a collision-method is implemented for a collision check between the current CollisionObject and the passed one. Internally it checks the name of the passed CollisionObject and returns if a method exists locally to check for collisions.

Parameters:

opponent

CollisionObject for which a collision-method is searched

Returns:

true if a collision-method is implemented in this class, false otherwise

Implements CollisionObject.

std::vector< CollisionData * > & CollisionCircle::checkCollisionInternal	(	CollisionObject *	opponent,
		std::vector< CollisionData * > &	dst,
		bool	changeOrder
	)			[protected, virtual]

Calculates the collisions between the passed CollisionObject and itself.

See also:

CollisionObject::checkCollisionInternal()

Parameters:

	opponent	CollisionObject to check the collision with
	dst	Destination vector where to write the collision information to
	changeOrder	Defines order of CollisionObjects in CollisionData

Returns:

Destination vector (same as second parameter)

Implements CollisionObject.

std::vector< CollisionData * > & CollisionCircle::checkCollisionWithCircle	(	CollisionCircle *	opponent,
		std::vector< CollisionData * > &	dst,
		bool	changeOrder
	)			[protected]

Searches for collisions between the current CollisionCircle and the passed one. The method is called from the checkCollisionInternal method and does the collision test between the local CollisionCircle and the passed CollisionCircle.

Parameters:

	opponent	CollisionCircle to check the collision with
	dst	Destination vector where to write the collision information to
	changeOrder	Defines order of CollisionObjects in CollisionData

Returns:

Destination vector (same as second parameter)

float CollisionCircle::getRadius

(

)

Returns the radius of the CollisionCircle.

Returns:

Radius of the CollisionCircle.

std::string CollisionCircle::getType

(

)

[virtual]

Returns the name of the CollisionObject (="CollisionCircle").

See also:

CollisionObject::getType()

Returns:

Type of the CollisionObject (="CollisionCircle").

Implements CollisionObject.

void CollisionCircle::setRadius

(

float

radius

)

Sets the radius of the CollisionCircle. The method sets the radius of the CollisionCircle. This can be used to dynamically change the radius of the CollisionCircle in runtime.

Parameters:

radius

Radius of the CollisionCircle.

---

Member Data Documentation

float CollisionCircle::radius [protected]

Radius of the Collision Circle.

---

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

• tools/libraries/CollisionMap/CollisionCircle.h
• tools/libraries/CollisionMap/CollisionCircle.cpp