JSVisibleData is the interface for accessing data about visibles. More...
#include <JSVisibleData.hpp>
Inheritance diagram for Sirikata::JS::JSVisibleData:
Collaboration diagram for Sirikata::JS::JSVisibleData:
Public Member Functions | |
| JSVisibleData (JSVisibleDataListener *parent) | |
| ~JSVisibleData () | |
| virtual const SpaceObjectReference & | id ()=0 |
| ID of this object in the space. | |
| virtual const SpaceObjectReference & | observer ()=0 |
| ID of the observing presence of this object. | |
| virtual void | disable () |
Protected Member Functions | |
| void | clearFromParent () |
Protected Attributes | |
| JSVisibleDataListener * | mParent |
Detailed Description
JSVisibleData is the interface for accessing data about visibles.
It is only an interface because we need to support regular operation (against ProxyObjects) and special cases (like during restoration, when we've stored a copy of values but don't have access to a real ProxyObject.
You actually can't assume much about what's available and valid in here because visibles can come from so many places: if they originate from proximity results (they are backed by ProxyObjects) they'll hold all information, but they can also be restored (not associated with a particular parent presence), can be deserialized from a message from another host (in which case we'd just get an identifier) or just be the origin of a message (again, meaning only the ID will be valid).
Constructor & Destructor Documentation
| Sirikata::JS::JSVisibleData::JSVisibleData | ( | JSVisibleDataListener * | parent | ) | [inline] |
| Sirikata::JS::JSVisibleData::~JSVisibleData | ( | ) |
Member Function Documentation
| void Sirikata::JS::JSVisibleData::clearFromParent | ( | ) | [protected] |
| void Sirikata::JS::JSVisibleData::disable | ( | ) | [virtual] |
Reimplemented in Sirikata::JS::JSProxyVisibleData, and Sirikata::JS::JSAggregateVisibleData.
References mParent.
| virtual const SpaceObjectReference& Sirikata::JS::JSVisibleData::id | ( | ) | [pure virtual] |
ID of this object in the space.
Implemented in Sirikata::JS::JSRestoredVisibleData, Sirikata::JS::JSProxyVisibleData, and Sirikata::JS::JSAggregateVisibleData.
Referenced by Sirikata::JS::JSVisibleManager::removeVisibleData().
| virtual const SpaceObjectReference& Sirikata::JS::JSVisibleData::observer | ( | ) | [pure virtual] |
ID of the observing presence of this object.
Implemented in Sirikata::JS::JSRestoredVisibleData, Sirikata::JS::JSProxyVisibleData, and Sirikata::JS::JSAggregateVisibleData.
Referenced by Sirikata::JS::JSAggregateVisibleData::removeVisibleData().
Member Data Documentation
Referenced by clearFromParent(), and disable().
The documentation for this class was generated from the following files:
- liboh/plugins/js/JSVisibleData.hpp
- liboh/plugins/js/JSVisibleData.cpp
