Loading...
Searching...
No Matches
HydroCouple::Spatial::IEdge Class Referenceabstract

A directed edge from one vertex to another, adjacent to two faces. More...

#include <hydrocouplespatial.h>

Collaboration diagram for HydroCouple::Spatial::IEdge:

Public Member Functions

virtual ~IEdge ()=default
 IEdge destructor.
 
virtual int64_t index () const =0
 Index of this edge in its owning mesh or network (IMeshView::edgeNodes() order).
 
virtual IVertex * orig () const =0
 The origin IVertex of this IEdge.
 
virtual IVertex * dest () const =0
 The destination IVertex of this IEdge.
 
virtual IPolygon * left () const =0
 The left face of this edge.
 
virtual IPolygon * right () const =0
 The right face of this edge.
 
virtual IPolygon * face () const =0
 The target face of this edge, if dual.
 
virtual IEdge * rot () const =0
 The dual of this edge, directed from its right to its left.
 
virtual IEdge * invRot () const =0
 The dual of this IEdge, directed from its left to its right.
 
virtual IEdge * sym () const =0
 The IEdge from the destination to the origin of this IEdge.
 
virtual IEdge * origNext () const =0
 The next ccw edge around (from) the origin of this IEdge.
 
virtual IEdge * origPrev () const =0
 The next cw edge around (from) the origin of this edge.
 
virtual IEdge * destNext () const =0
 The next ccw edge around (into) the destination of this edge.
 
virtual IEdge * destPrev () const =0
 The next cw edge around (into) the destination of this edge.
 
virtual IEdge * leftNext () const =0
 The ccw edge around the left face following this edge.
 
virtual IEdge * leftPrev () const =0
 The ccw edge around the left face before this edge.
 
virtual IEdge * rightNext () const =0
 The edge around the right face ccw following this edge.
 
virtual IEdge * rightPrev () const =0
 The IEdge around the right face ccw before this IEdge.
 

Detailed Description

A directed edge from one vertex to another, adjacent to two faces.

Based on Dani Lischinski's code from Graphics Gems IV. Original quad-edge data structure due to Guibas and Stolfi (1985). Does not inherit from geometry to reduce size. since each edge has 4 pointers.

Constructor & Destructor Documentation

◆ ~IEdge()

virtual HydroCouple::Spatial::IEdge::~IEdge ( )
virtualdefault

IEdge destructor.

Member Function Documentation

◆ dest()

virtual IVertex * HydroCouple::Spatial::IEdge::dest ( ) const
nodiscardpure virtual

The destination IVertex of this IEdge.

Returns
the destination of this IEdge; NULL if currently unknown.

◆ destNext()

virtual IEdge * HydroCouple::Spatial::IEdge::destNext ( ) const
nodiscardpure virtual

The next ccw edge around (into) the destination of this edge.

Returns
The next edge to the destination; will be nonnull

◆ destPrev()

virtual IEdge * HydroCouple::Spatial::IEdge::destPrev ( ) const
nodiscardpure virtual

The next cw edge around (into) the destination of this edge.

Returns
The previous edge to the destination; will be nonnull

◆ face()

virtual IPolygon * HydroCouple::Spatial::IEdge::face ( ) const
nodiscardpure virtual

The target face of this edge, if dual.

Otherwise null if not dual.

Returns
The target face polygon, or null if not dual.

◆ index()

virtual int64_t HydroCouple::Spatial::IEdge::index ( ) const
nodiscardpure virtual

Index of this edge in its owning mesh or network (IMeshView::edgeNodes() order).

◆ invRot()

virtual IEdge * HydroCouple::Spatial::IEdge::invRot ( ) const
nodiscardpure virtual

The dual of this IEdge, directed from its left to its right.

Returns
The left to right dual of this edge; will be nonnull

◆ left()

virtual IPolygon * HydroCouple::Spatial::IEdge::left ( ) const
nodiscardpure virtual

The left face of this edge.

Returns
the left face of this edge; Null if currently unknown

◆ leftNext()

virtual IEdge * HydroCouple::Spatial::IEdge::leftNext ( ) const
nodiscardpure virtual

The ccw edge around the left face following this edge.

Returns
The next left face edge; will be nonnull

◆ leftPrev()

virtual IEdge * HydroCouple::Spatial::IEdge::leftPrev ( ) const
nodiscardpure virtual

The ccw edge around the left face before this edge.

Returns
The previous left face edge; will be nonnull

◆ orig()

virtual IVertex * HydroCouple::Spatial::IEdge::orig ( ) const
nodiscardpure virtual

The origin IVertex of this IEdge.

Returns
the origin of this IEdge; NULL if currently unknown.

◆ origNext()

virtual IEdge * HydroCouple::Spatial::IEdge::origNext ( ) const
nodiscardpure virtual

The next ccw edge around (from) the origin of this IEdge.

Returns
The next edge from the origin; will be nonnull

◆ origPrev()

virtual IEdge * HydroCouple::Spatial::IEdge::origPrev ( ) const
nodiscardpure virtual

The next cw edge around (from) the origin of this edge.

Returns
The previous edge from the origin; will be nonnull

◆ right()

virtual IPolygon * HydroCouple::Spatial::IEdge::right ( ) const
nodiscardpure virtual

The right face of this edge.

Returns
The right face of this edge; null if currently unknown

◆ rightNext()

virtual IEdge * HydroCouple::Spatial::IEdge::rightNext ( ) const
nodiscardpure virtual

The edge around the right face ccw following this edge.

Returns
The next right face edge; will be nonnull

◆ rightPrev()

virtual IEdge * HydroCouple::Spatial::IEdge::rightPrev ( ) const
nodiscardpure virtual

The IEdge around the right face ccw before this IEdge.

Returns
The previous right face edge; will be nonnull

◆ rot()

virtual IEdge * HydroCouple::Spatial::IEdge::rot ( ) const
nodiscardpure virtual

The dual of this edge, directed from its right to its left.

Returns
The right to left dual of this edge; will be nonnull

◆ sym()

virtual IEdge * HydroCouple::Spatial::IEdge::sym ( ) const
nodiscardpure virtual

The IEdge from the destination to the origin of this IEdge.

Returns
The symmetric of this edge; will be nonnull

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