#include <iso_space_neighbors.h>
Collaboration diagram for iso::space::Neighbors:
Public Member Functions | |
Neighbors (SpaceObject *pSpaceObject) | |
create neighbor collection | |
~Neighbors () | |
destructor | |
unsigned int | neighborGroupCount () const |
return number of neighbor groups | |
bool | checkNeighborGroup (const base::String &pSpaceName) |
check whether neighbor collection for space exists | |
unsigned int | neighborGroupIndex (const base::String &pSpaceName) |
return neighbor group index | |
NeighborGroup & | neighborGroup (unsigned int pIndex) |
return neighbor collection based on index | |
NeighborGroup & | neighborGroup (const base::String &pSpaceName) |
return neighbor collection for a particular space | |
void | addNeighborGroup (NeighborGroup *pNeighborGroup) |
add new neighbor group | |
void | removeNeighborGroup (NeighborGroup *pNeighborGroup) |
remove neighbor group | |
bool | canHaveNeighbors (const base::String &pSpaceName) const |
check whether this object can have neighbors in a particular space | |
bool | visible (const base::String &pSpaceName) const |
check whether this object is visible or not | |
void | setVisible (bool pVisible) |
set object visibility in all spaces | |
void | setVisible (const base::String &pSpaceName, bool pVisible) |
set object visibility in particular space | |
real | neighborRadius (const base::String &pSpaceName) const |
return neighbor radius | |
bool | replaceNeighborMode (const base::String &pSpaceName) const |
unsigned int | maxNeighborCount (const base::String &pSpaceName) const |
return maximum number of neighbors | |
unsigned int | neighborCount (const base::String &pSpaceName) const |
return number of neighbors | |
bool | full (const base::String &pSpaceName) const |
returns true if no more neighbors can be added to neighbor list | |
SpaceObject * | neighbor (const base::String &pSpaceName, unsigned int pIndex) |
return neighboring space object | |
const math::Vector< real > & | direction (const base::String &pSpaceName, unsigned int pIndex) const |
return direction vector pointing to neighboring space object | |
real | distance (const base::String &pSpaceName, unsigned int pIndex) const |
return distance to neighboring space object | |
QVector< SpaceNeighborRelation * > & | neighborRelations (const base::String &pSpaceName) |
return neighbor relations | |
SpaceNeighborRelation * | neighborRelation (const base::String &pSpaceName, unsigned int pIndex) |
return neighbor relation | |
bool | addNeighbor (const base::String &pSpaceName, SpaceObject *pNeighborObject) |
add neighbor object to neighbor list | |
bool | addNeighbor (const base::String &pSpaceName, SpaceObject *pNeighborObject, real pDistance, const math::Vector< real > &pDirection) |
add neighbor object to neighbor list | |
void | removeNeighbors () |
remove all neighbors from all spaces | |
void | removeNeighbors (const base::String &pSpaceName) |
remove all neighbors from a single space | |
virtual base::String | info (int pPropagationLevel=0) const |
print neighbor group information | |
Protected Member Functions | |
Neighbors () | |
default constructor | |
Protected Attributes | |
SpaceObject * | mSpaceObject |
space object this neighborlists is part of | |
data::IndexHash< base::String, NeighborGroup > | mNeighborGroups |
storage for single space neighbor collections | |
Friends | |
std::ostream & | operator<< (std::ostream &pOstream, const Neighbors &pNeighborGroup) |
retrieve textual neighbor group info |
for space neighbor groups
Created by Daniel Bisig on 10/6/07.
Neighbors::Neighbors | ( | SpaceObject * | pSpaceObject | ) |
create neighbor collection
pSpaceObject | space object this neighbor collection is part of |
Neighbors::~Neighbors | ( | ) |
destructor
Neighbors::Neighbors | ( | ) | [protected] |
default constructor
unsigned int Neighbors::neighborGroupCount | ( | ) | const |
return number of neighbor groups
bool Neighbors::checkNeighborGroup | ( | const base::String & | pSpaceName | ) |
check whether neighbor collection for space exists
pSpaceName | space name |
unsigned int Neighbors::neighborGroupIndex | ( | const base::String & | pSpaceName | ) |
return neighbor group index
pSpaceName | space name |
NeighborGroup & Neighbors::neighborGroup | ( | unsigned int | pIndex | ) |
return neighbor collection based on index
pIndex | index neighbor collection |
NeighborGroup & Neighbors::neighborGroup | ( | const base::String & | pSpaceName | ) |
return neighbor collection for a particular space
pSpaceName | space name |
void Neighbors::addNeighborGroup | ( | NeighborGroup * | pNeighborGroup | ) |
add new neighbor group
pNeighborGroup | new neighbor group |
void Neighbors::removeNeighborGroup | ( | NeighborGroup * | pNeighborGroup | ) |
remove neighbor group
pNeighborGroup | neighbor group to remove |
bool Neighbors::canHaveNeighbors | ( | const base::String & | pSpaceName | ) | const |
check whether this object can have neighbors in a particular space
pSpaceName | space name |
bool Neighbors::visible | ( | const base::String & | pSpaceName | ) | const |
check whether this object is visible or not
pSpaceName | name of space |
void Neighbors::setVisible | ( | bool | pVisible | ) |
set object visibility in all spaces
pVisible | object visibility |
void Neighbors::setVisible | ( | const base::String & | pSpaceName, | |
bool | pVisible | |||
) |
set object visibility in particular space
pSpaceName | name of space | |
pVisible | object visibility |
space::real Neighbors::neighborRadius | ( | const base::String & | pSpaceName | ) | const |
return neighbor radius
bool Neighbors::replaceNeighborMode | ( | const base::String & | pSpaceName | ) | const |
unsigned int Neighbors::maxNeighborCount | ( | const base::String & | pSpaceName | ) | const |
return maximum number of neighbors
pSpaceName | space name |
unsigned int Neighbors::neighborCount | ( | const base::String & | pSpaceName | ) | const |
return number of neighbors
pSpaceName | space name |
bool Neighbors::full | ( | const base::String & | pSpaceName | ) | const |
returns true if no more neighbors can be added to neighbor list
pSpaceName | space name |
SpaceObject * Neighbors::neighbor | ( | const base::String & | pSpaceName, | |
unsigned int | pIndex | |||
) |
return neighboring space object
pSpaceName | space name | |
pIndex | neighbor index |
const math::Vector< space::real > & Neighbors::direction | ( | const base::String & | pSpaceName, | |
unsigned int | pIndex | |||
) | const |
return direction vector pointing to neighboring space object
pSpaceName | space name | |
pIndex | neighbor index |
space::real Neighbors::distance | ( | const base::String & | pSpaceName, | |
unsigned int | pIndex | |||
) | const |
return distance to neighboring space object
pSpaceName | space name | |
pIndex | neighbor index |
QVector< SpaceNeighborRelation * > & Neighbors::neighborRelations | ( | const base::String & | pSpaceName | ) |
return neighbor relations
pSpaceName | space name |
SpaceNeighborRelation * Neighbors::neighborRelation | ( | const base::String & | pSpaceName, | |
unsigned int | pIndex | |||
) |
return neighbor relation
pSpaceName | space name | |
pIndex | neighbor index |
bool Neighbors::addNeighbor | ( | const base::String & | pSpaceName, | |
SpaceObject * | pNeighborObject | |||
) |
add neighbor object to neighbor list
pSpaceName | space name | |
pNeighborObject | neighbor space object |
bool Neighbors::addNeighbor | ( | const base::String & | pSpaceName, | |
SpaceObject * | pNeighborObject, | |||
real | pDistance, | |||
const math::Vector< real > & | pDirection | |||
) |
add neighbor object to neighbor list
pSpaceName | space name | |
pNeighborObject | neighbor space object | |
pDistance | distance | |
pDirection | direction |
void Neighbors::removeNeighbors | ( | ) |
remove all neighbors from all spaces
void Neighbors::removeNeighbors | ( | const base::String & | pSpaceName | ) |
remove all neighbors from a single space
base::String Neighbors::info | ( | int | pPropagationLevel = 0 |
) | const [virtual] |
print neighbor group information
pPropagationLevel | how far the propagation method proceeds through composite classes (-1: unlimited, 0: no proceeding, >0: limited proceeding) |
std::ostream& operator<< | ( | std::ostream & | pOstream, | |
const Neighbors & | pNeighborGroup | |||
) | [friend] |
retrieve textual neighbor group info
pOstream | output text stream | |
pNeighborGroup | neighbor group |
SpaceObject* iso::space::Neighbors::mSpaceObject [protected] |
space object this neighborlists is part of
data::IndexHash<base::String, NeighborGroup> iso::space::Neighbors::mNeighborGroups [protected] |
storage for single space neighbor collections