CFx SDK Documentation  2023 SP0
Public Types | Public Member Functions | List of all members
OdBrFace Class Reference

#include <BrFace.h>

Inheritance diagram for OdBrFace:
OdBrEntity

Public Types

enum  Projection {
  kInheritProjection = 0 , kPlanar = 1 , kBox = 2 , kCylinder = 3 ,
  kSphere = 4
}
 
enum  Tiling {
  kInheritTiling = 0 , kTile = 1 , kCrop = 2 , kClamp = 3 ,
  kMirror = 4
}
 
enum  AutoTransform { kInheritAutoTransform = 0x0 , kNone = 0x1 , kObject = 0x2 , kModel = 0x4 }
 

Public Member Functions

OdBrErrorStatus getSurfaceAsNurb (OdGeNurbSurface &nurb) const
 
OdGeSurfacegetSurface () const
 
OdBrErrorStatus getSurfaceType (OdGe::EntityId &surfaceType) const
 
bool getOrientToSurface () const
 
bool getColor (OdCmEntityColor &color) const
 
bool getMaterialID (OdUInt64 &id) const
 
bool getMaterialString (OdString &strMatName) const
 
bool getMaterialMapper (OdGeMatrix3d &mx, Projection &projection, Tiling &tiling, AutoTransform &autoTransform) const
 
OdBrErrorStatus getSurfaceAsTrimmedNurbs (OdUInt32 &numNurbs, OdGeExternalBoundedSurface **&ppNurbs) const
 
bool getFillPatternId (OdUInt64 &id) const
 
bool getFillingAttributes (OdGePoint2d &origin, OdGeVector2d &dir) const
 
 OdBrFace ()
 
 ~OdBrFace ()
 
- Public Member Functions inherited from OdBrEntity
bool isNull () const
 
bool isEqualTo (const OdBrEntity *pOtherEntity) const
 
bool getBrep (OdBrBrep &brep) const
 
bool checkEntity () const
 
OdBrErrorStatus getSubentPath (OdDbBaseFullSubentPath &subPath) const
 
virtual ~OdBrEntity ()
 
OdBrErrorStatus setSubentPath (OdBrBrep &brep, OdDbBaseFullSubentPath &subpath)
 
OdBrErrorStatus getPointContainment (const OdGePoint3d &point, OdGe::PointContainment &containment, OdBrEntity *&brEntContainer) const
 
OdBrErrorStatus getLineContainment (const OdGeLinearEnt3d &line, const OdUInt32 &iNumHitsWanted, OdUInt32 &iNumHitsFound, OdBrHit *&brHit) const
 
OdBrErrorStatus setValidationLevel (const BrValidationLevel &level= *(BrValidationLevel *) NULL)
 
OdBrErrorStatus getValidationLevel (BrValidationLevel &level) const
 
OdUInt32 getFlags () const
 
OdInt32 getGsMarker () const
 
OdBrErrorStatus getMassProps (OdBrMassProps &massProps, const double &dDensity= *(double *) NULL, const double &dTolRequired= *(double *) NULL, double &dTolAchieved= *(double *) NULL) const
 
OdBrErrorStatus getVolume (double &dVolume, const double &dTolRequired= *(double *) NULL, double &dTolAchieved= *(double *) NULL) const
 
OdBrErrorStatus getSurfaceArea (double &dArea, const double &dTolRequired= *(double *) NULL, double &dTolAchieved= *(double *) NULL) const
 
OdBrErrorStatus getPerimeterLength (double &dLength, const double &dTolRequired= *(double *) NULL, double &dTolAchieved= *(double *) NULL) const
 

Additional Inherited Members

- Protected Member Functions inherited from OdBrEntity
 OdBrEntity ()
 
- Protected Attributes inherited from OdBrEntity
voidm_pImp
 
OdSharedPtr< OdDbStubPtrArraym_pFSubentPath
 
bool m_bIsValidate
 

Detailed Description

This class is the interface class for BREP faces.

Remarks
Faces are primary BREP elements with associated geometries: surfaces.
See also
TD_Br

<group OdBr_Classes>

Definition at line 50 of file BrFace.h.

Member Enumeration Documentation

◆ AutoTransform

Enumerator
kInheritAutoTransform 
kNone 
kObject 
kModel 

Definition at line 133 of file BrFace.h.

◆ Projection

Returns the material mapper of this Face entity.

Returns
Returns true if and only if this Face entity has a material mapper associated with it.
Parameters
mx[out] Receives the transformation matrix.
projection[out] Receives the projection flag.
tiling[out] Receives the tiling flag.
autoTransform[out] Receives the auto transform flag.
Enumerator
kInheritProjection 
kPlanar 
kBox 
kCylinder 
kSphere 

Definition at line 115 of file BrFace.h.

◆ Tiling

Enumerator
kInheritTiling 
kTile 
kCrop 
kClamp 
kMirror 

Definition at line 124 of file BrFace.h.

Constructor & Destructor Documentation

◆ OdBrFace()

OdBrFace::OdBrFace ( )

◆ ~OdBrFace()

OdBrFace::~OdBrFace ( )

Member Function Documentation

◆ getColor()

bool OdBrFace::getColor ( OdCmEntityColor color) const

Returns the color of this Face entity.

Returns
Returns true if and only if this Face entity has a color associated with it.
Parameters
color[out] Receives the color.

◆ getFillingAttributes()

bool OdBrFace::getFillingAttributes ( OdGePoint2d origin,
OdGeVector2d dir 
) const

◆ getFillPatternId()

bool OdBrFace::getFillPatternId ( OdUInt64 id) const

◆ getMaterialID()

bool OdBrFace::getMaterialID ( OdUInt64 id) const

Returns the material handle of this Face entity.

Returns
Returns true if and only if this Face entity has a material associated with it.
Parameters
id[out] Receives the id.

◆ getMaterialMapper()

bool OdBrFace::getMaterialMapper ( OdGeMatrix3d mx,
Projection projection,
Tiling tiling,
AutoTransform autoTransform 
) const

◆ getMaterialString()

bool OdBrFace::getMaterialString ( OdString strMatName) const

Returns the material name of this Face entity.

Returns
Returns true if and only if this Face entity has a material associated with it.
Parameters
strMatName[out] Receives the material name.

◆ getOrientToSurface()

bool OdBrFace::getOrientToSurface ( ) const

Returns true if and only if the outside of the face is in the direction of the surface normal.

◆ getSurface()

OdGeSurface* OdBrFace::getSurface ( ) const

Returns the underlying surface of this Face entity as an OdGeSurface.

◆ getSurfaceAsNurb()

OdBrErrorStatus OdBrFace::getSurfaceAsNurb ( OdGeNurbSurface nurb) const

Returns the underlying surface of this Face entity as an external OdGeNurbSurface.

Parameters
nurb[out] Receives the NURBS surface.

◆ getSurfaceAsTrimmedNurbs()

OdBrErrorStatus OdBrFace::getSurfaceAsTrimmedNurbs ( OdUInt32 numNurbs,
OdGeExternalBoundedSurface **&  ppNurbs 
) const

◆ getSurfaceType()

OdBrErrorStatus OdBrFace::getSurfaceType ( OdGe::EntityId surfaceType) const

Returns the best match of the underlying surface of this Face entity to surfaces supported by OdGe.

Parameters
surfaceType[out] Receives the surface type.

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