CCmpCollision Class Reference

Manage collision data. More...

#include <cmpCollision.h>

Inheritance diagram for CCmpCollision:

List of all members.

Public Types
enum	eType {   normal = 0, use_bounds = 1, xy_symmetric = 2, use_fat = 3,   use_narrow = 4, use_frame = 5 }
	Collision Type. More...
Public Member Functions
	CCmpCollision (CGameEntity *pGE)
	Create with default values.
Virtual methods
virtual int	set (const EDIT_DATA &editData)
	Set a value.
virtual int	get (EDIT_DATA &editData) const
	Get a value.
virtual int	act (const ACTION_DATA &actData)
	Preform an action.
virtual void	update ()
	Update this Cmp for a single frame.
Static Public Attributes
static const eType	kDefaultType = CCmpCollision::normal
	Type of collision.
static const CVector3D	kDefaultMaxBounds
	Bounding box/ellipsoid max values.
static const CVector3D	kDefaultMinBounds
	Bounding box/ellipsoid min values.
static const int	kDefaultFrameNumber
	Frame number to use if "use_frame" is selected as type.
static const int	kDefaultPush
	An entity with a higher value will consider an entity with a lower value not an obstacle.

---

Detailed Description

Manage collision data.

(c) 2007-2008 oP group Germany GbR. All rights reserved.
This source code is provided "as is" with no warranty and must not be distributed without written permission.

Author:

Doug Poston

Version:

1.3

Date:

12/28/2007

---

Member Enumeration Documentation

enum CCmpCollision::eType

Collision Type.

Enumerator:

normal	Used the default settings.
use_bounds	User defined bounding box.
xy_symmetric	Make a bounding box that is symmetrical in the X/Y plane.
use_fat	Used the fat hull.
use_narrow	Used the narrow hull.
use_frame	Used the extents of a frame.

---

Constructor & Destructor Documentation

CCmpCollision::CCmpCollision

(

CGameEntity *

pGE

)

Create with default values.

apply changes to the parent GE

---

Member Function Documentation

int CCmpCollision::set

(

const EDIT_DATA &

editData

)

[virtual]

Set a value.

If we have data of this type, use editData to set its value.

Parameters:

editData

Data type and value (see EDIT_DATA struct).

Returns:

Value less than zero on error, 0 if nothing found, positive otherwise.

See also:

EDIT_DATA

---

Handles the following EDIT_DATA:

• kEditType
  Set the collision type.
  Data: 'int' with collision type.

  See also:

  eType

• kEditMinVec
  Set the min bounds.
  Data: 'vec' with min bounds.

• kEditMaxVec
  Set the max bounds.
  Data: 'vec' with max bounds.

• kEditPush
  Set the 'push' value.
  Data: 'int' with push value.

Implements CCmp.

int CCmpCollision::get

(

EDIT_DATA &

editData

)

const [virtual]

Get a value.

If we have data of this type, use editData to get its value.

Parameters:

editData

Data type we are looking for, and memory to store value (see EDIT_DATA struct).

Returns:

Value less than zero on error, 0 if nothing found, positive otherwise.

See also:

EDIT_DATA

---

Handles the following EDIT_DATA:

• kEditMinVec
  Get the min bounds.
  Data: 'vec' with min bounds.

• kEditMaxVec

• kEditMaxVec
  Get the max bounds.
  Data: 'vec' with max bounds.

Implements CCmp.

int CCmpCollision::act

(

const ACTION_DATA &

actData

)

[virtual]

Preform an action.

Handle the action passed in (ignore if we do not handle the action type).

Parameters:

actData

The data used to preform the action (see ACTION_DATA struct).

Returns:

Value less than zero on error, 0 if no action found, positive otherwise.

See also:

ACTION_DATA

---

Handles the following ACTION_DATA:

• None.

Implements CCmp.

---

Member Data Documentation

const CCmpCollision::eType CCmpCollision::kDefaultType = CCmpCollision::normal [static]

Type of collision.

Style of collision.

---

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

• C:/Documents and Settings/slap/My Documents/Visual Studio 2005/Projects/Template7/template7/cmpCollision.h
• C:/Documents and Settings/slap/My Documents/Visual Studio 2005/Projects/Template7/template7/cmpCollision.cpp

---