3.4.0
tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace Class Reference

The AnnotatedFace class is used to store a) the connectivity info of a single face in a rectangular grid of faces b) an optional Annotation. More...

Public Member Functions

template<typename... Args>
 AnnotatedFace (TopoDS_Face const &f, Args &&... args)
 
Annotation & GetAnnotation ()
 GetAnnotation returns the custom annotation associated with this face. More...
 
Annotation const & GetAnnotation () const
 
TopoDS_Face GetFace ()
 GetFace returns the wrapped TopoDS_Face. More...
 
TopoDS_Face const GetFace () const
 
void ReplaceFace (TopoDS_Face const &f)
 SetFace replaces the wrapped TopoDS_Face with another face. More...
 
double UMax () const
 UMax returns the ending u parameter of this face. More...
 
double UMin () const
 UMin returns the starting u parameter of this face. More...
 
AnnotatedFaceUNext ()
 UNext returns the neighboring annotated face in positive u direction. More...
 
AnnotatedFace const * UNext () const
 
AnnotatedFaceUPrev ()
 UPrev returns the neighboring annotated face in negative u direction. More...
 
AnnotatedFace const * UPrev () const
 
double VMax () const
 VMax returns the ending v parameter of this face. More...
 
double VMin () const
 VMin returns the starting v parameter of this face. More...
 
AnnotatedFaceVNext ()
 VNext returns the neighboring annotated face in positive v direction. More...
 
AnnotatedFace const * VNext () const
 
AnnotatedFaceVPrev ()
 VPrev returns the neighboring annotated face in negative v direction. More...
 
AnnotatedFace const * VPrev () const
 

Private Attributes

Annotation annotation
 
TopoDS_Face face
 
AnnotatedFaceNeg_u_Neighbor {nullptr}
 
AnnotatedFaceNeg_v_Neighbor {nullptr}
 
AnnotatedFacePos_u_Neighbor {nullptr}
 
AnnotatedFacePos_v_Neighbor {nullptr}
 
gp_Pnt u0v0
 
gp_Pnt u0v1
 
gp_Pnt u1v0
 
gp_Pnt u1v1
 
double umax
 
double umin
 
double vmax
 
double vmin
 

Friends

class CTiglRectGridSurface
 

Detailed Description

template<typename Annotation = DefaultAnnotation>
class tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace

The AnnotatedFace class is used to store a) the connectivity info of a single face in a rectangular grid of faces b) an optional Annotation.

Constructor & Destructor Documentation

◆ AnnotatedFace()

template<typename Annotation = DefaultAnnotation>
template<typename... Args>
tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::AnnotatedFace ( TopoDS_Face const &  f,
Args &&...  args 
)
inline

Member Function Documentation

◆ GetAnnotation() [1/2]

template<typename Annotation = DefaultAnnotation>
Annotation& tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::GetAnnotation ( )
inline

GetAnnotation returns the custom annotation associated with this face.

Returns
the custom annotation associated with this face

◆ GetAnnotation() [2/2]

template<typename Annotation = DefaultAnnotation>
Annotation const& tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::GetAnnotation ( ) const
inline

◆ GetFace() [1/2]

template<typename Annotation = DefaultAnnotation>
TopoDS_Face tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::GetFace ( )
inline

GetFace returns the wrapped TopoDS_Face.

Returns
the wrapped TopoDS_Face

◆ GetFace() [2/2]

template<typename Annotation = DefaultAnnotation>
TopoDS_Face const tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::GetFace ( ) const
inline

◆ ReplaceFace()

template<typename Annotation = DefaultAnnotation>
void tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::ReplaceFace ( TopoDS_Face const &  f)
inline

SetFace replaces the wrapped TopoDS_Face with another face.

Note, that this possibly breaks the rectangular grid. This is intentional and not checked internally.

Parameters
fthe new TopoDS_Face

◆ UMax()

template<typename Annotation = DefaultAnnotation>
double tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::UMax ( ) const
inline

UMax returns the ending u parameter of this face.

Returns
the ending u parameter of this face

◆ UMin()

template<typename Annotation = DefaultAnnotation>
double tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::UMin ( ) const
inline

UMin returns the starting u parameter of this face.

Returns
the starting u parameter of this face

◆ UNext() [1/2]

template<typename Annotation = DefaultAnnotation>
AnnotatedFace* tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::UNext ( )
inline

UNext returns the neighboring annotated face in positive u direction.

Returns
the neighboring annotated face in positive u direction

◆ UNext() [2/2]

template<typename Annotation = DefaultAnnotation>
AnnotatedFace const* tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::UNext ( ) const
inline

◆ UPrev() [1/2]

template<typename Annotation = DefaultAnnotation>
AnnotatedFace* tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::UPrev ( )
inline

UPrev returns the neighboring annotated face in negative u direction.

Returns
the neighboring annotated face in positive u direction

◆ UPrev() [2/2]

template<typename Annotation = DefaultAnnotation>
AnnotatedFace const* tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::UPrev ( ) const
inline

◆ VMax()

template<typename Annotation = DefaultAnnotation>
double tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::VMax ( ) const
inline

VMax returns the ending v parameter of this face.

Returns
the ending v parameter of this face

◆ VMin()

template<typename Annotation = DefaultAnnotation>
double tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::VMin ( ) const
inline

VMin returns the starting v parameter of this face.

Returns
the starting v parameter of this face

◆ VNext() [1/2]

template<typename Annotation = DefaultAnnotation>
AnnotatedFace* tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::VNext ( )
inline

VNext returns the neighboring annotated face in positive v direction.

Returns
the neighboring annotated face in positive v direction

◆ VNext() [2/2]

template<typename Annotation = DefaultAnnotation>
AnnotatedFace const* tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::VNext ( ) const
inline

◆ VPrev() [1/2]

template<typename Annotation = DefaultAnnotation>
AnnotatedFace* tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::VPrev ( )
inline

VPrev returns the neighboring annotated face in negative v direction.

Returns
the neighboring annotated face in positive vu direction

◆ VPrev() [2/2]

template<typename Annotation = DefaultAnnotation>
AnnotatedFace const* tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::VPrev ( ) const
inline

Friends And Related Function Documentation

◆ CTiglRectGridSurface

template<typename Annotation = DefaultAnnotation>
friend class CTiglRectGridSurface
friend

Field Documentation

◆ annotation

template<typename Annotation = DefaultAnnotation>
Annotation tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::annotation
private

◆ face

template<typename Annotation = DefaultAnnotation>
TopoDS_Face tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::face
private

◆ Neg_u_Neighbor

template<typename Annotation = DefaultAnnotation>
AnnotatedFace* tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::Neg_u_Neighbor {nullptr}
private

◆ Neg_v_Neighbor

template<typename Annotation = DefaultAnnotation>
AnnotatedFace* tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::Neg_v_Neighbor {nullptr}
private

◆ Pos_u_Neighbor

template<typename Annotation = DefaultAnnotation>
AnnotatedFace* tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::Pos_u_Neighbor {nullptr}
private

◆ Pos_v_Neighbor

template<typename Annotation = DefaultAnnotation>
AnnotatedFace* tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::Pos_v_Neighbor {nullptr}
private

◆ u0v0

template<typename Annotation = DefaultAnnotation>
gp_Pnt tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::u0v0
private

◆ u0v1

template<typename Annotation = DefaultAnnotation>
gp_Pnt tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::u0v1
private

◆ u1v0

template<typename Annotation = DefaultAnnotation>
gp_Pnt tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::u1v0
private

◆ u1v1

template<typename Annotation = DefaultAnnotation>
gp_Pnt tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::u1v1
private

◆ umax

template<typename Annotation = DefaultAnnotation>
double tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::umax
private

◆ umin

template<typename Annotation = DefaultAnnotation>
double tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::umin
private

◆ vmax

template<typename Annotation = DefaultAnnotation>
double tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::vmax
private

◆ vmin

template<typename Annotation = DefaultAnnotation>
double tigl::CTiglRectGridSurface< Annotation >::AnnotatedFace::vmin
private

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