Atlas_Objects_Entity_GameEntityData (3) - Linux Manuals

Atlas_Objects_Entity_GameEntityData: All In Game classes and objects.

NAME

Atlas::Objects::Entity::GameEntityData - All In Game classes and objects.

SYNOPSIS

#include <Entity.h>

Inherits Atlas::Objects::Entity::RootEntityData.

Public Member Functions

virtual GameEntityData * copy () const
Copy this object.
virtual bool instanceOf (int classNo) const
Is this instance of some class?
virtual void iterate (int &current_class, std::string &attr) const
Iterate over the attributes of this instance.
virtual void free ()
Free an instance of this class, returning it to the memory pool.
virtual GameEntityData * getDefaultObject ()
Get the reference object that contains the default values for attributes of instances of the same class as this object.

Static Public Member Functions

static GameEntityData * alloc ()
Allocate a new instance of this class, using an existing instance if available.
static GameEntityData * getDefaultObjectInstance ()
Get the reference object that contains the default values for attributes of instances of this class.

Protected Member Functions

GameEntityData (GameEntityData *defaults=NULL)
Construct a GameEntityData class definition.
virtual ~GameEntityData ()
Default destructor.

Detailed Description

All In Game classes and objects.

Later in hierarchy tree objtype changes to 'object' when actual game objects are made.

Member Function Documentation

static GameEntityData* Atlas::Objects::Entity::GameEntityData::alloc () [static]

Allocate a new instance of this class, using an existing instance if available.

This is the key function for implementing the memory pool for the Atlas::Objects API.

Reimplemented from Atlas::Objects::Entity::RootEntityData.

virtual void Atlas::Objects::Entity::GameEntityData::free () [virtual]

Free an instance of this class, returning it to the memory pool.

This function in combination with alloc() handle the memory pool.

Reimplemented from Atlas::Objects::Entity::RootEntityData.

virtual GameEntityData* Atlas::Objects::Entity::GameEntityData::getDefaultObject () [virtual]

Get the reference object that contains the default values for attributes of instances of the same class as this object.

Returns:

a pointer to the default object.

Reimplemented from Atlas::Objects::Entity::RootEntityData.

static GameEntityData* Atlas::Objects::Entity::GameEntityData::getDefaultObjectInstance () [static]

Get the reference object that contains the default values for attributes of instances of this class.

Returns:

a pointer to the default object.

Reimplemented from Atlas::Objects::Entity::RootEntityData.

Author

Generated automatically by Doxygen for Atlas-C++ from the source code.