#include <DbRegion.h>
Static Public Member Functions | |
| static OdResult | createFromCurves (const OdRxObjectPtrArray &curveSegments, OdRxObjectPtrArray ®ions) |
 Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
Detailed Description
This class represents Region entities in an OdDbDatabase instance.
An OdDbRegion entity is a wrapper for an ACIS model that represents the geometry of the OdDbRegion entity.
- See also
- TD_Db
<group OdDb_Classes>
Definition at line 49 of file DbRegion.h.
Constructor & Destructor Documentation
◆ OdDbRegion()
| OdDbRegion::OdDbRegion | ( | ) |
Member Function Documentation
◆ acisIn()
| OdResult OdDbRegion::acisIn | ( | OdStreamBuf * | pStreamBuf, |
| AfTypeVer * | typeVer = 0 |
||
| ) |
Reads the ACIS data for this entity from the specified StreamBuf object.
- Parameters
-
pStreamBuf [in] Pointer to the StreamBuf object from which the data is to be read.
typeVer [out] Receives the type and version of the ACIS data to return.
- Returns
- eOk if successful or an appropriate error code in the other case.
- Remarks
- If typeVer is null, this function uses the type and version of this Region entity.
◆ acisOut()
| OdResult OdDbRegion::acisOut | ( | OdStreamBuf * | pStreamBuf, |
| AfTypeVer | typeVer = kAfTypeVerAny |
||
| ) |
◆ body()
|
virtual |
Returns the current modeler geometry.
◆ booleanOper()
|
virtual |
Performs a Boolean operation between this and another region object.
Possible operation types are: kBoolUnite - unites two regions into one. kBoolIntersect - returns the intersection of two regions. kBoolSubtract - subtracts the region from the first one.
- Parameters
-
operation [in] Type of Boolean operation.
otherRegion [out] Pointer to other region object which also will contain the result of the Boolean operation.
- Returns
- Returns eOk if the Boolean operation is successful or an appropriate error code if not. If the region is null, eInvalidInput is returned.
- Remarks
- This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ brep()
Returns the boundary representation of the 3D solid entity.
- Parameters
-
brep [out] Receives the boundary representation.
◆ createFromCurves()
|
static |
Creates OdDbRegion entities from the closed loops defined by the specified curve segments.
- Parameters
-
curveSegments [in] Array of curve segments. Each curve segment must be one of the following: OdDb3dPolyline, OdDbArc, OdDbCircle, OdDbEllipse, OdDbLine, OdDbPolyline, or OdDbSpline. regions [out] Receives an array of pointers to the regions.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- The newly created regions are non-database residents. It is up to the caller to either add them to an OdDbDatabase or to delete them.
◆ decomposeForSave()
|
virtual |
Determines the behavior for custom objects when saving to .dwg or .dxf file.
- Parameters
-
ver [in] Drawing version to save as. replaceId [out] Object ID of the object replacing this object. exchangeXData [out] Set to true if and only if this function did not add XData to the replacement object.
- Remarks
- This function either
Returns an OdDbObjectPtr for a non- database -resident (NDBRO) replacement object, setting replaceId to OdDbObjectId::kNull. Returns NULL, setting replaceId for a database -resident (DBRO) replacement object.
Custom objects can decompose themselves into other objects, adding additional XData as required. Teigha transfers XData from this object to the replacement object if and only if exchangeXData is true.
The default implementation returns NULL and sets replaceId to OdDbObjectId::kNull. This function can be overridden in custom classes.
The method is not intended to be called by client code. For processing owned objects use convertForSave() method.
Reimplemented from OdDbObject.
◆ dwgInFields()
|
virtual |
Reads the .dwg file data of this object.
- Parameters
-
pFiler [in] Filer object from which data are read.
- Returns
- Returns the filer status.
This function is called by dwgIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned. 4) Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbEntity.
◆ dwgOutFields()
|
virtual |
Writes the .dwg file data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are written.
- Remarks
This function is called by dwgIn() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbEntity.
◆ dxfInFields()
|
virtual |
Reads the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are read.
- Returns
- Returns the filer status.
This function is called by dxfIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbEntity.
◆ dxfOutFields()
|
virtual |
Writes the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are to be written.
- Remarks
This function is called by dxfOut() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 4) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbEntity.
◆ getArea()
|
virtual |
Calculates the area of the region. Area value is returned in square drawing units.
- Parameters
-
area [out] Reference for returning the area value.
- Returns
- Returns eOk if successful or an appropriate error code otherwise.
- Remarks
- This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ getAreaProp()
|
virtual |
Calculates the area properties of the region.
The method validates the origin, xAxis, and yAxis parameters to ensure that: axes are perpendicular to each other. axes and the origin lie in the same plane as the region.
- Parameters
-
origin [in] Origin of the coordinate system to use for evaluation (WCS). xAxis [in] X axis of the coordinate system to use for evaluation (WCS). yAxis [in] Y axis of the coordinate system to use for evaluation (WCS). perimeter [out] Reference for returning the value of region's perimeter. area [out] Reference for returning the value of region's area. centroid [out] Reference for returning centroid of the region. momInertia [out] Static array for returning moments of inertia for the region. prodInertia [out] Reference for returning region's product of inertia. prinMoments [out] Static array for returning principal moments for the region. prinAxes [out] Static array for returning principle axes of the region. radiiGyration [out] Static array for returning radii of gyration of the region. extentsLow [out] Reference for returning region's minimum extents point. extentsHigh [out] Reference for returning region's maximum extents point.
- Returns
- Returns eOk if successful, or an appropriate error code otherwise.
- Remarks
- Returned values are measured using the values of origin, xAxis, yAxis parameters. and are represented in WCS coordinates.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ getNormal()
|
virtual |
Returns the WCS normal to the plane of this entity (DXF 210).
- Parameters
-
normal [out] Receives the normal.
- Returns
- Returns eOk if successful or an appropriate error code if not.
◆ getPerimeter()
|
virtual |
Calculates the perimeter of the region. Perimeter value is returned in drawing units.
- Parameters
-
area [out] Reference for returning the perimeter value.
- Returns
- Returns eOk if successful, or an appropriate error code otherwise.
- Remarks
- This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ getPlane()
|
virtual |
Returns the OdGePlane object that contains the region. If the region is Null, then the WCS X-Y plane is returned.
- Parameters
-
plane [out] A reference to the OdGePlane object that stores the containing plane. planarity [out] A reference to a variable containing information about planarity of the OdGePlane object.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
- Remarks
- If typeVer is null, this function uses the type and version of this region entity.
Reimplemented from OdDbEntity.
◆ internalSubentId()
|
virtual |
◆ internalSubentPtr()
|
virtual |
◆ isNull()
| bool OdDbRegion::isNull | ( | ) | const |
Returns true if and only if there is no ACIS model associated with this entity.
◆ isPlanar()
|
virtual |
Returns true if the region is planar or false in the other case.
Reimplemented from OdDbEntity.
◆ numChanges()
|
virtual |
Returns the number of changes occurred since the region was created.
◆ ODDB_DECLARE_MEMBERS()
| OdDbRegion::ODDB_DECLARE_MEMBERS | ( | OdDbRegion | ) |
◆ saveAs()
|
virtual |
Creates a geometric representation of the region for saving proxy graphics or converting to previous formats.
- Parameters
-
pWd [in] Pointer to the OdGiWorldDraw object. ver [in] Specifies the reason why the method is called.
- Remarks
- This method can be overridden in a custom classes.
Reimplemented from OdDbEntity.
◆ setBody()
Directly sets the contained modeler geometry of this entity.
- Parameters
-
pGeometry [in] Pointer to the modeler geometry.
- Returns
- Returns eOk if successful or an appropriate error code in the other case.
◆ subExplode()
|
virtual |
Reimplemented from OdDbEntity.
◆ subGetClassID()
Reimplemented from OdDbEntity.
◆ subGetGeomExtents()
|
virtual |
Reimplemented from OdDbEntity.
◆ subGetGsMarkersAtSubentPath()
|
virtual |
Reimplemented from OdDbEntity.
◆ subGetSubentPathsAtGsMarker()
|
virtual |
Reimplemented from OdDbEntity.
◆ subIntersectWith() [1/2]
|
virtual |
Projects the bounding box edges of the region and the specified entity onto the specified plane, finds the intersection points for the projections, and then projects them back onto the bounding box edge of the region.
- Parameters
-
pEnt [in] Pointer to the entity which must be intersected with the region. intType [in] Intersection type. projPlane [in] Projection plane for the apparent intersection of the specified entity and the region. points [out] Reference to the array of the appended points of intersection (points coordinates are represented in WCS). thisGsMarker [in] GS marker of the subentity of the region involved in the intersection operation. otherGsMarker [in] GS marker of the subentity of the entity represented by pEnt that is involved in the intersection operation.
- Returns
- Returns eOk if successful or an appropriate error code otherwise.
- Remarks
- All the points appended to the points array will be on its bounding box edges. The projections are parallel to the normal vector of the plane referenced with projPlane. Intersection type can be one of the following: OdDb::kOnBothOperands - do not extend the region or the entity represented with pEnt bounding box edges. In this case the method calculates only where the bounding box lines actually intersect with the specified entity. OdDb::kExtendThis - extend the region's bounding box edges (if necessary) when calculating intersections without extending the specified entity.
OdDb::kExtendArg - extend the specified entity (if necessary) when calculating intersections without extending region's bounding box edges. OdDb::kExtendBoth extend both the region's bounding box and the specified entity (if necessary) when calculating intersections.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
Reimplemented from OdDbEntity.
◆ subIntersectWith() [2/2]
|
virtual |
Finds the intersections of the specified entity with all the edges of the region's bounding box.
- Parameters
-
pEnt [in] Pointer to the entity which must be intersected with the region. intType [in] Intersection type. points [out] Reference to the array of the appended points of intersection (point coordinates are represented in WCS). thisGsMarker [in] GS marker of the subentity of the region involved in the intersection operation. otherGsMarker [in] GS marker of the subentity of the entity represented by pEnt that is involved in the intersection operation.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
- Remarks
- The intType parameter determines the extension of the region and the specified entity while calculating intersections: OdDb::kOnBothOperands - do not extend the region or the entity represented with pEnt bounding box edges. In this case the method calculates only where the bounding box lines actually intersect with the specified entity. OdDb::kExtendThis - extend the region's bounding box edges (if necessary) when calculating intersections without extending the specified entity. OdDb::kExtendArg - extend the specified entity (if necessary) when calculating intersections without extending the region's bounding box edges. OdDb::kExtendBoth - extend both the region's bounding box and the specified entity (if necessary) when calculating intersections.
Any found intersection points are appended to the points array. All points are represented in WCS coordinates.
The thisGsMarker and otherGsMarker parameters provide information for searching intersections between specified subentities. The default value for these parameters is zero.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
Reimplemented from OdDbEntity.
◆ subSetAttributes()
|
virtual |
Sets the values of this object's subentity traits, and returns with the calling object's subentity traits.
- Parameters
-
pTraits [in] Pointer to the OdGiDrawableTraits object to be set.
- Remarks
- When overriding subSetAttributes(), you must OR (|) the return value of <base class>::subSetAttributes(pTraits) with any flags you add.
A derived class may not remove flags for any reason.
The default implementation does nothing but returns kDrawableNone. This function can be overridden in custom classes.
Reimplemented from OdDbEntity.
◆ subSubentPtr()
|
virtual |
Reimplemented from OdDbEntity.
◆ subTransformBy()
|
virtual |
Reimplemented from OdDbEntity.
◆ subWorldDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ TD_USING()
| OdDbRegion::TD_USING | ( | OdDbEntity::getPlane | ) |
The documentation for this class was generated from the following file: