#include <Db3dSolid.h>
Public Member Functions inherited from Detailed Description
This class represents 3D Solid entities in an OdDbDatabase instance.
- See also
- TD_Db
- Remarks
- An OdDb3dSolid entity is a wrapper for an ACIS model that represents the geometry of the OdDb3dSolid entity.
<group OdDb_Classes>
Definition at line 76 of file Db3dSolid.h.
Constructor & Destructor Documentation
◆ OdDb3dSolid()
| OdDb3dSolid::OdDb3dSolid | ( | ) |
Member Function Documentation
◆ acisIn()
| OdResult OdDb3dSolid::acisIn | ( | OdStreamBuf * | pStreamBuf, |
| AfTypeVer * | pTypeVer = 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.
pTypeVer [in] Receives the type and version of the ACIS data read.
- Returns
- Returns eOk if successful or an appropriate error code if not.
◆ acisOut()
| OdResult OdDb3dSolid::acisOut | ( | OdStreamBuf * | pStreamBuf, |
| AfTypeVer | typeVer = kAfTypeVerAny |
||
| ) |
◆ body()
|
virtual |
Returns contained modeler geometry of this entity.
◆ booleanOper()
|
virtual |
Performs a Boolean operation between this solid and another solid object.
- Parameters
-
operation [in] Type of Boolean operation.
solid [out] Pointer to other solid object which also will contain the result of the Boolean operation. \returns Returns eOk if Boolean operation is successful or an appropriate error code if not. If solid is null, eInvalidInput is returned.
- Remarks
- Possible operation types are: kBoolUnite - unites two solids into one kBoolIntersect - returns the intersection of two solids kBoolSubtract - subtracts the second solid from the first one
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.
◆ chamferEdges()
|
virtual |
Creates chamfers at the edges of a solid.
- Parameters
-
edgeSubentIds [in] Array of edge object IDs. The chamfer will be applied at the specified edges. baseFaceSubentId [in] Base face object IDs. Chamfer will be applied on the specified face. baseDist [in] Chamfer distance for the base face. otherDist [in] Chamfer distance for the other faces.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
- Remarks
- This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ checkInterference()
|
virtual |
Checks whether the solid interferes with another solid object.
- Parameters
-
otherSolid [in] A pointer to another solid object for checking interference. createNewSolid [in] A flag determining where a new solid object containing the interference must be created. solidsInterfere [out] A reference to a boolean variable where the result of the interference checking will be stored and returned. commonVolumeSolid [out] A reference to a pointer to a new solid containing the interference of the origin solid and otherSolid.
- Returns
- Returns eOk if interference checking is successful or an appropriate error code in other case.
- Remarks
- The caller of this function is responsible for the memory used by the object pointed by commonVolumeSolid (resulting from intersection of this solid and otherSolid) when the function finishes. In the case when commonVolumeSolid is added to a database, the database takes responsibility for the memory pointed by commonVolumeSolid. In the case when commonVolumeSolid is not added to a database, the caller must delete memory when it is no longer needed to avoid a memory leak.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ cleanBody()
|
virtual |
Removes all edges and faces that are not needed for supporting the topology of the solid.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ convertToBrepAtSubentPaths()
|
virtual |
Converts individual history items from a parameterized type to a simple boundary-representation without its parameter or type information.
- Parameters
-
paths [in] Array of references to history items.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
- Remarks
- This method is not implemented.
◆ copyEdge()
|
virtual |
Copies the specified edge as a separate entity (instance of OdDbLine, OdDbCircle, OdDbArc, OdDbEllipse, OdDbSpline class).
- Parameters
-
subentId [in] Edge's subentity ID in the solid. newEntity [in] Reference to a new entity for the specified edge.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
- Remarks
- The properties of the resulting entity (color, layer, line type, lineweight) are inherited from the corresponding current document. The calling application is responsible for the memory located with the resulting entity. If the resulting entity is not appended to a database, it can cause a memory leak (if it is not deleted when it isn't needed anymore).
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ copyFace()
|
virtual |
Copies the specified face as a separate entity (OdDbRegion or otherwise will be OdDbBody).
- Parameters
-
subentId [in] Face's subentity ID in the solid. newEntity [in] Reference to a new entity containing a copy of the specified face.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
- Remarks
- If face is planar, an OdDbRegion entity is created. Otherwise an OdDbBody entity is created. The properties of the resulting entity (color, layer, line type, lineweight) are inherited from the corresponding current document.
The calling application is responsible for the memory located with the resulting entity. If the resulting entity is not appended to a database, it can cause a memory leak (if it is not deleted when it isn't needed anymore).
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ createBox()
|
virtual |
Creates a WCS aligned solid box centered about the world origin.
- Parameters
-
xLen [in] Dimension along the WCS X-axis. yLen [in] Dimension along the WCS Y-axis. zLen [in] Dimension along the WCS Z-axis.
- Remarks
- The following constraints are applied:
xLen >= 1e-6. yLen >= 1e-6. zLen >= 1e-6.
◆ createExtrudedSolid() [1/3]
|
virtual |
Creates a solid by extruding a face.
- Parameters
-
pSweepEnt [in] A pointer to the swept entity. faceSubentId [in] Object ID for the face that must be extruded. directionVec [in] Vector determining the direction and length of extruding. sweepOptions [in] A set of sweeping options.
- Returns
- Returns eOk if extruding was successful or an appropriate error code in other case.
- Remarks
- Sweeping parameters (for example, angle) are set through the sweepOptions object reference.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ createExtrudedSolid() [2/3]
|
virtual |
Creates a solid by extruding a face.
- Parameters
-
pSweepEnt [in] A pointer to the swept entity. faceSubentId [in] Object ID for the face that must be extruded. height [in] Multiplier for the direction vector. sweepOptions [in] A set of sweeping options.
- Returns
- Returns eOk if extruding was successful or an appropriate error code in other case.
- Remarks
- Sweeping parameters (for example, angle) are set through the sweepOptions object reference.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ createExtrudedSolid() [3/3]
|
virtual |
Creates a solid by sweeping a planar curve, region, or planar surface in the direction of the given vector using a distance equal to the length of the vector.
- Parameters
-
pSweepEnt [in] A pointer to the swept entity. directionVec [in] Vector determining the direction and length of extruding. sweepOptions [in] A set of sweeping options.
- Returns
- Returns eOk if extruding was successful or an appropriate error code in other case.
- Remarks
Sweeping parameters (for example, angle) are set through the sweepOptions object reference.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ createFrom()
|
virtual |
Creates a 3D solid from the specified entity.
- Parameters
-
pFromEntity [in] Pointer to an entity from which the solid must be created.
- Returns
- Returns eOk if conversion is successful or an appropriate error code in other case.
- Remarks
An entity to create from must enclose a volume and can be one of the following: OdDbSurface OdDbSubDMesh closed curve with thickness thick OdDbSolid thick OdDbTrace polyline with constant width and thickness
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ createFrustum()
|
virtual |
Creates a WCS aligned frustum centered about the world origin.
- Parameters
-
height [in] Dimension along the WCS Z-axis. xRadius [in] Base radius along the WCS X-axis. yRadius [in] Base radius along the WCS Y-axis. topXRadius [in] Top radius along the WCS X-axis.
- Remarks
- The function can generate a frustum that is any one of the following:
A circular cylinder (when xRadius is equal to topXRadius and xRadius and yRadius are the same) An elliptical cylinder (when xRadius is equal to topXRadius and xRadius and yRadius are not the same) A circular cone (when topXRadius is zero and xRadius and yRadius are the same) An elliptical cone (when topXRadius is zero and xRadius and yRadius are not the same) A truncated circular cone (when topXRadius is not zero but not equal to xRadius and xRadius and yRadius are the same) A truncated elliptical cone (when topXRadius is not zero but not equal to xRadius and xRadius and yRadius are not the same)
The following constraints are applied:
height >= 1e-6. xRadius >= 1e-6. yRadius >= 1e-6. topXRadius >= 1e-6.
◆ createLoftedSolid()
|
virtual |
Creates a lofted solid from the given curves.
- Parameters
-
crossSectionCurves [in] An array of curve entities to be used as cross sections for the lofting operation. guideCurves [in] Array of guide curves. pPathCurve [in] Path curve. loftOptions [in] Options for lofting.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
- Remarks
- Lofting parameters can be passed with the loftOptions parameter.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ createPyramid()
|
virtual |
Creates a pyramid. World origin is centered about the base of the pyramid and the pyramid is positioned at half of the specified height above the world origin.
- Parameters
-
height [in] Value of the pyramid's height. sides [in] Quantity of sides for the pyramid. radius [in] Radius for circle inscribed into the bottom polygon. topRadius [in] Radius for circle inscribed into the top polygon.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
- Remarks
- The pyramid's base is located in the X-Y plane of the WCS. The pyramid's direction (from the base to the top) coincides with the positive direction of the Z axis. When radius and topRadius values are equal, a prism is created.
The following constraints are applied: |height| >= 1e-6; |radius| >= 1e-6; |topRadius| >= 1e-6; 3 <= sides <= 64.
◆ createRevolvedSolid() [1/2]
|
virtual |
Creates a solid by revolving a face about the axis of revolution.
- Parameters
-
pRevEnt [in] Pointer to entity containing face for revolving. faceSubentId [in] Face's subentity ID. axisPnt [in] Point on the axis of revolution. axisDir [in] Direction of revolution axis. revAngle [in] Revolve angle in radians. startAngle [in] Start angle of rotation. If 0, then rotation will start from current position of pRevEnt. revolveOptions [in] Revolve options.
- Returns
- Returns eOk if successful, or an appropriate error code in other case.
- Remarks
- Entity for revolving must be a valid planar curve, region, or planar surface.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ createRevolvedSolid() [2/2]
|
virtual |
Creates a solid by revolving a specified curve, region, or planar surface around the specified axis of revolution.
- Parameters
-
pRevEnt [in] Pointer to the planar curve, region, or planar surface that must be revolved. axisPnt [in] Point on the axis of revolution. axisDir [in] Direction of the revolution axis. revAngle [in] Revolve angle in radians. startAngle [in] Start angle of rotation. If 0, then rotation will start from current position of pRevEnt. revolveOptions [in] Revolve options.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
- Remarks
- Axis of revolution is defined by a point (axisPnt) and vector (axisDir). pRevEnt will be revolved according to the start and revolve angles counter-clockwise about the axisDir vector.
Options for revolving can be specified with the revolveOptions object reference.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ createSculptedSolid()
| OdResult OdDb3dSolid::createSculptedSolid | ( | OdDbEntityPtrArray & | limitingBodies, |
| const OdGeIntArray & | limitingFlags | ||
| ) |
Creates a solid by trimming and (or) extending the specified surfaces and 3D solids, forming an enclosed volume.
- Parameters
-
limitingBodies [in] Reference to the entity array (representing surface and solids) that are used to create a solid. \params limitingFlags [in] Reserved for internal use.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
- Remarks
- This method is not implemented.
◆ createSphere()
|
virtual |
Creates a sphere centered about the world origin with the specified radius.
- Parameters
-
radius [in] Radius for the sphere.
- Remarks
- The following constraints are applied:
radius >= 1e-6.
◆ createSweptSolid() [1/2]
|
virtual |
Creates a swept solid by sweeping a face along the specified path.
- Parameters
-
pSweepEnt [in] Pointer to face entity for sweeping. faceSubentId [in] Face's subentity ID. pPathEnt [in] Pointer to the curve entity that determines the path to sweep along. sweepOptions [in] Sweep options.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
- Remarks
- To set optional sweep parameters (for example, draft angle) use the sweepOptions parameter. The default value for the alignment option of OdDbSweepOptions (returned by align() method) is kNoAlignment. Set it to kAlignSweepEntityToPath before calling this method.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ createSweptSolid() [2/2]
|
virtual |
Creates a swept solid by sweeping a curve, region, or planar surface along the specified path.
- Parameters
-
pSweepEnt [in] Pointer to face entity for sweeping. pPathEnt [in] Pointer to the curve entity that determines the path to sweep along. sweepOptions [in] Sweep options.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
- Remarks
To set optional sweep parameters (for example, draft angle) use the sweepOptions parameter.
The default value for the alignment option of OdDbSweepOptions (returned by align() method) is kNoAlignment. Set it to kAlignSweepEntityToPath before calling this method.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ createTorus()
|
virtual |
Creates a WCS aligned torus centered about the world origin and the Z-axis as its axis of rotation.
- Parameters
-
majorRadius [in] Radius of the torus minorRadius [in] Radius of the tube.
- Remarks
- majorRadius in contrast to minorRadius can't be equal to zero. If majorRadius is smaller than zero, minorRadius must be larger than the absolute value of majorRadius.
The following constraints are applied:
minorRadius >= 1e-6. |majorRadius| >= 1e-6 if majorRadius < 0, then minorRadius > |majorRadius| + 1e-6
◆ createWedge()
|
virtual |
Creates a WCS aligned wedge centered about the world origin.
- Parameters
-
xLen [in] Dimension along the WCS X-axis. yLen [in] Dimension along the WCS Y-axis. zLen [in] Dimension along the WCS Z-axis.
- Returns
- Returns eOk if successful or an appropriate error code if not.
- Remarks
- The inclined face is defined by the points
( xLen/2, -yLen/2, -zLen/2) (-xLen/2, -yLen/2, zLen/2) ( xLen/2, yLen/2, -zLen/2) (-xLen/2, +yLen/2, zLen/2)The following constraints are applied:
xLen >= 1e-6. yLen >= 1e-6. zLen >= 1e-6.
◆ 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.
◆ extrude()
|
virtual |
Creates a solid by extruding the specified region to the specified height and with specified taper angle.
- Parameters
-
pRegion [in] Pointer to the region to be extruded. height [in] Height of the extrusion. taperAngle [in] Taper angle in radians.
- Returns
- Returns eOk if extrusion is successful or an appropriate error code if not.
- Remarks
- The extrusion direction is along the normal of the region. The height value may be negative. pRegion should not have self-intersections. Creates a solid by extruding pRegion, a distance of height with a taper angle of taper. The extrusion direction is along the normal of the region if the height is positive.
The following constraints are applied:
|height| >= 1e-6. |taperAngle| < OdaPI2 - 1e-6.
Taper should be between half pi and -half pi. If the absolute value of taper < 1e-6, then the taper angle is set to 0.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ extrudeAlongPath()
|
virtual |
Creates a solid by extruding a region along a path curve.
- Parameters
-
region [in] A pointer to a region object for extruding from path [in] A pointer to a curve object to extrude along. Must be one of the following: Line OdDbArc OdDbCircle Ellipse OdDbSpline OdDb2dPolyline non-spline fit OdDb3dPolyline taperAngle [in] Extrusion taper angle in radians. Default value is 0.0. Value must be between 0.5 pi and -0.5 pi. If the path represented by the OdDbCurve object is closed, the taper angle parameter is ignored. \returns Returns eOk if extruding operation is successful or an appropriate error code if not. If solid is null, eInvalidInput is returned.
- Remarks
- Entity path must not have self-intersections, and it is recommended that the path not have high curvature areas.
The following constraints are applied: |taper Angle| >= 1e-6
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ extrudeFaces()
|
virtual |
Extrudes faces of the solid with specified distance and taper angle.
- Parameters
-
faceSubentIds [in] Face's subentity ID in the solid. height [in] Distance of extrusion. taper [in] Taper angle.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
- Remarks
The distance of extrusion is determined by the height parameter and the taper angle (the taper parameter).
The extrusion direction can be along or opposite the normal of each extruded face depending on the height value: If height is positive, direction is along the normal (extruding faces outward from the solid). If height is negative, direction is opposite the normal (extruding faces into the solid).
If the absolute value of taper is less than 1e-6, taper angle is assumed to be equal to 0.0.
If taper value does not equal 0.0, each face should have edges that join together smoothly (i.e. tangents at the points of connection must be equal).
The following constraints are applied: number of specified faces (in faceSubentIds parameter) must be more than zero |height| >= 1e-6 |taper| >= (PI/2) - 1e-6
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ extrudeFacesAlongPath()
|
virtual |
Extrudes specified faces along the specified path determined by a curve entity.
- Parameters
-
faceSubentIds [in] Array of faces' subentity IDs. Faces with specified IDs will be extruded. path [in] Pointer to a curve object to extrude along (extrusion path). Can not be NULL.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
Faces for extrusion must be planar.
Curve entity must be one of the following: OdDbLine OdDbArc OdDbEllipse OdDbSpline OdDb2dPolyline Non-spline fit OdDb3dPolyline
Extrusion path must not have self-intersections. Also it is recommended that the path doesn't have high curvature areas. If one of the end points of the path is not located on the region's plane, the path will move the point on the plane.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ filletEdges()
|
virtual |
Creates rounded fillets on the edges of a solid.
- Parameters
-
edgeSubentIds [in] Array of edges' object IDs. Fillet will be applied on the specified edges. radius [in] Array of fillet radius values for the corresponding edges. startSetback [in] Array of start setback values for the corresponding edges. endSetback [in] Array of end setback values for the corresponding edges.
- Returns
- Returns eOk if successful or an appropriate error code in other case
- Remarks
- This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ getArea()
|
virtual |
Calculates the area of the solid.
- Parameters
-
area [out] Reference for returning the area value.
- Returns
- Returns eOk if successful or an appropriate error code in other case. Area value is returned in square drawing units.
- Remarks
- This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ getMassProp()
|
virtual |
Returns volume properties of the solid.
- Parameters
-
volume [out] A reference for returning the volume of the solid. centroid [out] A reference to an OdGePoint3d object for returning the point, representing the centroid of the solid. momInertia [out] A static array for returning X, Y, Z moments of inertia of the solid. prodInertia [out] A static array for returning X, Y, Z products of inertia of the solid. prinMoments [out] A static array for returning X, Y, Z principal moments of the solid. prinAxes [out] A static array for returning an OdGeVector3d object, determining principal axes of the solid. radiiGyration [out] A static array for returning X, Y, Z radii of gyration of the solid. extents [out] A reference to an OdGeExtents3d object for returning the bounding box of the solid.
- Returns
- Returns the result of getting volume properties of the solid: eOk if successful or an appropriate error code in other case. All properties are evaluated in the WCS.
- Remarks
- This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ getSection()
|
virtual |
Creates a DbRegion entity as a result of the intersection between the specified plane and the solid.
- Parameters
-
plane [in] A reference to an OdGePlane object to use as the section cutting plane. sectionRegion [out] A reference to a new region created as the result of the intersection between the specified plane and the solid.
- Returns
- Returns the result of the intersecting the solid with a plane: eOk if successful or an appropriate error code in other case. Value eOk is also returned when a plane and the solid do not intersect each other or if the intersection region is not a valid region: it intersects at a point, along a bounding face of the solid and so on.
- Remarks
- This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ getSlice() [1/2]
|
virtual |
Slices the solid with a plane and transforms the native solid to be the portion remaining on the positive side of the normal of the slicing plane.
- Parameters
-
plane [in] A reference to a slicing plane. bGetNegHalfToo [in] A flag determining whether the other (negative) part of the native solid should be created as a separate solid (when true). pNegHalfSolid [out] A reference to a pointer to the created solid representing the negative half of the native solid. If bGetNegHalfToo is false, NULL value is returned.
- Returns
- Returns eOk if the native solid was successfully sliced or an appropriate error code in other case. If the slicing plane does not intersect the solid, the solid is left unchanged, pNegHalfSolid is set to NULL, and eOk is returned.
- Remarks
- The caller of this function is responsible for the memory used by the object pointed to by pNegHalfSolid (negative part of the sliced solid) when the function finishes. In the case when pNegHalfSolid is added to a database, the database takes responsibility for the memory. In the case when pNegHalfSolid is not added to a database, the caller must delete memory when it is no longer needed to avoid a memory leak.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ getSlice() [2/2]
|
virtual |
Slices the solid with a surface and transforms the native solid to be the portion remaining on the positive side of the slicing surface normal.
- Parameters
-
pSurface [in] A pointer to a slicing surface. bGetNegHalfToo [in] A flag determining whether the other (negative) part of the native solid should be created as a separate solid (when true). pNegHalfSolid [out] A reference to a pointer to the created solid representing the negative half of the native solid. If bGetNegHalfToo is false, NULL value is returned.
- Returns
- Returns eOk if the native solid was successfully sliced or an appropriate error code in other case. If pSurface pointer is NULL or the solid is empty, returns eInvalidInput.
- Remarks
- The native solid will be transformed to a resulting body which is located in the negative side of the surface normal.
The caller of this function is responsible for the memory used by the object pointed to by pNegHalfSolid (negative part of the sliced solid) when the function finishes. In the case when pNegHalfSolid is added to a database, the database takes responsibility for the memory. In the case when pNegHalfSolid is not added to a database, the caller must delete memory when it is no longer needed to avoid a memory leak.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ getSubentColor()
|
virtual |
Returns the color of the specified subentity.
- Parameters
-
subentId [in] ID of subentity. color [in] A reference to an OdCmColor object to store the current color of the specified subentity.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
◆ getSubentMaterial()
|
virtual |
Returns the material of the specified subentity.
- Parameters
-
subentId [in] Subentity ID. matId [in] Reference to an OdDbObjectId for returning the material object ID.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
◆ getSubentMaterialMapper()
|
virtual |
Returns current material mapper for the specified subentity.
- Parameters
-
subentId [in] Subentity ID. mapper [out] Reference to an OdGiMapper object containing the current subentity material mapper.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
◆ imprintEntity()
|
virtual |
Intersects the given entity with the solid and imprints their intersection graph onto the solid.
- Parameters
-
pEntity [in] A Pointer to an entity to be imprinted.
- Returns
- Returns eOk if imprinting entity onto the solid is successful or an appropriate error code if not.
- Remarks
- The given entity must be one of the following: Curve OdDb3dSolid Body Region Trace OdDbSolid Face
If the solid is null, or if the given entity is not one of the entities listed above, eInvalidInput is returned.
If as a result of intersection a closed loop of new edges is created, a new face will be made. If an open loop of edges is made, it can be added to an existing loop as a spur. Or it can be added as a slit in the face.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ internalSubentId()
|
virtual |
◆ internalSubentPtr()
|
virtual |
◆ isNull()
| bool OdDb3dSolid::isNull | ( | ) | const |
Returns true if and only if there is no ACIS model associated with this entity.
◆ numChanges()
|
virtual |
Returns the number of changes occurred since the solid's creation.
◆ ODDB_DECLARE_MEMBERS()
| OdDb3dSolid::ODDB_DECLARE_MEMBERS | ( | OdDb3dSolid | ) |
◆ offsetBody()
|
virtual |
Offsets all faces by the specified distance.
- Parameters
-
offsetDistance) [in] A distance for offset.
- Returns
- Returns eOk if all faces are successfully offset, or an appropriate error code in other case. Returns eInvalidInput if the offsetDistance is less than -maxSide/2, where maxSide is the size of the greater side of the solid's bounding box. Also eInvalidInput is returned when the absolute value of offsetDistance is less than 1e-6.
- Remarks
If a face has surfaces that cannot be offset, it is removed. Therefore, the offset operation can cause the solid to become invalid.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ offsetFaces()
|
virtual |
Offsets the specified faces of the solid for the specified distance.
- Parameters
-
faceSubentIds [in] Array of faces' subentity IDs. Faces with specified IDs will be offset. offsetDistance [in] Offset distance.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
- Remarks
- Faces with surfaces that cannot be offset are removed and the solid is healed, if possible.
The following constraints are applied: number of specified faces (in faceSubentIds parameter) must be more than zero offsetDistance >= minus half of the max side of the solid's bounding box |offsetDistance| >= 1e-6
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ projectOnToSolid()
| OdResult OdDb3dSolid::projectOnToSolid | ( | const OdDbEntity * | pEntityToProject, |
| const OdGeVector3d & | projectionDirection, | ||
| OdDbEntityPtrArray & | projectedEntities | ||
| ) | const |
Creates non-database resident entities by projecting the specified entity along the projection direction to the solid.
- Parameters
-
pEntityToProject [in] Pointer to the entity to be projected. projectionDirection [in] Vector determining the projection direction. projectedEntities [out] Array of pointers to non-database resident entities created by the projection.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
- Remarks
Specified pointer to the entity must not be equal to NULL and the entity must be of a supported type.
When an OdDbPoint is specified as the entity to be projected, the result of the projection will be an AcDbPoint representing the nearest point on the solid.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ recordHistory()
|
virtual |
Returns whether the solid records its operations history.
- Remarks
- This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ removeFaces()
|
virtual |
Removes the specified faces from the solid.
- Parameters
-
faceSubentIds [in] Array of faces' subentity IDs. Faces with specified IDs will be removed.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
- Remarks
- After removing specified faces, the adjacent faces will enlarge to fill the gaps. This method implements gap filling only if there is no other solution using adjacent faces. If adjacent faces can't be used, the method leaves the solid unmodified.
Removing faces can cause the solid to become invalid in some cases.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ revolve()
|
virtual |
Creates a solid by revolving the specified region around the axis. Axis is specified with a point and vector. Revolution can be produced with an angle.
- Parameters
-
pRegion [in] Pointer to the region to be revolved. axisPoint [in] Point on the axis of revolution. axisDir [in] Vector defining the axis of revolution. angleOfRevolution [in] Angle of revolution in radians.
- Returns
- Returns eOk if creating a solid by revolving is successful or an appropriate error code if not.
- Remarks
- The axis of revolution is projected onto the plane of the region, parallel to its normal. Revolution axis must be valid for a rotation of region: axisDir is not perpendicular to the plane of a region, axisDir does not pass through a region, etc.
The following constraints are applied: The projected axis of revolution cannot intersect the region. angleOfRevolution >= 1e-6
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ saveAs()
|
virtual |
Saves 3D solid entity to a .dwg file.
- Parameters
-
pWd [in] Pointer to an OdGiWorldDraw object instance used for saving the solid. ver [in] Version of saved .dwg file.
Creates a geometric representation of the entity 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.
◆ separateBody()
|
virtual |
Separates the solid into an array of solids representing the additional disjoint volumes. This solid is reduced to a solid with one volume.
- Parameters
-
newSolids [out] A reference to an array of pointers to OdDb3dSolid objects representing the additional disjoint volumes.
- Returns
- Returns eOk if separating was successful or an appropriate error code in other case.
- Remarks
- The calling application is responsible for the resulting entities (either appending them to a database or deleting them when they are no longer needed). If the new solids from the output array are not appended to the database, there will be a memory leak.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ 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 other case.
◆ setRecordHistory()
|
virtual |
Sets a new value for the flag that determines whether the solid records its operation history.
- Parameters
-
bRecord [in] Flag determining whether the solid records operation history.
- Returns
- Returns eOk if successful or an appropriate error code in other case
◆ setShowHistory()
|
virtual |
Sets a new value for the flag that determines whether to draw items from the solid's operation history.
- Parameters
-
bShow [in] Flag determining whether the solid records operation history.
- Remarks
- Returns eOk if successful or an appropriate error code in other case.
◆ setSubentColor()
|
virtual |
Sets the color of the specified face or edge subentity.
- Parameters
-
subentId [in] ID of subentity (face or edge) to be colored. color [in] Color value to set.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
◆ setSubentMaterial()
|
virtual |
Sets a material for the specified subentity.
- Parameters
-
subentId [in] Subentity ID matId [in] Object ID for the material.
- Returns
- Returns eOk if successful or an appropriate error code in other case
- Remarks
- To remove the currently assigned material, set matId parameter value to NULL.
◆ setSubentMaterialMapper()
|
virtual |
Sets an explicit material mapper for the specified subentity.
- Parameters
-
subentId [in] Subentity ID mapper [in] Pointer to an OdGiMapper object.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
- Remarks
- To remove the current material mapper assignment, set map parameter value to NULL.
◆ shellBody()
|
virtual |
Transforms the solid into a thin-walled solid shell by offsetting faces.
- Parameters
-
faceSubentIds [in] Array of faces' subentity IDs. Faces with specified IDs will be removed from the shell. offsetDistance [in] Offset distance for each face.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
- Remarks
- Offset can have an outside or inside direction related to the solid, depending on the sign of the offsetDistance parameter: positive value means outside direction negative value means inside direction
If a face has surfaces that cannot be offset by the thickness, it will be removed from the solid. Removal wound is healed with the surrounding face surfaces. Edges and vertices on the specified faces will be merged if possible. Isolated edges in tweaked faces and neighboring faces may degenerate to a point and will be removed. However, when removing loops or faces, insertion of edges or other topology changes are prohibited.
Operation can cause the solid to become invalid in some cases.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ showHistory()
|
virtual |
Returns whether to draw items from the solid's operation history.
- Remarks
- This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ stlOut()
Writes out a Stereo Lithography (STL) representation of the solid to a file with the specified name.
- Parameters
-
filename [in] Full file name. asciiFormat [in] A flag determining the format of the output file (if true, file has ASCII text format, or in other case file has binary format).
- Returns
- Returns eOk if successful or an appropriate error code in other case.
- Remarks
- If the specified file already exists, it will be overwritten.
This method is not implemented.
◆ subClose()
|
virtual |
This method is not implemented.
Reimplemented from OdDbObject.
◆ subExplode()
|
virtual |
Reimplemented from OdDbEntity.
◆ subGetClassID()
Reimplemented from OdDbEntity.
◆ subGetGeomExtents()
|
virtual |
Reimplemented from OdDbEntity.
◆ subGetGsMarkersAtSubentPath()
|
virtual |
Reimplemented from OdDbEntity.
◆ subGetSubentPathsAtGsMarker()
|
virtual |
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.
◆ subViewportDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ subWorldDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ taperFaces()
|
virtual |
Tapers the specified faces about the specified base point and draft vector for a specified draft angle.
- Parameters
-
faceSubentIds [in] Array of faces' subentity IDs. Faces with specified IDs will be tapered. basePoint [in] Reference to the base point of the draft plane. draftVector [in] Reference to the draft direction vector. draftAngle [in] Draft angle in radians.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
- Remarks
The base point and draft vector define a draft plane about which faces are tapered. If a face is lying in the draft plane, it will not be modified.
Tapering faces can cause the solid to become invalid in some cases.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
◆ transformFaces()
|
virtual |
Transforms the specified faces of a solid by applying the transformation matrix for rotation and (or) moving the faces.
- Parameters
-
faceSubentIds [in] Array of faces' subentity IDs. Faces with specified IDs will be transformed. matrix [in] Transformation matrix to be applied to the specified faces.
- Returns
- Returns eOk if successful or an appropriate error code in other case.
- Remarks
- Transformation faces can cause the solid to become invalid in some cases.
This method is implemented only for Spatial modeler and returns eNotImplementedYet status for other modelers.
The documentation for this class was generated from the following file: