$search

objtree::Object Class Reference

#include <object.h>

Inheritance diagram for objtree::Object:
Inheritance graph
[legend]

List of all members.

Public Types

enum  Type { PLANE = 1, ALIGNED_BOUNDING_BOX = 2, GENERAL_BOUNDING_BOX = 3 }

Public Member Functions

virtual bool fitsIntoBox (const Box &box) const =0
bool hasId () const
unsigned int id () const
unsigned int inNodesCount () const
virtual bool interfereWithBox (const Box &box) const =0
virtual bool isPointInside (float x, float y, float z) const =0
virtual bool isSimilar (const Object *object) const =0
void newNode (Node *node)
 Object ()
void removeNode (Node *node)
void setId (unsigned int id)
Type type () const
 ~Object ()

Protected Attributes

Type m_type

Private Attributes

unsigned int m_id
std::list< Node * > m_inNodes

Detailed Description

Abstract object class. Base class for all objects saved in octree.

Definition at line 45 of file object.h.


Member Enumeration Documentation

Enumerator:
PLANE 
ALIGNED_BOUNDING_BOX 
GENERAL_BOUNDING_BOX 

Definition at line 48 of file object.h.


Constructor & Destructor Documentation

objtree::Object::Object (  ) 

A constructor.

Definition at line 37 of file object.cpp.

objtree::Object::~Object (  ) 

A destructor. Removes object from octree.

Definition at line 49 of file object.cpp.


Member Function Documentation

virtual bool objtree::Object::fitsIntoBox ( const Box box  )  const [pure virtual]

Implemented in objtree::BBox, and objtree::Plane.

bool objtree::Object::hasId (  )  const

Returns true if object has an id.

Returns:
true if object has an id, false otherwise

Definition at line 86 of file object.cpp.

unsigned int objtree::Object::id ( void   )  const

Returns object id.

Returns:
object id

Definition at line 95 of file object.cpp.

unsigned int objtree::Object::inNodesCount (  )  const

Returns number of occupied nodes.

Returns:
number of occupied nodes

Definition at line 122 of file object.cpp.

virtual bool objtree::Object::interfereWithBox ( const Box box  )  const [pure virtual]

Implemented in objtree::BBox, and objtree::Plane.

virtual bool objtree::Object::isPointInside ( float  x,
float  y,
float  z 
) const [pure virtual]

Implemented in objtree::BBox, and objtree::Plane.

virtual bool objtree::Object::isSimilar ( const Object object  )  const [pure virtual]
void objtree::Object::newNode ( Node node  ) 

Informs object it is include in a new node.

Parameters:
pointer to node

Definition at line 104 of file object.cpp.

void objtree::Object::removeNode ( Node node  ) 

Informs object it is removed from node.

Parameters:
pointer to node

Definition at line 113 of file object.cpp.

void objtree::Object::setId ( unsigned int  id  ) 

Sets a new object id.

Parameters:
id new object id

Definition at line 77 of file object.cpp.

Object::Type objtree::Object::type (  )  const

Returns object type.

Returns:
object type

Definition at line 68 of file object.cpp.


Member Data Documentation

unsigned int objtree::Object::m_id [private]

Definition at line 57 of file object.h.

std::list<Node*> objtree::Object::m_inNodes [private]

Definition at line 56 of file object.h.

Definition at line 60 of file object.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines


srs_env_model
Author(s): Vit Stancl (stancl@fit.vutbr.cz), Tomas Lokaj, Jan Gorig, Michal Spanel (spanel@fit.vutbr.cz)
autogenerated on Tue Mar 5 14:33:48 2013