CCmpAnimate Class Reference

Animation Component. More...

#include <cmpAnimate.h>

Inheritance diagram for CCmpAnimate:

List of all members.

Public Types
enum	eState { , kPlaying = 1, kFinished }
	State of the Animation. More...
Public Member Functions
	CCmpAnimate (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.

---

Detailed Description

Animation Component.

Handles animating the entity.

(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 CCmpAnimate::eState

State of the Animation.

Enumerator:

kPlaying	Animation playing.
kFinished	Animation finished playing.

---

Member Function Documentation

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

• kEditAnimGroup
  Set the animation group index.
  Data: 'int' with animation group index.

Implements CCmp.

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

• kEditAnimGroup
  Get the animation group index.
  Data: 'int' with animation group index.

Implements CCmp.

int CCmpAnimate::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 EDIT_DATA:

• None.
  

Implements CCmp.

---

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

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

---