Entity is a concrete (instantiable) class representing one game entity. More...
#include <Entity.h>
Classes | |
| class | DynamicState |
Public Types | |
| typedef std::map< std::string, Atlas::Message::Element > | AttrMap |
| typedef sigc::slot< void, const Atlas::Message::Element & > | AttrChangedSlot |
| A slot which can be used for receiving attribute update signals. | |
Public Member Functions | |
| Entity (const std::string &id, TypeInfo *ty) | |
| virtual void | shutdown () |
| Shuts down the entity. More... | |
| unsigned int | numContained () const |
| Gets the number of contained entities, i.e. More... | |
| Entity * | getContained (unsigned int index) const |
| Gets the child entity at the specified index. More... | |
| const Atlas::Message::Element & | valueOfAttr (const std::string &attr) const |
| Gets the value of a named attribute. More... | |
| bool | hasAttr (const std::string &p) const |
| Checks whether an attribute exists. More... | |
| sigc::connection | observe (const std::string &attr, const AttrChangedSlot &aslot) |
| Setup an observer so that the specified slot is fired when the named attribue's value changes. More... | |
| const std::string & | getId () const |
| Retrieve the unique entity ID. More... | |
| const std::string & | getName () const |
| Gets the name of the entity. More... | |
| float | getStamp () const |
| Access the current time-stamp of the entity. More... | |
| TypeInfo * | getType () const |
| Gets the type of this entity. More... | |
| Entity * | getLocation () const |
| The containing entity, or null if this is a top-level visible entity. More... | |
| WFMath::Point< 3 > | getPosition () const |
| Returns the Entity's position inside it's parent in the parent's local system coordinates. More... | |
| const AttrMap | getAttributes () const |
| Gets all attributes defined for this entity. More... | |
| const AttrMap & | getInstanceAttributes () const |
| Gets all locally defined attributes. More... | |
| bool | isMoving () const |
| Test if this entity has a non-zero velocity vector. More... | |
| WFMath::Point< 3 > | getPredictedPos () const |
| Retrieve the predicted position of this entity, based on it's velocity and acceleration. More... | |
| WFMath::Vector< 3 > | getPredictedVelocity () const |
| Retrieve the current predicted velocity of an entity. More... | |
| WFMath::Point< 3 > | getViewPosition () const |
| retreive this Entity's position in view coordinates. More... | |
| WFMath::Quaternion | getViewOrientation () const |
| retreive this Entity's orientation in view coordinates. More... | |
| const WFMath::Vector< 3 > & | getVelocity (void) const |
| Returns the entity's velocity as last set explicitely. More... | |
| const WFMath::Quaternion & | getOrientation (void) const |
| Returns the entity's orientation as last set explicitely. More... | |
| const WFMath::AxisBox< 3 > & | getBBox (void) const |
| Returns the entity's bounding box in the entity's local system coordinates. More... | |
| bool | hasBBox () const |
| Returns true if the entity has a bounding box. More... | |
| const TaskArray & | getTasks () const |
| Gets the tasks associated with this entity. More... | |
| TypeInfoArray | getUseOperations () const |
| Get a list of operations supported by this entity (tool) If the entity does no provide an operations list, this will return an empty array. | |
| bool | hasChild (const std::string &eid) const |
| bool | isVisible () const |
| determine if this entity is visible. More... | |
| template<class C > | |
| C | toLocationCoords (const C &c) const |
| template<class C > | |
| C | fromLocationCoords (const C &c) const |
| WFMath::Vector< 3 > | toLocationCoords (const WFMath::Vector< 3 > &v) const |
| WFMath::Vector< 3 > | fromLocationCoords (const WFMath::Vector< 3 > &v) const |
Static Public Member Functions | |
| static bool | extractEntityId (const Atlas::Message::Element &element, std::string &id) |
| Extracts an entity id from the supplied element. More... | |
Public Attributes | |
| sigc::signal< void, Entity * > | ChildAdded |
| sigc::signal< void, Entity * > | ChildRemoved |
| sigc::signal< void, Entity * > | LocationChanged |
| Signal that the entity's container changed. More... | |
| sigc::signal< void, const StringSet & > | Changed |
| Emitted when one or more attributes change. More... | |
| sigc::signal< void > | Moved |
| Emitted when then entity's position, orientation or velocity change. More... | |
| sigc::signal< void, bool > | Moving |
| Emitted when an entity starts or stops moving (as determined by the 'inMotion' method. More... | |
| sigc::signal< void, const Atlas::Objects::Root &> | Say |
| Emitted with the entity speaks. More... | |
| sigc::signal< void, const std::string & > | Emote |
| Emitted when this entity emits an imaginary operation (also known as an emote. More... | |
| sigc::signal< void, const Atlas::Objects::Operation::RootOperation & > | Acted |
| Emitted when this entity performs an action. More... | |
| sigc::signal< void, const Atlas::Objects::Root & > | Noise |
| Emitted when this entity performs an action which causes a noise. More... | |
| sigc::signal< void, bool > | VisibilityChanged |
| Emitted when the visibility of the entity changes. More... | |
| sigc::signal< void > | BeingDeleted |
| Emitted prior to deletion. More... | |
| sigc::signal< void, Task * > | TaskAdded |
| Emitted when a task has been added to the entity. More... | |
| sigc::signal< void, Task * > | TaskRemoved |
| Emitted when a task has been removed from the entity. More... | |
Protected Types | |
| typedef std::map< std::string, Entity * > | IdEntityMap |
| typedef sigc::signal< void, const Atlas::Message::Element & > | AttrChangedSignal |
| typedef std::map< std::string, AttrChangedSignal > | ObserverMap |
Protected Member Functions | |
| virtual void | init (const Atlas::Objects::Entity::RootEntity &ge, bool fromCreateOp) |
| over-rideable initialisation helper. More... | |
| virtual void | onTalk (const Atlas::Objects::Operation::RootOperation &talk) |
| process TALK data - default implementation emits the Say signal. More... | |
| virtual void | onAttrChanged (const std::string &attr, const Atlas::Message::Element &v) |
| virtual void | onLocationChanged (Entity *oldLoc) |
| virtual void | onMoved () |
| over-rideable hook method when then Entity position, orientation or velocity change. More... | |
| virtual void | onVisibilityChanged (bool vis) |
| over-rideable hook when the actual (computed) visiblity of this entity changed. More... | |
| virtual void | onAction (const Atlas::Objects::Operation::RootOperation &act) |
| Over-rideable hook when this entity is seen to perform an action. More... | |
| virtual void | onSoundAction (const Atlas::Objects::Operation::RootOperation &op) |
| Over-rideable hook when this entity is heard performing an action. More... | |
| virtual void | onImaginary (const Atlas::Objects::Root &act) |
| Over-rideable hook when this entity is seen to emit an imginary op. More... | |
| virtual void | setMoving (bool moving) |
| over-rideable hook for when the entity changes from stationary to moving or vice-versa. More... | |
| virtual void | onChildAdded (Entity *child) |
| Over-rideable hook when child entities are added. More... | |
| virtual void | onChildRemoved (Entity *child) |
| Over-rideable hook when child entities are removed. More... | |
| virtual void | onTaskAdded (Task *task) |
| Over-rideable hook for when tasks are added. More... | |
| void | sight (const Atlas::Objects::Entity::RootEntity &gent) |
| Fully initialise all entity state based on a RootEntity, including location and contents. | |
| void | setFromRoot (const Atlas::Objects::Root &obj, bool allowMotion, bool includeTypeInfoAttributes=false) |
| Initialise all simple state from a Root. More... | |
| void | setVisible (bool vis) |
| the View calls this to change local entity visibility. More... | |
| void | setAttr (const std::string &p, const Atlas::Message::Element &v) |
| bool | nativeAttrChanged (const std::string &p, const Atlas::Message::Element &v) |
| Map Atlas attributes to natively stored properties. More... | |
| void | typeInfo_AttributeChanges (const std::string &attributeName, const Atlas::Message::Element &element) |
| Connected to the TypeInfo::AttributeChanges event. More... | |
| virtual void | attrChangedFromTypeInfo (const std::string &attributeName, const Atlas::Message::Element &element) |
| Called when an attribute has been changed in the TypeInfo for this entity. More... | |
| void | fillAttributesFromType (Entity::AttrMap &attributes, TypeInfo *typeInfo) const |
| Utility method for recursively filling a map of attributes from a TypeInfo instance. More... | |
| void | beginUpdate () |
| void | addToUpdate (const std::string &attr) |
| void | endUpdate () |
| void | setLocationFromAtlas (const std::string &locId) |
| update the entity's location based on Atlas data. More... | |
| void | setLocation (Entity *newLocation) |
| setLocation is the core of the entity hierarchy maintenance logic. More... | |
| void | setContentsFromAtlas (const StringList &contents) |
| wrapper for setLocation with additional code the retrive the location if it's not available right now | |
| void | filterMoveAttrs (Atlas::Message::MapType &attrs) const |
| Remove from a map all items whose key is a movement related attribute, eg position or velocity. | |
| void | buildEntityDictFromContents (IdEntityMap &dict) |
| void | addChild (Entity *e) |
| void | removeChild (Entity *e) |
| void | addToLocation () |
| void | removeFromLocation () |
| void | updateTasks (const Atlas::Message::Element &e) |
| void | removeTask (Task *t) |
| void | updateCalculatedVisibility (bool wasVisible) |
| recursively update the real visiblity of this entity, and fire appropriate signals. More... | |
| void | updatePredictedState (const WFMath::TimeStamp &t) |
| void | createAlarmExpired () |
| virtual TypeService * | getTypeService () const =0 |
| Gets the typeservice used throughout the Eris system. More... | |
| virtual void | removeFromMovementPrediction ()=0 |
| Removes the entity from any movement prediction service. More... | |
| virtual void | addToMovementPredition ()=0 |
| Adds the entity to any movement prediction service. More... | |
| virtual Entity * | getEntity (const std::string &id)=0 |
| Gets an entity with the supplied id from the system. More... | |
Protected Attributes | |
| AttrMap | m_attrs |
| TypeInfo * | m_type |
| Entity * | m_location |
| EntityArray | m_contents |
| const std::string | m_id |
| the Atlas object ID | |
| std::string | m_name |
| a human readable name | |
| float | m_stamp |
| last modification time (in seconds) | |
| std::string | m_description |
| bool | m_visible |
| bool | m_limbo |
| waiting for parent bind | |
| WFMath::AxisBox< 3 > | m_bbox |
| WFMath::Point< 3 > | m_position |
| WFMath::Vector< 3 > | m_velocity |
| WFMath::Quaternion | m_orientation |
| WFMath::Vector< 3 > | m_acc |
| DynamicState | m_predicted |
| int | m_updateLevel |
| If greater than zero, we are doing a batched update. More... | |
| StringSet | m_modifiedAttrs |
| When a batched property update is in progress, the set tracks the names of each modified property. More... | |
| ObserverMap | m_observers |
| bool | m_hasBBox |
| This flag should be set when the server notifies that this entity has a bounding box. More... | |
| WFMath::TimeStamp | m_lastMoveTime |
| bool | m_moving |
| flag recording if this entity is current considered in-motion | |
| bool | m_recentlyCreated |
| flag set if this entity was the subject of a sight(create) | |
| TaskArray | m_tasks |
| bool | m_initialised |
Friends | |
| class | IGRouter |
| class | View |
| class | Task |
Detailed Description
Entity is a concrete (instantiable) class representing one game entity.
Entity encapsulates the state and tracking of one game entity; this includes it's location in the containership tree (graph?), it's name and unique and id, and so on.
This class may be sub-classed by users (and those sub-classes built via a Factory), to allow specific functionality. This means there are two integration strategies; either subclassing and over-riding virtual functions, or creating peer clases and attaching them to the signals.
- Note
- If you handle entities manually, you must make sure to call shutdown() before the instance is deleted.
Member Function Documentation
◆ addToMovementPredition()
|
protectedpure virtual |
Adds the entity to any movement prediction service.
This is called when movement has started.
Implemented in Eris::ViewEntity.
◆ attrChangedFromTypeInfo()
|
protectedvirtual |
Called when an attribute has been changed in the TypeInfo for this entity.
If the attribute doesn't have an instance value local to this entity the event will be processed just like a call to setAttr but without the attribute being saved in the map of instance attributes.
- Parameters
-
attributeName The name of the attribute which is to be changed. element The new element data.
Only fire the events if there's no attribute already defined for this entity
References Eris::Task::name().
◆ extractEntityId()
|
static |
Extracts an entity id from the supplied element.
There are two ways to express entity ids; either as a string, or as a map with one entry named "$eid" (where the string is the value). The function parses the element for these two cases, if found fills the "id" parameter and then returns true.
- Parameters
-
element The element which we want to extract from. id The string where the id, if found, will be placed.
- Returns
- True if an id could be found.
Referenced by Eris::Avatar::onAvatarEntityDeleted().
◆ fillAttributesFromType()
|
protected |
Utility method for recursively filling a map of attributes from a TypeInfo instance.
The method will recursively call itself to make sure that the topmost TypeInfo is used first. This makes sure that attributes are overwritten by newer values, if duplicates exists.
- Parameters
-
attributes The map of attributes to fill. typeInfo The type info from which we will copy values, as well as its parents.
Make sure to fill from the closest attributes first, as insert won't replace an existing value
References Eris::TypeInfo::getAttributes(), and Eris::TypeInfo::getParents().
◆ getAttributes()
| const Entity::AttrMap Eris::Entity::getAttributes | ( | ) | const |
Gets all attributes defined for this entity.
The collection of entities returned will include both local attributes as well as the defaults set in the TypeInfo (and all of its parents) of this entity.
- Note
- This is a rather expensive operation since it needs to iterate over all parent TypeInfo instances and build up a map, which is then returned by value. If you only want to get a single attribute you should instead use the valueOfAttr method.
- See also
- getInstanceAttributes() for a similiar method which only returns those attributes that are local to this entity.
- Returns
- A map of the combined attributes of both this entity and all of it's TypeInfo parents.
Merge both the local attributes and the type default attributes.
◆ getBBox()
|
inline |
Returns the entity's bounding box in the entity's local system coordinates.
◆ getContained()
|
inline |
Gets the child entity at the specified index.
- Parameters
-
index An index for the collection of child entities. This must be a valid index as no bounds checking will happen.
- Returns
- A pointer to a child entity.
Referenced by Eris::View::taskRateChanged().
◆ getEntity()
|
protectedpure virtual |
Gets an entity with the supplied id from the system.
- Parameters
-
id The id of the entity to get.
Implemented in Eris::ViewEntity.
Referenced by Eris::View::taskRateChanged().
◆ getId()
|
inline |
Retrieve the unique entity ID.
- Returns
- The unique id of the entity.
Referenced by Eris::Avatar::attack(), Eris::Avatar::drop(), Eris::View::entityDeleted(), Eris::Avatar::moveToPoint(), Eris::Avatar::place(), setContentsFromAtlas(), setLocation(), Eris::Avatar::take(), Eris::Avatar::touch(), Eris::Avatar::useOn(), Eris::Avatar::useStop(), and Eris::Avatar::wield().
◆ getInstanceAttributes()
| const Entity::AttrMap & Eris::Entity::getInstanceAttributes | ( | ) | const |
Gets all locally defined attributes.
This will only return those attributes that are locally defined for this entity. In practice it will in most cases mean those attributes that have been changed by the defaults as defined in the TypeInfo instance.
- Note
- This will only return a subset of all attributes. If you need to iterate over all attributes you should instead use the getAttributes() method. If you only want the value of a specific attribute you should use the valueOfAttr method.
- See also
- getAttributes
- Returns
- The locally defined attributes for the entity.
◆ getLocation()
|
inline |
The containing entity, or null if this is a top-level visible entity.
the containing entity, or null if this is a top-level visible entity.
- Returns
- The containing entity, or null.
Referenced by Eris::Avatar::drop(), getViewOrientation(), getViewPosition(), Eris::View::isPending(), Eris::Avatar::moveToPoint(), setContentsFromAtlas(), Eris::View::taskRateChanged(), and Eris::Avatar::wield().
◆ getName()
|
inline |
Gets the name of the entity.
In contrast to getId() this is not unique, and doesn't even have to be set.
- Returns
- The name of the entity.
◆ getOrientation()
|
inline |
Returns the entity's orientation as last set explicitely.
Referenced by Eris::TerrainModObserver::parseMod(), and Eris::View::taskRateChanged().
◆ getPosition()
|
inline |
Returns the Entity's position inside it's parent in the parent's local system coordinates.
- Returns
- The position of the entity in parent relative coords.
Referenced by Eris::Avatar::drop(), Eris::TerrainModObserver::parseMod(), and Eris::View::taskRateChanged().
◆ getPredictedPos()
| WFMath::Point< 3 > Eris::Entity::getPredictedPos | ( | ) | const |
Retrieve the predicted position of this entity, based on it's velocity and acceleration.
If the entity is not moving, this is the same as calling getPosition().
- Returns
- The predicted position of the entity.
◆ getPredictedVelocity()
| WFMath::Vector< 3 > Eris::Entity::getPredictedVelocity | ( | ) | const |
Retrieve the current predicted velocity of an entity.
If the entity is not moving, this is an invalid Vector.
- Returns
- The predicted velocity of the entity.
◆ getStamp()
|
inline |
Access the current time-stamp of the entity.
- Returns
- The current time stamp.
Referenced by Eris::View::taskRateChanged().
◆ getTasks()
|
inline |
Gets the tasks associated with this entity.
- Returns
- The tasks associated with this entity.
◆ getType()
|
inline |
Gets the type of this entity.
- Returns
- The type of this entity. This can be null.
◆ getTypeService()
|
protectedpure virtual |
Gets the typeservice used throughout the Eris system.
- Returns
- A type service instance.
Implemented in Eris::ViewEntity.
◆ getVelocity()
|
inline |
Returns the entity's velocity as last set explicitely.
◆ getViewOrientation()
| WFMath::Quaternion Eris::Entity::getViewOrientation | ( | ) | const |
retreive this Entity's orientation in view coordinates.
References getLocation().
◆ getViewPosition()
| WFMath::Point< 3 > Eris::Entity::getViewPosition | ( | ) | const |
retreive this Entity's position in view coordinates.
References getLocation().
◆ hasAttr()
| bool Eris::Entity::hasAttr | ( | const std::string & | p | ) | const |
Checks whether an attribute exists.
- Parameters
-
p The name of the attribute.
- Returns
- True if the attribute exists.
first check with the instance attributes
it wasn't locally defines, now check with typeinfo
Referenced by Eris::TerrainModObserver::parseMod().
◆ hasBBox()
|
inline |
Returns true if the entity has a bounding box.
Not all entities have bounding boxes, but those that are represented as physical objects in the world f="classEris_0">
onMo.html emnam"#a5e6f9556235ca1ae47e5fb5bd973ab37">`tiaby()
onMo.html emnam"#a5e6f9556235ca1ae47e5fb5hasBBox()
Gets the type of this entity.
- Returns
- The type of this entity. Thidiv class="memproto">
ueOfAttr m"mlabels-right"> inliness="permalink">// FrameElement MyElement
Gets the type of this entity.
Not all entitie
Gets the type of this those att the Eris system.
Gets the type of this entity.
- Returns
- The type o/a>
Gets the type of
) const protectedces getLocation(). extractEntityId (const Atlas::Message::Element &element, std::s constGets the available spawn points from where the client can create new charactels"> - Returns
- True if the attribute exists.
first chectarget="_self">Response.
t>Returns
Entity *ssEris_1_1"paramname"> ) const If the entity is not moving, this is the same as calling
.
getTasks()
emnam"#a160; emnam"#a160; ) const proteedictedVelocity ( ( ) const tual t>Returns( 2d32713ac9s="paramname"> #€ØØ@lì19d predicted position