ml::WEMEdge Class Reference

Defines the mesh component: edge. More...

#include <WEMEdge.h>

Inheritance diagram for ml::WEMEdge:

Public Member Functions
	WEMEdge ()
	Standard constructor.
	WEMEdge (const WEMEdge &e)
	Copy constructor.
	WEMEdge (WEMEdge &&e) noexcept
WEMEdge &	operator= (WEMEdge &&e) noexcept
	~WEMEdge () override
	Standard destructor.
void	reset ()
	Resets the object to default constructed state.
void	clone (WEMEdge *e)
	Clones given edge.
WEMNode *	getHead ()
	Returns head node.
const WEMNode *	getHead () const
	Returns head node.
void	setHead (WEMNode *head)
	Sets head node.
WEMNode *	getTail ()
	Returns tail node.
const WEMNode *	getTail () const
	Returns tail node.
void	setTail (WEMNode *tail)
	Sets tail node.
WEMFace *	getLFace ()
	Returns left face.
const WEMFace *	getLFace () const
	Returns left face.
void	setLFace (WEMFace *lFace)
	Sets left face.
WEMFace *	getRFace ()
	Returns right face.
const WEMFace *	getRFace () const
	Returns right face.
void	setRFace (WEMFace *rFace)
	Sets right face.
WEMTriangle *	getLTriangle ()
	Returns left face as triangle.
const WEMTriangle *	getLTriangle () const
	Returns left face as triangle.
WEMTriangle *	getRTriangle ()
	Returns right face as triangle.
const WEMTriangle *	getRTriangle () const
	Returns right face as triangle.
WEMTriangle *	getOther (WEMTriangle *triangle)
	Returns other face.
const WEMTriangle *	getOther (WEMTriangle *triangle) const
	Returns other face.
WEMEdge *	getLPred ()
	Returns lPred.
const WEMEdge *	getLPred () const
	Returns lPred.
void	setLPred (WEMEdge *lPred)
	Sets lPred.
WEMEdge *	getLSucc ()
	Returns lSucc.
const WEMEdge *	getLSucc () const
	Returns lSucc.
void	setLSucc (WEMEdge *lSucc)
	Sets lSucc.
WEMEdge *	getRPred ()
	Returns rPred.
const WEMEdge *	getRPred () const
	Returns rPred.
void	setRPred (WEMEdge *rPred)
	Sets rPred.
WEMEdge *	getRSucc ()
	Returns rSucc.
const WEMEdge *	getRSucc () const
	Returns rSucc.
void	setRSucc (WEMEdge *rSucc)
	Sets rSucc.
double	getLength () const
	Computes the length of edge.
bool	contains (WEMNode *node) const
	Returns whether this edges contains the given node.
WEMNode *	getOther (WEMNode *node)
	Returns other node.
const WEMNode *	getOther (WEMNode *node) const
	Returns other node.
WEMFace *	getOther (WEMFace *face)
	Returns other face.
const WEMFace *	getOther (WEMFace *face) const
	Returns other face.
bool	isBoundary () const
	Returns whether this is edge is a boundary edge.
void	replace (WEMEdge *orig, WEMEdge *replacement)
	Replaces the pointer orig by replacement to an edge.
void	replace (WEMNode *orig, WEMNode *replacement)
	Replaces the pointer orig by replacement to a node.
void	replace (WEMFace *orig, WEMFace *replacement)
	Replaces the pointer orig by replacement to a face.
double	getDihedralAngle () const
	Computes and returns the edge's dihedral angle.
double	getDotAngle () const
	Calculates angle between two incident faces.
Public Member Functions inherited from ml::WEMPrimitive
	WEMPrimitive ()
	WEMPrimitive (const WEMPrimitive &)=default
	WEMPrimitive (WEMPrimitive &&p) noexcept
WEMPrimitive &	operator= (const WEMPrimitive &)=default
WEMPrimitive &	operator= (WEMPrimitive &&p) noexcept
virtual	~WEMPrimitive ()=default
	Standard destructor.
void	resetPrimitive ()
	Resets the object to its default constructed state.
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.

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

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(), and mlrange_cast().

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.

References mlrange_cast().

setLPred()

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

inline

Sets lPred.

Definition at line 92 of file WEMEdge.h.

References mlrange_cast().

setLSucc()

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

inline

Sets lSucc.

Definition at line 98 of file WEMEdge.h.

References mlrange_cast().

setRFace()

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

inline

Sets right face.

Definition at line 72 of file WEMEdge.h.

References mlrange_cast().

setRPred()

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

inline

Sets rPred.

Definition at line 104 of file WEMEdge.h.

References mlrange_cast().

setRSucc()

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

inline

Sets rSucc.

Definition at line 110 of file WEMEdge.h.

References mlrange_cast().

setTail()

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

inline

Sets tail node.

Definition at line 60 of file WEMEdge.h.

References mlrange_cast().

---

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

• MeVisLab/Standard/Sources/ML/MLWEM/WEMBase/WEMEdge.h