MeVisLabToolboxReference
ml::WEMPrimitive Class Reference

This is the base class for all WEM elements like nodes, edges and faces. More...

#include <WEMPrimitive.h>

Inheritance diagram for ml::WEMPrimitive:
ml::WEMEdge ml::WEMFace ml::WEMNode ml::WEMPolygon ml::WEMQuad ml::WEMTriangle

List of all members.

Public Member Functions

 WEMPrimitive ()
 Standard constructor.
 WEMPrimitive (const WEMPrimitive &p)
 Copy constructor.
virtual ~WEMPrimitive ()
 Standard destructor.
int getEntryNumber () const
 Returns the entry number.
void setEntryNumber (int e)
 Sets the entry number.
bool isSet (unsigned int bit) const
 Returns whether the bit-flag is set.
void setFlag (unsigned int bit)
 Sets the given bit-flag.
void unsetFlag (unsigned int bit)
 Unsets the given bit-flag.
void clearFlag ()
 Clears the bit-flag.
bool isTraversed () const
 Returns whether this primitive has been traversed.
void setTraversed (bool traversed)
 Sets the traversed flag.
int getHeapPosition () const
 Returns the heap position.
bool inHeap () const
 Returns whether this primitive is in the heap.
void setHeapPosition (int heapPosition)
 Sets the heap position.
double getHeapValue () const
 Returns the heap value.
void setHeapValue (double heapValue)
 Sets the heap value.

Detailed Description

This is the base class for all WEM elements like nodes, edges and faces.

Definition at line 24 of file WEMPrimitive.h.


Constructor & Destructor Documentation

ml::WEMPrimitive::WEMPrimitive ( )

Standard constructor.

ml::WEMPrimitive::WEMPrimitive ( const WEMPrimitive p)

Copy constructor.

virtual ml::WEMPrimitive::~WEMPrimitive ( ) [virtual]

Standard destructor.


Member Function Documentation

void ml::WEMPrimitive::clearFlag ( ) [inline]

Clears the bit-flag.

Definition at line 48 of file WEMPrimitive.h.

int ml::WEMPrimitive::getEntryNumber ( ) const [inline]

Returns the entry number.

The entryNumber is the index into the (vector-like) structure the primitive is stored in internally.

Definition at line 38 of file WEMPrimitive.h.

int ml::WEMPrimitive::getHeapPosition ( ) const [inline]
double ml::WEMPrimitive::getHeapValue ( ) const [inline]

Returns the heap value.

Definition at line 60 of file WEMPrimitive.h.

Referenced by ml::WEMHeap< T >::remove(), and ml::WEMHeap< T >::update().

bool ml::WEMPrimitive::inHeap ( ) const [inline]

Returns whether this primitive is in the heap.

Definition at line 56 of file WEMPrimitive.h.

bool ml::WEMPrimitive::isSet ( unsigned int  bit) const [inline]

Returns whether the bit-flag is set.

Definition at line 42 of file WEMPrimitive.h.

bool ml::WEMPrimitive::isTraversed ( ) const [inline]

Returns whether this primitive has been traversed.

Definition at line 50 of file WEMPrimitive.h.

References WEM_TRAVERSED_BIT.

void ml::WEMPrimitive::setEntryNumber ( int  e) [inline]

Sets the entry number.

Definition at line 40 of file WEMPrimitive.h.

void ml::WEMPrimitive::setFlag ( unsigned int  bit) [inline]

Sets the given bit-flag.

Definition at line 44 of file WEMPrimitive.h.

void ml::WEMPrimitive::setHeapPosition ( int  heapPosition) [inline]

Sets the heap position.

Definition at line 58 of file WEMPrimitive.h.

Referenced by ml::WEMContainer< T >::replace().

void ml::WEMPrimitive::setHeapValue ( double  heapValue) [inline]

Sets the heap value.

Definition at line 62 of file WEMPrimitive.h.

Referenced by ml::WEMHeap< T >::insert(), and ml::WEMHeap< T >::update().

void ml::WEMPrimitive::setTraversed ( bool  traversed)

Sets the traversed flag.

void ml::WEMPrimitive::unsetFlag ( unsigned int  bit) [inline]

Unsets the given bit-flag.

Definition at line 46 of file WEMPrimitive.h.


The documentation for this class was generated from the following file: