#include <BrFace.h>
Inheritance diagram for OdBrFace:
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 } |
Additional Inherited Members | |
 Static Public Attributes inherited from OdBrEntity | |
| static ODBR_TOOLKIT_EXPORT_STATIC double | dUnspecified |
| Protected Member Functions inherited from OdBrEntity | |
| OdBrEntity () | |
| Protected Attributes inherited from OdBrEntity | |
| void * | m_pImp |
| OdSharedPtr< OdDbStubPtrArray > | m_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>
Member Enumeration Documentation
◆ AutoTransform
◆ Projection
| enum OdBrFace::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 | |
◆ Tiling
| enum OdBrFace::Tiling |
Constructor & Destructor Documentation
◆ OdBrFace()
| OdBrFace::OdBrFace | ( | ) |
◆ ~OdBrFace()
| OdBrFace::~OdBrFace | ( | ) |
Member Function Documentation
◆ getArea()
| OdBrErrorStatus OdBrFace::getArea | ( | double & | area, |
| const double * | tolRequired = NULL, |
||
| double * | tolAchieved = NULL |
||
| ) | const |
Provides the surface area of the face as a double value.
- Parameters
-
area [out] Surface area of the face. tolRequired [in] Optional tolerance required for the result of the calculation. tolAchieved [out] Optional tolerance achieved in the calculation.
- Returns
- odbrNotImplementedYet - if the method is not implemented for the current modeler; odbrUninitialisedObject - if object is uninitalised; odbrInvalidInput - if calculation unsuccess; odbrOK - if the calculation was successful;
- Remarks
- If the surface area property is not applicable to the entity, odbrNotApplicable is returned. If an error occurs, the value of the surface area argument remains unchanged.
◆ 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.
◆ getExtraFillingAttributes()
| bool OdBrFace::getExtraFillingAttributes | ( | OdGiFill * | pFill | ) | const |
BimRv specific. Returns extra filling attributes for the face. Extra filling attributes are supposed to be special lineweight, color and transparency for the filling that differs with such of entity.
- Parameters
-
pFill [inout] OdGiFill that is written with extra filling attribute.
- Returns
- Returns true if there are extra filling attributes assosiated with the face and false otherwise.
◆ getFill()
| const OdGiFill * OdBrFace::getFill | ( | ) | const |
BimRv specific. Returns OdGiFill for the face if the face fill pattern data.
- Returns
- Proper OdGiFill* if there is pattern data for the face, or null pointer value otherwise.
◆ getFillingAttributes()
| bool OdBrFace::getFillingAttributes | ( | OdGePoint2d & | origin, |
| OdGeVector2d & | dir | ||
| ) | const |
BimRv specific. Returns filling attributes for the face.
- Returns
- Returns true if there are filling attributes assosiated with the face and false otherwise.
- Parameters
-
origin [out] Receives filling origin attribute. dir [out] Receives filling direction attribute.
◆ getFillPatternId()
| bool OdBrFace::getFillPatternId | ( | OdUInt64 & | id | ) | const |
BimRv specific. Returns entity id that contains filling data for the face.
- Returns
- Returns true if there is filling entity assosiated with the face and false otherwise.
- Parameters
-
id [out] Receives the requested id.
◆ getFirstFaceRegion()
| bool OdBrFace::getFirstFaceRegion | ( | OdBrFace & | face | ) | 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.
◆ getNextFaceRegion()
| bool OdBrFace::getNextFaceRegion | ( | OdBrFace & | face | ) | const |
◆ 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: