CFx SDK Documentation  2022 SP0
Public Member Functions | List of all members
OdBrShellFaceTraverser Class Reference

#include <BrShellFaceTraverser.h>

Inheritance diagram for OdBrShellFaceTraverser:
OdBrTraverser

Public Member Functions

OdBrFace getFace () const
 
OdBrShell getShell () const
 
OdBrErrorStatus setShell (const OdBrShell &shell)
 
OdBrErrorStatus setFace (const OdBrFace &face)
 
OdBrErrorStatus setShellAndFace (const OdBrFace &face)
 
 OdBrShellFaceTraverser ()
 
- 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 shell face traversers.

See also
TD_Br

<group OdBr_Classes>

Definition at line 46 of file BrShellFaceTraverser.h.

Constructor & Destructor Documentation

◆ OdBrShellFaceTraverser()

OdBrShellFaceTraverser::OdBrShellFaceTraverser ( )

Member Function Documentation

◆ getFace()

OdBrFace OdBrShellFaceTraverser::getFace ( ) const

Returns the face object at the current Traverser position.

◆ getShell()

OdBrShell OdBrShellFaceTraverser::getShell ( ) const

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

◆ setFace()

OdBrErrorStatus OdBrShellFaceTraverser::setFace ( const OdBrFace face)

Sets the starting position of this Traverser object.

Parameters
face[in] Defines the starting position.

◆ setShell()

OdBrErrorStatus OdBrShellFaceTraverser::setShell ( const OdBrShell shell)

Sets this Traverser object to a specific shell face list.

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

◆ setShellAndFace()

OdBrErrorStatus OdBrShellFaceTraverser::setShellAndFace ( const OdBrFace face)

Sets this Traverser object to a specific shell face list and starting position.

Parameters
face[in] Defines the face list and starting position.

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