CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OdBrLoopEdgeTraverser Class Reference

#include <BrLoopEdgeTraverser.h>

Inheritance diagram for OdBrLoopEdgeTraverser:
OdBrTraverser

Public Member Functions

 OdBrLoopEdgeTraverser ()
 
OdGeCurve3dgetOrientedCurve () const
 
bool getOrientedCurveAsNurb (OdGeNurbCurve3d &nurb) const
 
OdGeCurve2dgetParamCurve () const
 
OdBrErrorStatus getParamCurveAsNurb (OdGeNurbCurve2d &nurb) const
 
bool getEdgeOrientToLoop () const
 
OdBrEdge getEdge () const
 
OdBrLoop getLoop () const
 
OdBrErrorStatus setEdge (const OdBrEdge &edge)
 
OdBrErrorStatus setLoop (const OdBrLoop &loop)
 
OdBrErrorStatus setLoop (const OdBrFaceLoopTraverser &faceLoop)
 
OdBrErrorStatus setLoopAndEdge (const OdBrEdgeLoopTraverser &edgeLoop)
 
- Public Member Functions inherited from OdBrTraverser
bool done () const
 
OdBrErrorStatus next ()
 
OdBrErrorStatus restart ()
 
virtual ~OdBrTraverser ()
 
bool isEqualTo (const OdBrTraverser *pOtherTraverser) const
 
bool isNull () const
 
OdBrErrorStatus setValidationLevel (const BrValidationLevel &level)
 
OdBrErrorStatus getValidationLevel (BrValidationLevel &level) const
 

Additional Inherited Members

- Protected Member Functions inherited from OdBrTraverser
 OdBrTraverser ()
 
- Protected Attributes inherited from OdBrTraverser
OdRxObjectPtr m_pImp
 
OdSharedPtr< OdDbStubPtrArraym_pFSubentPath
 
bool m_bIsValidate
 

Detailed Description

This class is the interface class for loop edge traversers.

See also
TD_Br

<group OdBr_Classes>

Definition at line 51 of file BrLoopEdgeTraverser.h.

Constructor & Destructor Documentation

◆ OdBrLoopEdgeTraverser()

OdBrLoopEdgeTraverser::OdBrLoopEdgeTraverser ( )

Member Function Documentation

◆ getEdge()

OdBrEdge OdBrLoopEdgeTraverser::getEdge ( ) const

Returns the edge object at the current Traverser position.

◆ getEdgeOrientToLoop()

bool OdBrLoopEdgeTraverser::getEdgeOrientToLoop ( ) const

Returns true if and only if the orientation of the edge from vertex 1 to vertex 2 is the same as the orientation of the loop parameterization.

◆ getLoop()

OdBrLoop OdBrLoopEdgeTraverser::getLoop ( ) const

Returns the loop of the edge list associated with this Traverser object.

◆ getOrientedCurve()

OdGeCurve3d * OdBrLoopEdgeTraverser::getOrientedCurve ( ) const

Returns the underlying curve of the edge at the current Traverser position as an oriented OdGeCurve3d object.

◆ getOrientedCurveAsNurb()

bool OdBrLoopEdgeTraverser::getOrientedCurveAsNurb ( OdGeNurbCurve3d nurb) const

Returns the underlying curve of the edge at the current Traverser position as an OdGeNurbCurve3d object.

Parameters
nurb[out] Receives the NURBS curve.
Returns
Returns true if and only if successful.

◆ getParamCurve()

OdGeCurve2d * OdBrLoopEdgeTraverser::getParamCurve ( ) const

Returns the underlying curve of the edge at the current Traverser position as a parametric OdGeCurve2d object.

◆ getParamCurveAsNurb()

OdBrErrorStatus OdBrLoopEdgeTraverser::getParamCurveAsNurb ( OdGeNurbCurve2d nurb) const

Returns the underlying curve of the edge at the current Traverser position as a parametric OdGeNurbCurve2d object.

Parameters
nurb[out] Receives the NURBS curve.
Returns
Returns odbrOK if successful, or an appropriate error code if not.

◆ setEdge()

OdBrErrorStatus OdBrLoopEdgeTraverser::setEdge ( const OdBrEdge edge)

Sets the starting position of this Traverser object.

Parameters
edge[in] Defines the starting position.

◆ setLoop() [1/2]

OdBrErrorStatus OdBrLoopEdgeTraverser::setLoop ( const OdBrFaceLoopTraverser faceLoop)

Sets this Traverser object to a specific loop edge list.

Parameters
faceLoop[in] Face-loop traverser.
Remarks
This Traverser object is set to the first element in the list.

Returns odbrOK if successful, or an appropriate error code if not.

◆ setLoop() [2/2]

OdBrErrorStatus OdBrLoopEdgeTraverser::setLoop ( const OdBrLoop loop)

Sets this Traverser object to a specific loop edge list.

Parameters
loop[in] Owner of the edge list.
Remarks
This Traverser object is set to the first element in the list.

Returns odbrOK if successful, or an appropriate error code if not.

◆ setLoopAndEdge()

OdBrErrorStatus OdBrLoopEdgeTraverser::setLoopAndEdge ( const OdBrEdgeLoopTraverser edgeLoop)

Sets this Traverser object to a specific edge loop list and starting position.

Parameters
edgeLoop[in] Defines the edge list and starting position.

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