CFx SDK Documentation  2020SP3
Public Member Functions | List of all members
OdBrLoopVertexTraverser Class Reference

#include <BrLoopVertexTraverser.h>

Inheritance diagram for OdBrLoopVertexTraverser:
OdBrTraverser

Public Member Functions

 OdBrLoopVertexTraverser ()
 
OdBrVertex getVertex () const
 
OdBrLoop getLoop () const
 
OdBrErrorStatus setLoop (const OdBrLoop &loop)
 
OdBrErrorStatus setLoopAndVertex (const OdBrVertexLoopTraverser &vertexLoop)
 
OdBrErrorStatus setVertex (const OdBrVertex &vertex)
 
OdBrErrorStatus getParamPoint (OdGePoint2d &point) const
 
- 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= *(BrValidationLevel *) NULL)
 
OdBrErrorStatus getValidationLevel (BrValidationLevel &level) const
 

Additional Inherited Members

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

Detailed Description

This class is the interface class for loop vertex traversers.

See also
TD_Br

<group OdBr_Classes>

Definition at line 47 of file BrLoopVertexTraverser.h.

Constructor & Destructor Documentation

◆ OdBrLoopVertexTraverser()

OdBrLoopVertexTraverser::OdBrLoopVertexTraverser ( )

Member Function Documentation

◆ getLoop()

OdBrLoop OdBrLoopVertexTraverser::getLoop ( ) const

Returns the owner of the vertex list associated with this Traverser object.

◆ getParamPoint()

OdBrErrorStatus OdBrLoopVertexTraverser::getParamPoint ( OdGePoint2d point) const

Returns the parameter space point at the current Traverser position.

Parameters
ppoint[out] Parameter point.
Returns
Returns odbrOK if successful, or an appropriate error code if not.

◆ getVertex()

OdBrVertex OdBrLoopVertexTraverser::getVertex ( ) const

Returns the loop vertex.

◆ setLoop()

OdBrErrorStatus OdBrLoopVertexTraverser::setLoop ( const OdBrLoop loop)

Sets this Traverser object to a specific loop vertex list.

Parameters
loop[in] Owner of the vertex 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.

◆ setLoopAndVertex()

OdBrErrorStatus OdBrLoopVertexTraverser::setLoopAndVertex ( const OdBrVertexLoopTraverser vertexLoop)

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

Parameters
vertexLoop[in] Defines the loop vertex list and starting position.

◆ setVertex()

OdBrErrorStatus OdBrLoopVertexTraverser::setVertex ( const OdBrVertex vertex)

Sets the starting position of this Traverser object.

Parameters
vertex[in] Defines the starting position.

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