MeVisLab Toolbox Reference
ml::WEMEdge Class Reference

Defines the mesh component: edge. More...

#include <WEMEdge.h>

Inheritance diagram for ml::WEMEdge:
ml::WEMPrimitive

Public Member Functions

 WEMEdge ()
 Standard constructor. More...
 
 WEMEdge (const WEMEdge &e)
 Copy constructor. More...
 
 WEMEdge (WEMEdge &&e) noexcept
 
WEMEdgeoperator= (WEMEdge &&e) noexcept
 
 ~WEMEdge () override
 Standard destructor. More...
 
void reset ()
 Resets the object to default constructed state. More...
 
void clone (WEMEdge *e)
 Clones given edge. More...
 
WEMNodegetHead ()
 Returns head node. More...
 
const WEMNodegetHead () const
 Returns head node. More...
 
void setHead (WEMNode *head)
 Sets head node. More...
 
WEMNodegetTail ()
 Returns tail node. More...
 
const WEMNodegetTail () const
 Returns tail node. More...
 
void setTail (WEMNode *tail)
 Sets tail node. More...
 
WEMFacegetLFace ()
 Returns left face. More...
 
const WEMFacegetLFace () const
 Returns left face. More...
 
void setLFace (WEMFace *lFace)
 Sets left face. More...
 
WEMFacegetRFace ()
 Returns right face. More...
 
const WEMFacegetRFace () const
 Returns right face. More...
 
void setRFace (WEMFace *rFace)
 Sets right face. More...
 
WEMTrianglegetLTriangle ()
 Returns left face as triangle. More...
 
const WEMTrianglegetLTriangle () const
 Returns left face as triangle. More...
 
WEMTrianglegetRTriangle ()
 Returns right face as triangle. More...
 
const WEMTrianglegetRTriangle () const
 Returns right face as triangle. More...
 
WEMTrianglegetOther (WEMTriangle *triangle)
 Returns other face. More...
 
const WEMTrianglegetOther (WEMTriangle *triangle) const
 Returns other face. More...
 
WEMEdgegetLPred ()
 Returns lPred. More...
 
const WEMEdgegetLPred () const
 Returns lPred. More...
 
void setLPred (WEMEdge *lPred)
 Sets lPred. More...
 
WEMEdgegetLSucc ()
 Returns lSucc. More...
 
const WEMEdgegetLSucc () const
 Returns lSucc. More...
 
void setLSucc (WEMEdge *lSucc)
 Sets lSucc. More...
 
WEMEdgegetRPred ()
 Returns rPred. More...
 
const WEMEdgegetRPred () const
 Returns rPred. More...
 
void setRPred (WEMEdge *rPred)
 Sets rPred. More...
 
WEMEdgegetRSucc ()
 Returns rSucc. More...
 
const WEMEdgegetRSucc () const
 Returns rSucc. More...
 
void setRSucc (WEMEdge *rSucc)
 Sets rSucc. More...
 
double getLength () const
 Computes the length of edge. More...
 
bool contains (WEMNode *node) const
 Returns whether this edges contains the given node. More...
 
WEMNodegetOther (WEMNode *node)
 Returns other node. More...
 
const WEMNodegetOther (WEMNode *node) const
 Returns other node. More...
 
WEMFacegetOther (WEMFace *face)
 Returns other face. More...
 
const WEMFacegetOther (WEMFace *face) const
 Returns other face. More...
 
bool isBoundary () const
 Returns whether this is edge is a boundary edge. More...
 
void replace (WEMEdge *orig, WEMEdge *replacement)
 Replaces the pointer orig by replacement to an edge. More...
 
void replace (WEMNode *orig, WEMNode *replacement)
 Replaces the pointer orig by replacement to a node. More...
 
void replace (WEMFace *orig, WEMFace *replacement)
 Replaces the pointer orig by replacement to a face. More...
 
double getDihedralAngle () const
 Computes and returns the edge's dihedral angle. More...
 
double getDotAngle () const
 Calculates angle between two incident faces. More...
 
- Public Member Functions inherited from ml::WEMPrimitive
 WEMPrimitive ()
 
 WEMPrimitive (const WEMPrimitive &)=default
 
 WEMPrimitive (WEMPrimitive &&p) noexcept
 
WEMPrimitiveoperator= (const WEMPrimitive &)=default
 
WEMPrimitiveoperator= (WEMPrimitive &&p) noexcept
 
virtual ~WEMPrimitive ()=default
 Standard destructor. More...
 
void resetPrimitive ()
 Resets the object to its default constructed state. More...
 
int getEntryNumber () const
 Returns the entry number. More...
 
void setEntryNumber (int e)
 Sets the entry number. More...
 
bool isSet (unsigned int bit) const
 Returns whether the bit-flag is set. More...
 
void setFlag (unsigned int bit)
 Sets the given bit-flag. More...
 
void unsetFlag (unsigned int bit)
 Unsets the given bit-flag. More...
 
void clearFlag ()
 Clears the bit-flag. More...
 
bool isTraversed () const
 Returns whether this primitive has been traversed. More...
 
void setTraversed (bool traversed)
 Sets the traversed flag. More...
 
int getHeapPosition () const
 Returns the heap position. More...
 
bool inHeap () const
 Returns whether this primitive is in the heap. More...
 
void setHeapPosition (int heapPosition)
 Sets the heap position. More...
 
double getHeapValue () const
 Returns the heap value. More...
 
void setHeapValue (double heapValue)
 Sets the heap value. More...
 

Additional Inherited Members

- Protected Attributes inherited from ml::WEMPrimitive
unsigned int _bitFlag
 Bit-wise flag for custom use. More...
 
int _entryNumber
 Entry number in index vector, for easy deletion and reference. More...
 
int _heapPosition
 Heap position, same like entryNumber but for heaps. More...
 
double _heapValue
 Element value, used for heap sorting. More...
 

Detailed Description

Defines the mesh component: edge.

Definition at line 29 of file WEMEdge.h.

Constructor & Destructor Documentation

◆ WEMEdge() [1/3]

ml::WEMEdge::WEMEdge ( )

Standard constructor.

◆ WEMEdge() [2/3]

ml::WEMEdge::WEMEdge ( const WEMEdge e)

Copy constructor.

◆ WEMEdge() [3/3]

ml::WEMEdge::WEMEdge ( WEMEdge &&  e)
noexcept

◆ ~WEMEdge()

ml::WEMEdge::~WEMEdge ( )
override

Standard destructor.

Member Function Documentation

◆ clone()

void ml::WEMEdge::clone ( WEMEdge e)

Clones given edge.

◆ contains()

bool ml::WEMEdge::contains ( WEMNode node) const

Returns whether this edges contains the given node.

◆ getDihedralAngle()

double ml::WEMEdge::getDihedralAngle ( ) const

Computes and returns the edge's dihedral angle.

That is the angle between its incident faces. The returned angle value is expressed in radians.

◆ getDotAngle()

double ml::WEMEdge::getDotAngle ( ) const

Calculates angle between two incident faces.

Only return dot product result for speed.

◆ getHead() [1/2]

WEMNode* ml::WEMEdge::getHead ( )
inline

Returns head node.

Definition at line 50 of file WEMEdge.h.

◆ getHead() [2/2]

const WEMNode* ml::WEMEdge::getHead ( ) const
inline

Returns head node.

Definition at line 52 of file WEMEdge.h.

References getHead().

Referenced by getHead().

◆ getLength()

double ml::WEMEdge::getLength ( ) const

Computes the length of edge.

◆ getLFace() [1/2]

WEMFace* ml::WEMEdge::getLFace ( )
inline

Returns left face.

Definition at line 62 of file WEMEdge.h.

◆ getLFace() [2/2]

const WEMFace* ml::WEMEdge::getLFace ( ) const
inline

Returns left face.

Definition at line 64 of file WEMEdge.h.

References getLFace().

Referenced by getLFace().

◆ getLPred() [1/2]

WEMEdge* ml::WEMEdge::getLPred ( )
inline

Returns lPred.

Definition at line 88 of file WEMEdge.h.

◆ getLPred() [2/2]

const WEMEdge* ml::WEMEdge::getLPred ( ) const
inline

Returns lPred.

Definition at line 90 of file WEMEdge.h.

References getLPred().

Referenced by getLPred().

◆ getLSucc() [1/2]

WEMEdge* ml::WEMEdge::getLSucc ( )
inline

Returns lSucc.

Definition at line 94 of file WEMEdge.h.

◆ getLSucc() [2/2]

const WEMEdge* ml::WEMEdge::getLSucc ( ) const
inline

Returns lSucc.

Definition at line 96 of file WEMEdge.h.

References getLSucc().

Referenced by getLSucc().

◆ getLTriangle() [1/2]

WEMTriangle* ml::WEMEdge::getLTriangle ( )
inline

Returns left face as triangle.

Definition at line 74 of file WEMEdge.h.

◆ getLTriangle() [2/2]

const WEMTriangle* ml::WEMEdge::getLTriangle ( ) const
inline

Returns left face as triangle.

Definition at line 76 of file WEMEdge.h.

References getLTriangle().

Referenced by getLTriangle().

◆ getOther() [1/6]

WEMFace* ml::WEMEdge::getOther ( WEMFace face)

Returns other face.

◆ getOther() [2/6]

const WEMFace* ml::WEMEdge::getOther ( WEMFace face) const
inline

Returns other face.

Definition at line 123 of file WEMEdge.h.

References getOther().

Referenced by getOther().

◆ getOther() [3/6]

WEMNode* ml::WEMEdge::getOther ( WEMNode node)

Returns other node.

◆ getOther() [4/6]

const WEMNode* ml::WEMEdge::getOther ( WEMNode node) const
inline

Returns other node.

Definition at line 119 of file WEMEdge.h.

References getOther().

Referenced by getOther().

◆ getOther() [5/6]

WEMTriangle* ml::WEMEdge::getOther ( WEMTriangle triangle)

Returns other face.

◆ getOther() [6/6]

const WEMTriangle* ml::WEMEdge::getOther ( WEMTriangle triangle) const
inline

Returns other face.

Definition at line 85 of file WEMEdge.h.

References getOther().

Referenced by getOther().

◆ getRFace() [1/2]

WEMFace* ml::WEMEdge::getRFace ( )
inline

Returns right face.

Definition at line 68 of file WEMEdge.h.

◆ getRFace() [2/2]

const WEMFace* ml::WEMEdge::getRFace ( ) const
inline

Returns right face.

Definition at line 70 of file WEMEdge.h.

References getRFace().

Referenced by getRFace().

◆ getRPred() [1/2]

WEMEdge* ml::WEMEdge::getRPred ( )
inline

Returns rPred.

Definition at line 100 of file WEMEdge.h.

◆ getRPred() [2/2]

const WEMEdge* ml::WEMEdge::getRPred ( ) const
inline

Returns rPred.

Definition at line 102 of file WEMEdge.h.

References getRPred().

Referenced by getRPred().

◆ getRSucc() [1/2]

WEMEdge* ml::WEMEdge::getRSucc ( )
inline

Returns rSucc.

Definition at line 106 of file WEMEdge.h.

◆ getRSucc() [2/2]

const WEMEdge* ml::WEMEdge::getRSucc ( ) const
inline

Returns rSucc.

Definition at line 108 of file WEMEdge.h.

References getRSucc().

Referenced by getRSucc().

◆ getRTriangle() [1/2]

WEMTriangle* ml::WEMEdge::getRTriangle ( )
inline

Returns right face as triangle.

Definition at line 78 of file WEMEdge.h.

◆ getRTriangle() [2/2]

const WEMTriangle* ml::WEMEdge::getRTriangle ( ) const
inline

Returns right face as triangle.

Definition at line 80 of file WEMEdge.h.

References getRTriangle().

Referenced by getRTriangle().

◆ getTail() [1/2]

WEMNode* ml::WEMEdge::getTail ( )
inline

Returns tail node.

Definition at line 56 of file WEMEdge.h.

◆ getTail() [2/2]

const WEMNode* ml::WEMEdge::getTail ( ) const
inline

Returns tail node.

Definition at line 58 of file WEMEdge.h.

References getTail().

Referenced by getTail().

◆ isBoundary()

bool ml::WEMEdge::isBoundary ( ) const
inline

Returns whether this is edge is a boundary edge.

A boundary edge has at least one adjacent face set to NULL.

Definition at line 126 of file WEMEdge.h.

◆ operator=()

WEMEdge& ml::WEMEdge::operator= ( WEMEdge &&  e)
noexcept

◆ replace() [1/3]

void ml::WEMEdge::replace ( WEMEdge orig,
WEMEdge replacement 
)

Replaces the pointer orig by replacement to an edge.

◆ replace() [2/3]

void ml::WEMEdge::replace ( WEMFace orig,
WEMFace replacement 
)

Replaces the pointer orig by replacement to a face.

◆ replace() [3/3]

void ml::WEMEdge::replace ( WEMNode orig,
WEMNode replacement 
)

Replaces the pointer orig by replacement to a node.

◆ reset()

void ml::WEMEdge::reset ( )

Resets the object to default constructed state.

◆ setHead()

void ml::WEMEdge::setHead ( WEMNode head)
inline

Sets head node.

Definition at line 54 of file WEMEdge.h.

◆ setLFace()

void ml::WEMEdge::setLFace ( WEMFace lFace)
inline

Sets left face.

Definition at line 66 of file WEMEdge.h.

◆ setLPred()

void ml::WEMEdge::setLPred ( WEMEdge lPred)
inline

Sets lPred.

Definition at line 92 of file WEMEdge.h.

◆ setLSucc()

void ml::WEMEdge::setLSucc ( WEMEdge lSucc)
inline

Sets lSucc.

Definition at line 98 of file WEMEdge.h.

◆ setRFace()

void ml::WEMEdge::setRFace ( WEMFace rFace)
inline

Sets right face.

Definition at line 72 of file WEMEdge.h.

◆ setRPred()

void ml::WEMEdge::setRPred ( WEMEdge rPred)
inline

Sets rPred.

Definition at line 104 of file WEMEdge.h.

◆ setRSucc()

void ml::WEMEdge::setRSucc ( WEMEdge rSucc)
inline

Sets rSucc.

Definition at line 110 of file WEMEdge.h.

◆ setTail()

void ml::WEMEdge::setTail ( WEMNode tail)
inline

Sets tail node.

Definition at line 60 of file WEMEdge.h.


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