#include <iso_space_neighbor_group.h>
Collaboration diagram for iso::space::NeighborGroup:
Public Member Functions | |
NeighborGroup (SpaceObject *pSpaceObject, Space *pSpace, bool pVisible) | |
create neighbor collection | |
NeighborGroup (SpaceObject *pSpaceObject, Space *pSpace, bool pVisible, NeighborGroupAlg *pNeighborGroupAlg) | |
create neighbor collection | |
virtual | ~NeighborGroup () |
destructor | |
SpaceObject * | spaceObject () |
return space object this neighborlist is associated with | |
const SpaceObject * | spaceObject () const |
return space object this neighborlist is associated with | |
const base::String & | name () const |
return space name | |
Space * | space () |
return space this neighborlist is based on | |
bool | visible () const |
check whether the space object is visible or not | |
void | setVisible (bool pVisible) |
set space object visibility | |
bool | canHaveNeighbors () const |
check whether this neighbor group can have neighbors | |
NeighborGroupAlg * | neighborGroupAlg () |
return neighborhood algorithm | |
void | setNeighborGroupAlg (NeighborGroupAlg *pNeighborGroupAlg) |
set neigbhorhood algorithm | |
real | neighborRadius () const |
return neighbor radius | |
unsigned int | neighborCount () const |
return number of neighbors | |
unsigned int | maxNeighborCount () const |
return maximum number of neighbors | |
bool | replaceNeighborMode () const |
bool | full () const |
returns true if no more neighbors can be added to neighbor list | |
void | setNeighborRadius (real pNeighborRadius) |
set neighbor radius | |
SpaceObject * | neighbor (unsigned int pIndex) |
return neighboring space object | |
const SpaceObject * | neighbor (unsigned int pIndex) const |
return neighboring space object | |
const math::Vector< real > & | value (unsigned int pIndex) const |
return value of neighbor relation | |
const math::Vector< real > & | direction (unsigned int pIndex) const |
return direction of neighbor relation | |
real | distance (unsigned int pIndex) const |
return distance of neighbor relation | |
QVector< SpaceNeighborRelation * > & | neighborRelations () |
return neighbor relations | |
SpaceNeighborRelation * | neighborRelation (unsigned int pIndex) |
return neighbor relation | |
const SpaceNeighborRelation * | neighborRelation (unsigned int pIndex) const |
return neighbor relation | |
SpaceNeighborRelation * | operator[] (unsigned int pIndex) |
return neighbor relation | |
bool | addNeighbor (SpaceObject *pNeighborObject) |
add neighbor object to neighbor list | |
bool | addNeighbor (SpaceObject *pNeighborObject, real pDistance, const math::Vector< real > &pDirection) |
add neighbor object to neighbor list | |
void | removeNeighbor (SpaceObject *pNeighborObject) |
remove neighbor | |
void | removeNeighbor (unsigned int pNeighborIndex) |
remove neighbor | |
void | removeNeighbors () |
remove neighbors | |
virtual base::String | info (int pPropagationLevel=0) const |
print neighbor collection information | |
Static Public Attributes | |
static const base::String | sClassName |
class name | |
Protected Member Functions | |
NeighborGroup () | |
default constructor | |
Protected Attributes | |
SpaceObject * | mSpaceObject |
space object | |
Space * | mSpace |
space this neighborlist is based on | |
bool | mVisible |
visibility of space object in this space | |
NeighborGroupAlg * | mNeighborGroupAlg |
neighborhood algorithm | |
QVector< SpaceNeighborRelation * > | mNeighborRelations |
list of neighbor relations | |
Friends | |
class | SpaceProxyObject |
class | NeighborGroupAlg |
std::ostream & | operator<< (std::ostream &pOstream, const NeighborGroup &pNeighborGroup) |
retrieve textual neighbor group info |
NeighborGroup::NeighborGroup | ( | SpaceObject * | pSpaceObject, | |
Space * | pSpace, | |||
bool | pVisible | |||
) |
create neighbor collection
pSpaceObject | space object this neighborlist is part of | |
pSpace | space this neighborgroup is based on | |
pVisible | visiblity of space object |
NeighborGroup::NeighborGroup | ( | SpaceObject * | pSpaceObject, | |
Space * | pSpace, | |||
bool | pVisible, | |||
NeighborGroupAlg * | pNeighborGroupAlg | |||
) |
create neighbor collection
pSpaceObject | space object this neighbor list is part of | |
pSpace | space this neighborgroup is based on | |
pVisible | visiblity of space object | |
pNeighborGroupAlg | neighbor group algorithm |
NeighborGroup::~NeighborGroup | ( | ) | [virtual] |
destructor
NeighborGroup::NeighborGroup | ( | ) | [protected] |
default constructor
SpaceObject * NeighborGroup::spaceObject | ( | ) |
return space object this neighborlist is associated with
const SpaceObject * NeighborGroup::spaceObject | ( | ) | const |
return space object this neighborlist is associated with
const base::String & NeighborGroup::name | ( | ) | const |
return space name
Space * NeighborGroup::space | ( | ) |
return space this neighborlist is based on
bool NeighborGroup::visible | ( | ) | const |
check whether the space object is visible or not
void NeighborGroup::setVisible | ( | bool | pVisible | ) |
set space object visibility
pVisible | object visibility |
bool NeighborGroup::canHaveNeighbors | ( | ) | const |
check whether this neighbor group can have neighbors
NeighborGroupAlg * NeighborGroup::neighborGroupAlg | ( | ) |
return neighborhood algorithm
void NeighborGroup::setNeighborGroupAlg | ( | NeighborGroupAlg * | pNeighborGroupAlg | ) |
set neigbhorhood algorithm
pNeighborGroupAlg | neighborhood algorithm |
space::real NeighborGroup::neighborRadius | ( | ) | const |
return neighbor radius
unsigned int NeighborGroup::neighborCount | ( | ) | const |
return number of neighbors
unsigned int NeighborGroup::maxNeighborCount | ( | ) | const |
return maximum number of neighbors
bool NeighborGroup::replaceNeighborMode | ( | ) | const |
bool NeighborGroup::full | ( | ) | const |
returns true if no more neighbors can be added to neighbor list
void NeighborGroup::setNeighborRadius | ( | real | pNeighborRadius | ) |
set neighbor radius
pNeighborRadius | neighbor radius |
SpaceObject * NeighborGroup::neighbor | ( | unsigned int | pIndex | ) |
return neighboring space object
pIndex | neighbor index |
const SpaceObject * NeighborGroup::neighbor | ( | unsigned int | pIndex | ) | const |
return neighboring space object
pIndex | neighbor index |
const math::Vector< space::real > & NeighborGroup::value | ( | unsigned int | pIndex | ) | const |
return value of neighbor relation
pIndex | neighbor index |
const math::Vector< space::real > & NeighborGroup::direction | ( | unsigned int | pIndex | ) | const |
return direction of neighbor relation
pIndex | neighbor index |
space::real NeighborGroup::distance | ( | unsigned int | pIndex | ) | const |
return distance of neighbor relation
pIndex | neighbor index |
QVector< SpaceNeighborRelation * > & NeighborGroup::neighborRelations | ( | ) |
return neighbor relations
SpaceNeighborRelation * NeighborGroup::neighborRelation | ( | unsigned int | pIndex | ) |
return neighbor relation
pIndex | neighbor index |
const SpaceNeighborRelation * NeighborGroup::neighborRelation | ( | unsigned int | pIndex | ) | const |
return neighbor relation
pIndex | neighbor index |
SpaceNeighborRelation * NeighborGroup::operator[] | ( | unsigned int | pIndex | ) |
return neighbor relation
pIndex | neighbor index |
bool NeighborGroup::addNeighbor | ( | SpaceObject * | pNeighborObject | ) |
add neighbor object to neighbor list
pNeighborObject | neighbor space object |
bool NeighborGroup::addNeighbor | ( | SpaceObject * | pNeighborObject, | |
real | pDistance, | |||
const math::Vector< real > & | pDirection | |||
) |
add neighbor object to neighbor list
pNeighborObject | neighbor space object | |
pDistance | distance | |
pDirection | direction |
void NeighborGroup::removeNeighbor | ( | SpaceObject * | pNeighborObject | ) |
remove neighbor
pNeighborObject | neighbor space object |
void NeighborGroup::removeNeighbor | ( | unsigned int | pNeighborIndex | ) |
remove neighbor
pNeighborIndex | index of neighbor space object |
void NeighborGroup::removeNeighbors | ( | ) |
remove neighbors
base::String NeighborGroup::info | ( | int | pPropagationLevel = 0 |
) | const [virtual] |
print neighbor collection information
pPropagationLevel | how far the propagation method proceeds through composite classes (-1: unlimited, 0: no proceeding, >0: limited proceeding) |
friend class SpaceProxyObject [friend] |
friend class NeighborGroupAlg [friend] |
std::ostream& operator<< | ( | std::ostream & | pOstream, | |
const NeighborGroup & | pNeighborGroup | |||
) | [friend] |
retrieve textual neighbor group info
pOstream | output text stream | |
pNeighborGroup | neighbor group |
const base::String NeighborGroup::sClassName [static] |
class name
SpaceObject* iso::space::NeighborGroup::mSpaceObject [protected] |
space object
Space* iso::space::NeighborGroup::mSpace [protected] |
space this neighborlist is based on
bool iso::space::NeighborGroup::mVisible [protected] |
visibility of space object in this space
neighborhood algorithm
QVector<SpaceNeighborRelation*> iso::space::NeighborGroup::mNeighborRelations [protected] |
list of neighbor relations