Atlas-C++
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Atlas::Objects::Entity::GameEntityData Class Reference

All In Game classes and objects. More...

#include <Entity.h>

Inheritance diagram for Atlas::Objects::Entity::GameEntityData:
Atlas::Objects::Entity::RootEntityData Atlas::Objects::RootData Atlas::Objects::BaseObjectData

Public Member Functions

virtual GameEntityDatacopy () 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. More...
 
virtual GameEntityDatagetDefaultObject ()
 Get the reference object that contains the default values for attributes of instances of the same class as this object. More...
 
- Public Member Functions inherited from Atlas::Objects::Entity::RootEntityData
virtual int copyAttr (const std::string &name, Atlas::Message::Element &attr) const
 Retrieve the attribute "name". More...
 
virtual void setAttr (const std::string &name, const Atlas::Message::Element &attr)
 Set the attribute "name" to the value given by"attr".
 
virtual void removeAttr (const std::string &name)
 Remove the attribute "name". This will not work for static attributes.
 
virtual void sendContents (Atlas::Bridge &b) const
 Send the contents of this object to a Bridge.
 
virtual void addToMessage (Atlas::Message::MapType &) const
 Write this object to an existing Element.
 
void setLoc (const std::string &val)
 Set the "loc" attribute.
 
void setPos (const std::vector< double > &val)
 Set the "pos" attribute.
 
void setPosAsList (const Atlas::Message::ListType &val)
 Set the "pos" attribute AsList.
 
void setVelocity (const std::vector< double > &val)
 Set the "velocity" attribute.
 
void setVelocityAsList (const Atlas::Message::ListType &val)
 Set the "velocity" attribute AsList.
 
void setContains (const std::list< std::string > &val)
 Set the "contains" attribute.
 
void setContainsAsList (const Atlas::Message::ListType &val)
 Set the "contains" attribute AsList.
 
void setStampContains (double val)
 Set the "stamp_contains" attribute.
 
const std::string & getLoc () const
 Retrieve the "loc" attribute.
 
std::string & modifyLoc ()
 Retrieve the "loc" attribute as a non-const reference.
 
const std::vector< double > & getPos () const
 Retrieve the "pos" attribute.
 
std::vector< double > & modifyPos ()
 Retrieve the "pos" attribute as a non-const reference.
 
const Atlas::Message::ListType getPosAsList () const
 Retrieve the "pos" attribute AsList.
 
const std::vector< double > & getVelocity () const
 Retrieve the "velocity" attribute.
 
std::vector< double > & modifyVelocity ()
 Retrieve the "velocity" attribute as a non-const reference.
 
const Atlas::Message::ListType getVelocityAsList () const
 Retrieve the "velocity" attribute AsList.
 
const std::list< std::string > & getContains () const
 Retrieve the "contains" attribute.
 
std::list< std::string > & modifyContains ()
 Retrieve the "contains" attribute as a non-const reference.
 
const Atlas::Message::ListType getContainsAsList () const
 Retrieve the "contains" attribute AsList.
 
double getStampContains () const
 Retrieve the "stamp_contains" attribute.
 
double & modifyStampContains ()
 Retrieve the "stamp_contains" attribute as a non-const reference.
 
bool isDefaultLoc () const
 Is "loc" value default?
 
bool isDefaultPos () const
 Is "pos" value default?
 
bool isDefaultVelocity () const
 Is "velocity" value default?
 
bool isDefaultContains () const
 Is "contains" value default?
 
bool isDefaultStampContains () const
 Is "stamp_contains" value default?
 
- Public Member Functions inherited from Atlas::Objects::RootData
void setId (const std::string &val)
 Set the "id" attribute.
 
void setParents (const std::list< std::string > &val)
 Set the "parents" attribute.
 
void setParentsAsList (const Atlas::Message::ListType &val)
 Set the "parents" attribute AsList.
 
void setStamp (double val)
 Set the "stamp" attribute.
 
void setObjtype (const std::string &val)
 Set the "objtype" attribute.
 
void setName (const std::string &val)
 Set the "name" attribute.
 
const std::string & getId () const
 Retrieve the "id" attribute.
 
std::string & modifyId ()
 Retrieve the "id" attribute as a non-const reference.
 
const std::list< std::string > & getParents () const
 Retrieve the "parents" attribute.
 
std::list< std::string > & modifyParents ()
 Retrieve the "parents" attribute as a non-const reference.
 
const Atlas::Message::ListType getParentsAsList () const
 Retrieve the "parents" attribute AsList.
 
double getStamp () const
 Retrieve the "stamp" attribute.
 
double & modifyStamp ()
 Retrieve the "stamp" attribute as a non-const reference.
 
const std::string & getObjtype () const
 Retrieve the "objtype" attribute.
 
std::string & modifyObjtype ()
 Retrieve the "objtype" attribute as a non-const reference.
 
const std::string & getName () const
 Retrieve the "name" attribute.
 
std::string & modifyName ()
 Retrieve the "name" attribute as a non-const reference.
 
bool isDefaultId () const
 Is "id" value default?
 
bool isDefaultParents () const
 Is "parents" value default?
 
bool isDefaultStamp () const
 Is "stamp" value default?
 
bool isDefaultObjtype () const
 Is "objtype" value default?
 
bool isDefaultName () const
 Is "name" value default?
 
- Public Member Functions inherited from Atlas::Objects::BaseObjectData
 BaseObjectData (BaseObjectData *defaults)
 Construct a new BaseObjectData from a subclass. More...
 
int getClassNo () const
 Get class number:
 
int getAttrFlags () const
 
bool hasAttr (const std::string &name) const
 Check whether the attribute "name" exists.
 
bool hasAttrFlag (int flag) const
 Check whether the attribute "name" exists.
 
const Atlas::Message::Element getAttr (const std::string &name) const
 Retrieve the attribute "name". More...
 
virtual void removeAttrFlag (int flag)
 Remove the attribute "name".
 
const Atlas::Message::MapType asMessage () const
 Convert this object to a Object. More...
 
void incRef ()
 
void decRef ()
 
iterator begin ()
 
iterator end ()
 
iterator find (const std::string &)
 
const_iterator begin () const
 
const_iterator end () const
 
const_iterator find (const std::string &) const
 

Static Public Member Functions

static GameEntityDataalloc ()
 
static GameEntityDatagetDefaultObjectInstance ()
 Get the reference object that contains the default values for attributes of instances of this class. More...
 
- Static Public Member Functions inherited from Atlas::Objects::Entity::RootEntityData
static RootEntityDataalloc ()
 
static RootEntityDatagetDefaultObjectInstance ()
 Get the reference object that contains the default values for attributes of instances of this class. More...
 
- Static Public Member Functions inherited from Atlas::Objects::RootData
static RootDataalloc ()
 
static RootDatagetDefaultObjectInstance ()
 Get the reference object that contains the default values for attributes of instances of this class. More...
 
- Static Public Member Functions inherited from Atlas::Objects::BaseObjectData
static BaseObjectDataalloc ()
 Allocate a new instance of this class, using an existing instance if available. More...
 

Protected Member Functions

 GameEntityData (GameEntityData *defaults=NULL)
 Construct a GameEntityData class definition.
 
virtual ~GameEntityData ()
 Default destructor.
 
- Protected Member Functions inherited from Atlas::Objects::Entity::RootEntityData
 RootEntityData (RootEntityData *defaults=NULL)
 Construct a RootEntityData class definition.
 
virtual ~RootEntityData ()
 Default destructor.
 
virtual int getAttrClass (const std::string &name) const
 Find the class which contains the attribute "name".
 
virtual int getAttrFlag (const std::string &name) const
 Find the flag for the attribute "name".
 
void sendLoc (Atlas::Bridge &) const
 Send the "loc" attribute to an Atlas::Bridge.
 
void sendPos (Atlas::Bridge &) const
 Send the "pos" attribute to an Atlas::Bridge.
 
void sendVelocity (Atlas::Bridge &) const
 Send the "velocity" attribute to an Atlas::Bridge.
 
void sendContains (Atlas::Bridge &) const
 Send the "contains" attribute to an Atlas::Bridge.
 
void sendStampContains (Atlas::Bridge &) const
 Send the "stamp_contains" attribute to an Atlas::Bridge.
 
- Protected Member Functions inherited from Atlas::Objects::RootData
 RootData (RootData *defaults=NULL)
 Construct a RootData class definition.
 
virtual ~RootData ()
 Default destructor.
 
void sendId (Atlas::Bridge &) const
 Send the "id" attribute to an Atlas::Bridge.
 
void sendParents (Atlas::Bridge &) const
 Send the "parents" attribute to an Atlas::Bridge.
 
void sendStamp (Atlas::Bridge &) const
 Send the "stamp" attribute to an Atlas::Bridge.
 
void sendObjtype (Atlas::Bridge &) const
 Send the "objtype" attribute to an Atlas::Bridge.
 
void sendName (Atlas::Bridge &) const
 Send the "name" attribute to an Atlas::Bridge.
 

Additional Inherited Members

- Protected Attributes inherited from Atlas::Objects::Entity::RootEntityData
std::string attr_loc
 Reference object for coordinates (location).
 
std::vector< double > attr_pos
 Position coordinates, usually world is 3D.
 
std::vector< double > attr_velocity
 Velocity object is moving, usually world is 3D.
 
std::list< std::string > attr_contains
 List of objects that use this object as reference system (usually same as what this object contains).
 
double attr_stamp_contains
 Last time any object that uses this as reference recursively has been modified.
 
- Protected Attributes inherited from Atlas::Objects::RootData
std::string attr_id
 Id of object.
 
std::list< std::string > attr_parents
 List of objects this inherits attributes from.
 
double attr_stamp
 Last time this object was modified.
 
std::string attr_objtype
 What kind of object this is.
 
std::string attr_name
 Name of object.
 
- Protected Attributes inherited from Atlas::Objects::BaseObjectData
int m_class_no
 
int m_refCount
 
BaseObjectDatam_defaults
 
BaseObjectDatam_next
 
std::map< std::string, Atlas::Message::Elementm_attributes
 
int m_attrFlags
 

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

◆ free()

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.

◆ getDefaultObject()

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.

◆ getDefaultObjectInstance()

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.

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

Copyright 2000-2004 the respective authors.

This document can be licensed under the terms of the GNU Free Documentation License or the GNU General Public License and may be freely distributed under the terms given by one of these licenses.