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

#include <BrMesh2dControl.h>

Inheritance diagram for OdBrMesh2dControl:
OdBrMeshControl

Public Member Functions

 OdBrMesh2dControl ()
 
 OdBrMesh2dControl (const OdBrMesh2dControl &src)
 
 ~OdBrMesh2dControl ()
 
OdBrMesh2dControloperator= (const OdBrMesh2dControl &src)
 
OdBrErrorStatus setMaxAspectRatio (double maxAspectRatio=0)
 
OdBrErrorStatus getMaxAspectRatio (double &maxAspectRatio) const
 
OdBrErrorStatus setElementShape (Element2dShape elementShape=kDefault)
 
OdBrErrorStatus getElementShape (Element2dShape &elementShape) const
 
- Public Member Functions inherited from OdBrMeshControl
virtual ~OdBrMeshControl ()
 
bool isEqualTo (const OdBrMeshControl *other) const
 
OdBrErrorStatus setMaxSubdivisions (OdUInt32 maxSubs=0)
 
OdBrErrorStatus getMaxSubdivisions (OdUInt32 &maxSubs) const
 
OdBrErrorStatus setMaxNodeSpacing (double maxNodeSpace=0)
 
OdBrErrorStatus getMaxNodeSpacing (double &maxNodeSpace) const
 
OdBrErrorStatus setAngTol (double angTol=0)
 
OdBrErrorStatus getAngTol (double &angTol) const
 
OdBrErrorStatus setDistTol (double distTol=0)
 
OdBrErrorStatus getDistTol (double &distTol) const
 

Static Public Attributes

static const ODBR_TOOLKIT_EXPORT_STATIC OdBrMesh2dControlOdBrMesh2dControlDefault
 

Protected Member Functions

 OdBrMesh2dControl (void *pImpl)
 
- Protected Member Functions inherited from OdBrMeshControl
 OdBrMeshControl ()
 

Additional Inherited Members

- Protected Attributes inherited from OdBrMeshControl
voidm_pImp
 

Detailed Description

This interface class represents 2D mesh controls. It defines specific functions used to set controls for generating 2D meshes.

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

<group OdBr_Classes>

Definition at line 41 of file BrMesh2dControl.h.

Constructor & Destructor Documentation

◆ OdBrMesh2dControl() [1/3]

OdBrMesh2dControl::OdBrMesh2dControl ( )

Default constructor.

◆ OdBrMesh2dControl() [2/3]

OdBrMesh2dControl::OdBrMesh2dControl ( const OdBrMesh2dControl src)

Copy constructor.

◆ ~OdBrMesh2dControl()

OdBrMesh2dControl::~OdBrMesh2dControl ( )

Destructor.

◆ OdBrMesh2dControl() [3/3]

OdBrMesh2dControl::OdBrMesh2dControl ( void pImpl)
protected

Member Function Documentation

◆ getElementShape()

OdBrErrorStatus OdBrMesh2dControl::getElementShape ( Element2dShape elementShape) const

Returns the element shape criteria.

Parameters
elementShape[out] Shape of the mesh.
Returns
Returns odbrOK if successful, or an appropriate error code if not.

◆ getMaxAspectRatio()

OdBrErrorStatus OdBrMesh2dControl::getMaxAspectRatio ( double &  maxAspectRatio) const

Returns the maximum aspect ratio between width and height for a 2D mesh element.

Parameters
maxAspectRatio[out] Maximum aspect ratio.
Returns
Returns odbrOK if successful, or an appropriate error code if not.

◆ operator=()

OdBrMesh2dControl & OdBrMesh2dControl::operator= ( const OdBrMesh2dControl src)

Assignment operator.

◆ setElementShape()

OdBrErrorStatus OdBrMesh2dControl::setElementShape ( Element2dShape  elementShape = kDefault)

Sets the element shape criteria.

Parameters
elementShape[in] Shape of the mesh.
Returns
Returns odbrOK if successful, or an appropriate error code if not.

◆ setMaxAspectRatio()

OdBrErrorStatus OdBrMesh2dControl::setMaxAspectRatio ( double  maxAspectRatio = 0)

Sets the maximum aspect ratio between width and height for a 2D mesh element.

Parameters
maxAspectRatio[in] The value of the ratio.
Returns
Returns odbrOK if successful, or an appropriate error code if not.
Remarks
If the argument value is between zero and one, the aspect ratio relationship is inverted to a height-to-width ratio.

Member Data Documentation

◆ OdBrMesh2dControlDefault

const ODBR_TOOLKIT_EXPORT_STATIC OdBrMesh2dControl& OdBrMesh2dControl::OdBrMesh2dControlDefault
static

Definition at line 110 of file BrMesh2dControl.h.


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