CCmpHead Class Reference

'Head' offsets. Gives the actual direction/location this entity is looking to/from. Used for camera, aiming, scanning, etc. More...

#include <cmpHead.h>

Inheritance diagram for CCmpHead:

List of all members.

Public Member Functions
	CCmpHead (CGameEntity *pGE)
	Create with default values.
void	ang_offset (const unit pan, const unit tilt, const unit roll)
void	tilt (const unit tilt)
	Parameters: tilt  New tilt offset.
const CAngle3D &	ang_offset ()
	Returns: Head angle offset.
CAngle3D	ang () const
	Returns: The current heading angle (offset+GE angle).
void	ang_limit (const int pan, const int tilt=-1, const int roll=-1)
void	ang_limit ()
	Apply ang limits.
void	pos_offset (const unit x, const unit y, const unit z)
CVector3D	pos () const
	Returns: The current heading angle
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.

---

Detailed Description

'Head' offsets. Gives the actual direction/location this entity is looking to/from. Used for camera, aiming, scanning, etc.

(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 Function Documentation

int CCmpHead::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:

• kEditOffset
  Set positional offset.
  Data: 'vec' contains offset in x,y,z.

• kEditAngOffset
  Set rotation offset.
  Data: 'vec' contains offset in pan,tilt,roll.

• kEditAngLimit
  Set the hand angle limits.
  Data: 'vec' where x: pan, y: tilt, z: roll limits.

Implements CCmp.

int CCmpHead::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:

• None.

Implements CCmp.

int CCmpHead::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.

void CCmpHead::ang_offset	(	const unit	pan,
		const unit	tilt,
		const unit	roll
	)			[inline]

Set the head angle offset from the current entity facing

Parameters:

	pan	Head Angle's new pan
	tilt	Head Angle's new tilt
	roll	Head Angle's new roll

void CCmpHead::ang_limit	(	const int	pan,
		const int	tilt = -1,
		const int	roll = -1
	)			[inline]

Set the head angle limits (0 = fixed, -1 = free)

Parameters:

	pan	Pan limit
	tilt	Tilt limit
	roll	Roll limit

void CCmpHead::pos_offset	(	const unit	x,
		const unit	y,
		const unit	z
	)			[inline]

Set the head pos offset

Parameters:

	x	Head Pos's new x
	y	Head Pos's new y
	z	Head Pos's new z

---

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

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

---