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

#include <BrElement2dNodeTraverser.h>

Inheritance diagram for OdBrElement2dNodeTraverser:
OdBrTraverser

Public Member Functions

 OdBrElement2dNodeTraverser ()
 
 ~OdBrElement2dNodeTraverser ()
 
OdBrErrorStatus setElement (const OdBrMesh2dElement2dTraverser &mesh2dElement2dTraverser)
 
OdBrErrorStatus setElement (const OdBrElement2d &element)
 
OdBrErrorStatus getElement (OdBrElement2d &element) const
 
OdBrErrorStatus setNode (const OdBrNode &node)
 
OdBrErrorStatus getNode (OdBrNode &node) const
 
OdBrErrorStatus getSurfaceNormal (OdGeVector3d &vector) const
 
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 interface class represents element node traversers. It is used to access node data, such as surface normals and pairs of uv parameters.

Remarks
This class is implemented only for Spatial modeler.
See also
TD_Br

<group OdBr_Classes>

Definition at line 44 of file BrElement2dNodeTraverser.h.

Constructor & Destructor Documentation

◆ OdBrElement2dNodeTraverser()

OdBrElement2dNodeTraverser::OdBrElement2dNodeTraverser ( )

Default constructor.

◆ ~OdBrElement2dNodeTraverser()

OdBrElement2dNodeTraverser::~OdBrElement2dNodeTraverser ( )

Destructor.

Member Function Documentation

◆ getElement()

OdBrErrorStatus OdBrElement2dNodeTraverser::getElement ( OdBrElement2d element) const

Returns the element that owns the element node list.

Parameters
element[out] Defines the 2D element object, passed by reference.
Returns
Returns odbrOK if successful, or an appropriate error code if not.
Remarks
In case of an error, the element reference object passed as an argument is unchanged.

◆ getNode()

OdBrErrorStatus OdBrElement2dNodeTraverser::getNode ( OdBrNode node) const

Returns the node at the current position in the element node list.

Parameters
node[out] Node at the current position.
Returns
Returns odbrOK if successful, or an appropriate error code if not.
Remarks
In case of an error, the node reference object that is passed as an argument is unchanged.

◆ getParamPoint()

OdBrErrorStatus OdBrElement2dNodeTraverser::getParamPoint ( OdGePoint2d point) const

Returns the 2D element node's underlying parameter point.

Parameters
point[out] Parameter point.
Returns
Returns odbrOK if successful, or an appropriate error code if not.
Remarks
In case of an error, the parameter point reference object is unchanged.

◆ getSurfaceNormal()

OdBrErrorStatus OdBrElement2dNodeTraverser::getSurfaceNormal ( OdGeVector3d vector) const

Returns the normal vector computed on the original surface at the current node.

Parameters
vector[out] Normal vector at the current node.
Returns
Returns odbrOK if successful, or an appropriate error code if not.
Remarks
In case of an error, the normal vector reference argument's value is unchanged.

◆ setElement() [1/2]

OdBrErrorStatus OdBrElement2dNodeTraverser::setElement ( const OdBrElement2d element)

Sets the specific element node list to this traverser.

Parameters
element[in] Defines the 2D element with a topological adjacent list of nodes, starting at the first node in the list.
Returns
Returns odbrOK if successful, or an appropriate error code if not.
Remarks
In case of an error, the value of this traverser's element node list is unchanged.

◆ setElement() [2/2]

OdBrErrorStatus OdBrElement2dNodeTraverser::setElement ( const OdBrMesh2dElement2dTraverser mesh2dElement2dTraverser)

Sets the specific element node list to this traverser.

Parameters
mesh2dElement2dTraverser[in] Defines the topological adjacent list of nodes owned by the 2D element at the current position in this OdBrMesh2dElement2dTraverser, starting at the first node in the list.
Returns
Returns odbrOK if successful, or an appropriate error code if not.
Remarks
In case of an error, the value of this traverser's element node list is unchanged.

◆ setNode()

OdBrErrorStatus OdBrElement2dNodeTraverser::setNode ( const OdBrNode node)

Sets the starting position of this traverser to a specific node in the element node list.

Parameters
node[in] Node at which the traverser's starting position is set.
Returns
Returns odbrOK if successful, or an appropriate error code if not.
Remarks
In case of an error, the traverser's element node list is unchanged.

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