#include <DbHatch.h>
Static Public Member Functions | |
| static OdResult | makeClosedLoop (EdgeArray &edgePtrs, const OdDbObjectIdArray &dbObjIds, const OdGeTol &gapTolerance, const bool &isEdgeArrayConsistent) |
 Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
Detailed Description
This class represents Hatch entities in an OdDbDatabase instance.
- Remarks
Loops must be closed, simple, and continuous. They must be self-intersecting itself only at their endpoints. Their start points and end points must coincide. The outer loops must be appended before all of their inner loops.
The Drawings provides limited validation of the hatch boundary in order to maintain API efficiency and performance.
<group OdDb_Classes>
Member Enumeration Documentation
◆ GradientPatternType
◆ HatchEdgeType
◆ HatchLoopType
◆ HatchObjectType
◆ HatchPatternType
◆ HatchStyle
Constructor & Destructor Documentation
◆ OdDbHatch()
| OdDbHatch::OdDbHatch | ( | ) |
Member Function Documentation
◆ appendLoop() [1/3]
| void OdDbHatch::appendLoop | ( | OdInt32 | loopType, |
| const OdDbObjectIdArray & | dbObjIds | ||
| ) |
Appends a loop onto this Hatch entity.
- Parameters
-
loopType [in] Type of loop being appended. dbObjIds [in] Array of OdDbEntity Object IDs that comprise the loop.
- Remarks
loopType is one of the following:
Value Description kDefault 0 Not yet specified. kExternal 1 Defined by external entities. kPolyline 2 Defined by OdGe polyline. kDerived 4 Derived from a picked point. kTextbox 8 Defined by text. kOutermost 0x10 Outermost loop. kNotClosed 0x20 Open loop. kSelfIntersecting 0x40 Self-intersecting loop. kTextIsland 0x80 Text loop surrounded by an even number of loops. kDuplicate 0x100 Duplicate loop.
◆ appendLoop() [2/3]
| void OdDbHatch::appendLoop | ( | OdInt32 | loopType, |
| const OdGePoint2dArray & | vertices, | ||
| const OdGeDoubleArray & | bulges | ||
| ) |
Appends a loop onto this Hatch entity.
- Parameters
-
loopType [in] Type of loop being appended. vertices [in] The vertices that comprise this loop. bulges [in] The bulges corresponding to the vertices array.
- Remarks
loopType is one of the following:
Value Description kDefault 0 Not yet specified. kExternal 1 Defined by external entities. kPolyline 2 Defined by OdGe polyline. kDerived 4 Derived from a picked point. kTextbox 8 Defined by text. kOutermost 0x10 Outermost loop. kNotClosed 0x20 Open loop. kSelfIntersecting 0x40 Self-intersecting loop. kTextIsland 0x80 Text loop surrounded by an even number of loops. kDuplicate 0x100 Duplicate loop.
◆ appendLoop() [3/3]
Appends a loop onto this Hatch entity.
- Parameters
-
loopType [in] Type of loop being appended. edgePtrs [in] Array OdGeCurve pointers to the edges that comprise this loop.
- Remarks
loopType is one of the following:
Value Description kDefault 0 Not yet specified. kExternal 1 Defined by external entities. kPolyline 2 Defined by OdGe polyline. kDerived 4 Derived from a picked point. kTextbox 8 Defined by text. kOutermost 0x10 Outermost loop. kNotClosed 0x20 Open loop. kSelfIntersecting 0x40 Self-intersecting loop. kTextIsland 0x80 Text loop surrounded by an even number of loops. kDuplicate 0x100 Duplicate loop.
edgePtrs may contain pointers to only the following objects:
OdGeLineSeg2d OdGeCircArc2d OdGeEllipArc2d OdGeNurbCurve2d
The hatch will take ownership of the curves passed in.
◆ appendOrderedLoop()
Appends an ordered loop onto this Hatch entity.
- Parameters
-
loopType [in] Type of loop being appended. edgePtrs [in] Array OdGeCurve pointers to the edges that comprise this loop.
- Remarks
loopType is one of the following:
Value Description kDefault 0 Not yet specified. kExternal 1 Defined by external entities. kPolyline 2 Defined by OdGe polyline. kDerived 4 Derived from a picked point. kTextbox 8 Defined by text. kOutermost 0x10 Outermost loop. kNotClosed 0x20 Open loop. kSelfIntersecting 0x40 Self-intersecting loop. kTextIsland 0x80 Text loop surrounded by an even number of loops. kDuplicate 0x100 Duplicate loop.
edgePtrs may contain pointers to only the following objects:
◆ appendSeedPoint()
| void OdDbHatch::appendSeedPoint | ( | const OdGePoint2d & | point | ) |
Appends the specified seed point to this Hatch entity (DXF 10).
- Parameters
-
point [in] Seed point.
◆ appendToOwner()
|
virtual |
This function appends this object to the specified owner object.
- Parameters
-
idPair [in] ID pair to append. pOwnerObject [in] Pointer to the owner object. ownerIdMap [in/out] Owner's ID map.
- Remarks
- Adds a record to the specified ID map. This function is used internally to subDeepClone() and subWblockClone().
Reimplemented from OdDbEntity.
◆ associative()
| bool OdDbHatch::associative | ( | ) | const |
Returns true if and only if this hatch is associative (DXF 71).
- Remarks
- Associative hatch is automatically recalculated when its boundaries are modified.
◆ backgroundColor()
| OdCmColor OdDbHatch::backgroundColor | ( | ) | const |
Returns the hatch background color.
◆ clearMarkModifiedLoops()
| void OdDbHatch::clearMarkModifiedLoops | ( | ) |
Clear recalculate loop list.
- Remarks
- Clear recalculate loop list written with OdDbHatch::markModifiedLoop.
◆ 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. The Drawings 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.
- Remarks
- 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().
- Returns
- Returns eOk if reading was successful or an appropriate OdResult error code in the other case.
Reimplemented from OdDbEntity.
◆ DWGMAP_DECLARE_MEMBERS()
| OdDbHatch::DWGMAP_DECLARE_MEMBERS | ( | OdDbHatch | ) |
◆ 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.
- Returns
- Returns eOk if writing was successful or an appropriate OdResult error code in the other case.
Reimplemented from OdDbEntity.
◆ dxfInFields()
|
virtual |
Reads the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are read.
- Remarks
- 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().
- Returns
- Returns eOk if reading was successful or an appropriate OdResult error code in the other case.
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). 3) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.
- Returns
- Returns eOk if writing was successful or an appropriate OdResult error code in the other case.
Reimplemented from OdDbEntity.
◆ elevation()
| double OdDbHatch::elevation | ( | ) | const |
Returns the elevation of this entity in the OCS (DXF 30).
- Remarks
- The elevation is the distance from the WCS origin to the plane of this entity.
◆ evaluateGradientColorAt()
Returns the interpolated color of the gradient definition.
- Parameters
-
value [in] Interpolation value. color [out] Receives the interpolated color.
◆ evaluateHatch()
Evaluates the hatch for this Hatch entity.
- Parameters
-
bUnderestimateNumLines [in] Underestimates the hatch count before aborting.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
◆ explodeGeometry()
|
virtual |
Explodes this entity into a set of simpler entities.
- Parameters
-
entitySet [in/out] Receives an array of pointers to the new entities.
- Remarks
- The newly created entities will be not database resident. Entities resulting from the explosion are appended to the specified array. The default implementation of this function calls subWorldDraw() and makes entities from geometry generated by subWorldDraw(). This function can be overridden in custom classes.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented from OdDbEntity.
◆ getArea()
|
virtual |
Returns the area of this entity.
- Parameters
-
area [out] Receives the area.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
◆ getAssocObjIds()
| void OdDbHatch::getAssocObjIds | ( | OdDbObjectIdArray & | dbObjIds | ) | const |
Returns the Object IDs comprising all the associative boundaries in this Hatch entity.
- Parameters
-
dbObjIds [out] Receives the boundary Object IDs.
- Remarks
- Returns nothing if this Hatch entity is not associative.
◆ getAssocObjIdsAt()
| void OdDbHatch::getAssocObjIdsAt | ( | int | loopIndex, |
| OdDbObjectIdArray & | dbObjIds | ||
| ) | const |
Returns the Object IDs comprising the specified associative loop in this Hatch entity.
- Parameters
-
loopIndex [in] Loop index. dbObjIds [out] Receives the boundary Object IDs.
- Remarks
- Returns nothing if this Hatch entity is not associative.
◆ getEcs()
|
virtual |
Returns the entity coordinate system matrix.
- Remarks
- Default implementation returns Identity matrix.
Reimplemented from OdDbEntity.
◆ getGradientColors()
| void OdDbHatch::getGradientColors | ( | OdCmColorArray & | colors, |
| OdGeDoubleArray & | values | ||
| ) | const |
Returns the colors and interpolation values describing the gradient fill for this Hatch entity.
- Parameters
-
colors [out] Array of colors defining the gradient. values [out] Array of interpolation values for the gradient.
◆ getGradientOneColorMode()
| bool OdDbHatch::getGradientOneColorMode | ( | ) | const |
Returns the oneColorMode for this Hatch entity.
◆ getHatchLineDataAt()
| void OdDbHatch::getHatchLineDataAt | ( | int | lineIndex, |
| OdGePoint2d & | startPoint, | ||
| OdGePoint2d & | endPoint | ||
| ) | const |
Returns the hatch line data for the specified hatch line in this Hatch entity.
- Parameters
-
lineIndex [in] Line index. startPoint [out] Receives the start point. endPoint [out] Receives the end point.
◆ getHatchLinesData()
| void OdDbHatch::getHatchLinesData | ( | OdGePoint2dArray & | startPoints, |
| OdGePoint2dArray & | endPoints | ||
| ) | const |
Returns all the hatch line data for this Hatch entity.
- Parameters
-
startPoints [out] Receives the start points. endPoints [out] Receives the end points.
◆ getLoopAt() [1/2]
Returns the specified loop from this Hatch entity.
- Parameters
-
loopIndex [in] Loop index. edgePtrs [out] Receives a set of OdGeCurve2d pointers to the edges that comprise this loop.
- Remarks
- Should be called with edgePtrs if the loop is not a polyline loop.
◆ getLoopAt() [2/2]
| void OdDbHatch::getLoopAt | ( | int | loopIndex, |
| OdGePoint2dArray & | vertices, | ||
| OdGeDoubleArray & | bulges | ||
| ) | const |
Returns the specified loop from this Hatch entity.
- Parameters
-
loopIndex [in] Loop index. vertices [out] Receives the vertices that comprise this loop. bulges [out] Receives a set of bulges corresponding to the vertices array.
- Remarks
- Should be called with vertices and bulges if the loop is a polyline loop.
◆ getMarkedModifiedLoops()
| void OdDbHatch::getMarkedModifiedLoops | ( | OdUInt16Array & | indicesMarkedLoops | ) | const |
Returns the loops marked as modified.
- Parameters
-
indicesMarkedLoops [out] Receives an array of loop index
- Remarks
- Returns an array containing loop indices written with OdDbHatch::markModifiedLoop
◆ getPattern()
| OdHatchPattern OdDbHatch::getPattern | ( | ) | const |
Returns the hatch pattern definition for this Hatch entity as it appears in the PAT file.
◆ getPatternDefinitionAt()
| void OdDbHatch::getPatternDefinitionAt | ( | int | lineIndex, |
| double & | lineAngle, | ||
| double & | baseX, | ||
| double & | baseY, | ||
| double & | offsetX, | ||
| double & | offsetY, | ||
| OdGeDoubleArray & | dashes | ||
| ) | const |
Returns the specified pattern definition line for this Hatch entity.
- Parameters
-
lineIndex [in] Line index. lineAngle [out] Receives the line angle (DXF 53). baseX [out] Receives the line base point X (DXF 43). baseY [out] Receives the line base point Y (DXF 44). offsetX [out] Receives the line offset X (DXF 45). offsetY [out] Receives the line offset Y (DXF 46). dashes [out] Receives the line dash lengths (DXF 79, 49).
◆ getPlane()
|
virtual |
Returns the plane that contains the curve and curve's configuration.
- Parameters
-
plane [out] Plain. planarity [out] Curve's configuration.
- Remarks
- planarity and plane return values as follows:
Value Description plane kNonPlanar 0 Non-planar. Not set. kPlanar 1 Planar. Entity plane. kLinear 2 Linear. Arrbitrary plane containing this entity.
- Returns
- Returns eOk if getting was successful or an appropriate OdResult error code in the other case.
Reimplemented from OdDbEntity.
◆ getRawPattern()
| OdHatchPattern OdDbHatch::getRawPattern | ( | ) | const |
Returns the hatch pattern definition for this Hatch entity as it appears in the DWG/DXF file.
◆ getRegionArea()
|
virtual |
Creates a region from the boundary loops of the hatch.
- Returns
- Returns null pointer if the hatch boundary doesn't have closed loops, or self intersection, or modeler can't create it.
◆ getSeedPointAt()
| const OdGePoint2d & OdDbHatch::getSeedPointAt | ( | unsigned | seedIndex | ) | const |
Returns the specified seed point from this Hatch entity (DXF 10).
- Parameters
-
seedIndex [in] Seed point index.
◆ getShadeTintValue()
| double OdDbHatch::getShadeTintValue | ( | ) | const |
Returns the luminance value for this Hatch entity.
- Returns
- Returns a value in the range. [0.0 .. 1.0].
If the gradient is using oneColorMode, this function returns the luminance value applied to the first color.
◆ gradientAngle()
| double OdDbHatch::gradientAngle | ( | ) | const |
Returns the angle of the gradient for this Hatch entity.
- Remarks
- All angles are expressed in radians.
◆ gradientName()
| OdString OdDbHatch::gradientName | ( | ) | const |
Returns the name of the gradient of this Hatch entity.
◆ gradientShift()
| double OdDbHatch::gradientShift | ( | ) | const |
Returns the interpolation value between the default and shifted values of the gradient's definition.
- Remarks
- A gradientShift of 0 indicates a fully unshifted gradient. A gradientShift of 1 indicates a fully shifted gradient.
◆ gradientType()
| OdDbHatch::GradientPatternType OdDbHatch::gradientType | ( | ) | const |
Returns the gradient type of this Hatch entity.
- Remarks
- gradientType is one of the following:
Value kPreDefinedGradient 0 kUserDefinedGradient 1
◆ hatchObjectType()
| OdDbHatch::HatchObjectType OdDbHatch::hatchObjectType | ( | ) | const |
Returns the hatch object type of this Hatch entity.
- Remarks
- hatchObjectType is one of the following:
Value Description kHatchObject 0 Classic hatch kGradientObject 1 Color gradient
◆ hatchStyle()
| OdDbHatch::HatchStyle OdDbHatch::hatchStyle | ( | ) | const |
Returns the hatch style of this hatch entity (DXF 75).
- Remarks
- hatchStyle is one of the following:
Value kNormal 0 kOuter 1 kIgnore 2
◆ insertLoopAt() [1/3]
| void OdDbHatch::insertLoopAt | ( | int | loopIndex, |
| OdInt32 | loopType, | ||
| const OdDbObjectIdArray & | dbObjIds | ||
| ) |
Inserts a loop into this Hatch entity on the specified index.
- Parameters
-
loopIndex [in] Loop index. loopType [in] Type of loop being appended. dbObjIds [in] Array of OdDbEntity Object IDs that comprise the loop.
- Remarks
- loopType is one of the following:
Value Description. kDefault 0 Not yet specified. kExternal 1 Defined by external entities. kPolyline 2 Defined by OdGe polyline. kDerived 4 Derived from a picked point. kTextbox 8 Defined by text. kOutermost 0x10 Outermost loop. kNotClosed 0x20 Open loop. kSelfIntersecting 0x40 Self-intersecting loop. kTextIsland 0x80 Text loop surrounded by an even number of loops. kDuplicate 0x100 Duplicate loop.
◆ insertLoopAt() [2/3]
| void OdDbHatch::insertLoopAt | ( | int | loopIndex, |
| OdInt32 | loopType, | ||
| const OdGePoint2dArray & | vertices, | ||
| const OdGeDoubleArray & | bulges | ||
| ) |
Inserts a loop into this Hatch entity on the specified index.
- Parameters
-
loopIndex [in] Loop index. loopType [in] Type of loop being appended. vertices [in] The vertices that comprise this loop. bulges [in] The bulges corresponding to the vertices array.
- Remarks
- loopType is one of the following:
Value Description. kDefault 0 Not yet specified. kExternal 1 Defined by external entities. kPolyline 2 Defined by OdGe polyline. kDerived 4 Derived from a picked point. kTextbox 8 Defined by text. kOutermost 0x10 Outermost loop. kNotClosed 0x20 Open loop. kSelfIntersecting 0x40 Self-intersecting loop. kTextIsland 0x80 Text loop surrounded by an even number of loops. kDuplicate 0x100 Duplicate loop.
The hatch will take ownership of the curves passed in.
◆ insertLoopAt() [3/3]
Inserts a loop into this Hatch entity on the specified index.
- Parameters
-
loopIndex [in] Loop index. loopType [in] Type of loop being appended. edgePtrs [in] Array OdGeCurve pointers to the edges that comprise this loop.
- Remarks
- loopType is one of the following:
Value Description. kDefault 0 Not yet specified. kExternal 1 Defined by external entities. kPolyline 2 Defined by OdGe polyline. kDerived 4 Derived from a picked point. kTextbox 8 Defined by text. kOutermost 0x10 Outermost loop. kNotClosed 0x20 Open loop. kSelfIntersecting 0x40 Self-intersecting loop. kTextIsland 0x80 Text loop surrounded by an even number of loops. kDuplicate 0x100 Duplicate loop.
The hatch will take ownership of the curves passed in.
◆ isGradient()
|
virtual |
Returns true if and only if this Hatch entity is a color gradient.
◆ isHatch()
|
virtual |
Returns true if and only if this Hatch entity is of type kHatchObject.
◆ isPlanar()
|
inlinevirtual |
Returns true if and only if this entity is planar.
Reimplemented from OdDbEntity.
◆ isSolidFill()
| bool OdDbHatch::isSolidFill | ( | ) | const |
Returns true if and only if this hatch is solid fill (DXF 70).
◆ loopTypeAt()
| OdInt32 OdDbHatch::loopTypeAt | ( | int | loopIndex | ) | const |
Returns the type of loop at the specified index (DXF 92).
- Parameters
-
loopIndex [in] Loop index.
- Remarks
- The loop type consists of a combination of bits from the HatchLoopType enumeration.
◆ makeClosedLoop()
|
static |
Creates an ordered closed loop.
- Parameters
-
edgePtrs [out] array of curves contains closed loop curves dbObjIds [in] array of object id from what made edgePtrs gapTolerance [in] bridge the gap that less than a value specified by this tolerance isEdgeArrayConsistent [in] is objects id in dbObjIds placed sequentially around the loop
- Returns
- eOk if edgePtrs contains closed loop curves
- Remarks
- If dbObjIds placed sequentially (and isEdgeArrayConsistent set 'true') result will be correct(if the result is not correct, decrease or increase gapTolerance). Otherwise a loop may be cut and formed incorrectly.
◆ markModifiedLoop() [1/2]
| OdResult OdDbHatch::markModifiedLoop | ( | const OdDbHandle | entityHandle | ) |
Mark loop that need recalculate. (If associated entity was changed)
- Parameters
-
entityHandle [in] handle of associated entity.
- Returns
- eOk if related loop was find
- Remarks
- Hatch loops are recalculated in endTransaction if associated Entity was changed and Hatch protocol extension not implemented. Use makeClosedLoop to mark loop and recalculate by OdDbHatch::updateMarkedLoops() if OdDbHatchWatcherPE(or derived) classes implemented.
◆ markModifiedLoop() [2/2]
Mark loop that need recalculate. (If associated entity was changed)
- Parameters
-
loopIndex [in] Loop index.
- Returns
- eOk if loop with specified index exist
- Remarks
- Hatch loops are recalculated in endTransaction if associated Entity was changed and Hatch protocol extension not implemented. Use makeClosedLoop to mark loop and recalculate by OdDbHatch::updateMarkedLoops() if OdDbHatchWatcherPE(or derived) classes implemented.
◆ modifiedGraphics()
|
virtual |
Notification function called whenever an object derived from OdDbEntity is modified.
- Parameters
-
pObject [in] Pointer to the modified object.
- Remarks
- The default implementation of this function does nothing. This function can be overridden in custom classes.
This function is called whenever the following has occurred.
1) The calling object is opened OdDb::kForWrite.
2) One of its member functions either
a Calls its assertWriteEnabled with recordModified == true. b Calls its recordGraphicsModified(true).
3) The calling object is being closed.
This function is called whenever the object as been modified. It therefore indicates only that the graphics for it may have changed.
Reimplemented from OdDbObject.
◆ normal()
| OdGeVector3d OdDbHatch::normal | ( | ) | const |
Returns the WCS normal to the plane of this entity (DXF 210).
◆ numHatchLines()
| int OdDbHatch::numHatchLines | ( | ) | const |
Returns the number of hatch lines in this Hatch entity.
- Remarks
- Returns zero if the hatch pattern is SOLID.
◆ numLoops()
| int OdDbHatch::numLoops | ( | ) | const |
Returns the number of loops in this hatch (DXF 91).
◆ numPatternDefinitions()
| int OdDbHatch::numPatternDefinitions | ( | ) | const |
Returns the number of pattern definition lines for this Hatch entity (DXF 78).
◆ numSeedPoints()
| int OdDbHatch::numSeedPoints | ( | ) | const |
Returns the number of seed points for this Hatch entity (DXF 98).
◆ openedForModify()
|
virtual |
Notification function called whenever an object is opened for modify OdDb::kForWrite.
- Parameters
-
pObject [in] Pointer to the object that is being opened.
Reimplemented from OdDbObject.
◆ originPoint()
| OdGePoint2d OdDbHatch::originPoint | ( | ) | const |
Returns the origin point of the current Hatch object as OdGePoint2d object.
◆ patternAngle()
| double OdDbHatch::patternAngle | ( | ) | const |
Returns the pattern angle for this Hatch entity (DXF 52).
- Remarks
- All angles are expressed in radians.
◆ patternDouble()
| bool OdDbHatch::patternDouble | ( | ) | const |
Returns the pattern double flag for this Hatch entity (DXF 77).
- Remarks
- Setting the pattern double flag causes a second set of lines, at 90° to the first, for kUserDefined hatch.
◆ patternName()
| OdString OdDbHatch::patternName | ( | ) | const |
Returns the name of the pattern for this Hatch entity (DXF 2).
◆ patternScale()
| double OdDbHatch::patternScale | ( | ) | const |
Returns the pattern scale for this Hatch entity (DXF 41).
◆ patternSpace()
| double OdDbHatch::patternSpace | ( | ) | const |
Returns the pattern spacing for this Hatch entity (DXF 41).
- Remarks
- Pattern spacing is the distance between parallel lines for kUserDefined hatch.
◆ patternType()
| OdDbHatch::HatchPatternType OdDbHatch::patternType | ( | ) | const |
Returns the hatch pattern type for this Hatch entity (DXF 76).
- Remarks
patternType() returns one of the following:
Value kUserDefined 0 kPreDefined 1 kCustomDefined 2
◆ pixelSize()
| double OdDbHatch::pixelSize | ( | ) | const |
Returns the pixel size for intersection and ray casting.
◆ regeneratePattern()
Clear cache and recalculate pattern.
- Remarks
- Use it, if Hatch is not solid and pattern was set or changed
- Parameters
-
forceReload [in] Recalculate already calculated pattern if true.
◆ removeAssocObjIds()
| void OdDbHatch::removeAssocObjIds | ( | ) |
Removes all Object IDs that are associated with this Hatch entity.
◆ removeLoopAt()
| void OdDbHatch::removeLoopAt | ( | int | loopIndex | ) |
Removes the specified loop from this Hatch entity.
- Parameters
-
loopIndex [in] Loop index.
◆ removeSeedPointAt()
| void OdDbHatch::removeSeedPointAt | ( | int | seedPointIndex | ) |
Remove a specified seed point from this Hatch entity.
- Parameters
-
seedIndex [in] Seed point index.
◆ setAssociative()
| void OdDbHatch::setAssociative | ( | bool | isAssociative | ) |
Controls the associative flag for this hatch (DXF 71).
- Parameters
-
isAssociative [in] Controls the associative flag.
- Remarks
- Associative hatch is automatically recalculated when its boundaries are modified.
◆ setAssocObjIdsAt()
| void OdDbHatch::setAssocObjIdsAt | ( | int | loopIndex, |
| const OdDbObjectIdArray & | dbObjIds | ||
| ) |
Sets the Object IDs comprising the specified associative loop in this Hatch entity.
- Parameters
-
loopIndex [in] Loop index. dbObjIds [in] The set of boundary Object ID's that make up the specified loop.
- Remarks
- Adds the Object ID of this hatch to the reactors of the boundary objects.
◆ setBackgroundColor()
◆ setElevation()
| void OdDbHatch::setElevation | ( | double | elevation | ) |
Sets the elevation of this entity in the OCS (DXF 30).
- Parameters
-
elevation [in] Elevation.
- Remarks
- The elevation is the distance from the WCS origin to the plane of this entity.
◆ setGradient()
| void OdDbHatch::setGradient | ( | OdDbHatch::GradientPatternType | gradientType, |
| const OdString & | gradientName | ||
| ) |
Sets the gradient type and name for this Hatch entity.
- Parameters
-
gradientType [in] Gradient type. gradientName [in] Gradient name: SPHERICAL, HEMISPHERICAL, CURVED, LINEAR, CYLINDER, INVSPHERICAL, INVHEMISPHERICAL, INVCURVED, INVLINEAR, or INVCYLINDER.
- Remarks
- gradientType is one of the following:
Value kPreDefinedGradient 0 kUserDefinedGradient 1
◆ setGradientAngle()
| void OdDbHatch::setGradientAngle | ( | double | angle | ) |
Returns the angle of the gradient for this Hatch entity.
- Parameters
-
angle [in] Gradient angle.
- Remarks
- All angles are expressed in radians.
◆ setGradientColors()
| void OdDbHatch::setGradientColors | ( | OdUInt32 | count, |
| const OdCmColor * | colors, | ||
| const double * | values | ||
| ) |
Returns the colors and interpolation values describing the gradient fill for this Hatch entity.
- Parameters
-
colors [in] Array of colors defining the gradient. values [in] Array of interpolation values for the gradient.
- Remarks
- count must be two for the current implementation.
Throws:
Cause eInvalidInput count < 2 || values[0] != 0. || values[count-1] != 1. eNotImplementedYet count > 2
◆ setGradientOneColorMode()
| void OdDbHatch::setGradientOneColorMode | ( | bool | oneColorMode | ) |
Controls the oneColorMode for this Hatch entity.
- Parameters
-
oneColorMode [in] Controls the oneColorMode.
◆ setGradientShift()
| void OdDbHatch::setGradientShift | ( | double | gradientShift | ) |
Sets the interpolation value between the default and shifted values of the gradient's definition.
- Parameters
-
gradientShift [in] Shift value.
- Remarks
- A gradientShift of 0 indicates a fully unshifted gradient. A gradientShift of 1 indicates a fully shifted gradient.
◆ setHatchObjectType()
| void OdDbHatch::setHatchObjectType | ( | OdDbHatch::HatchObjectType | hatchObjectType | ) |
Sets the hatch object type of this Hatch entity.
- Parameters
-
hatchObjectType [in] Hatch object type.
- Remarks
- hatchObjectType is one of the following:
Value Description kHatchObject 0 Classic hatch kGradientObject 1 Color gradient
◆ setHatchStyle()
| void OdDbHatch::setHatchStyle | ( | OdDbHatch::HatchStyle | hatchStyle | ) |
Sets the hatch style of this Hatch entity (DXF 75).
- Parameters
-
hatchStyle [in] Hatch style.
- Remarks
- hatchStyle is one of the following:
Value kNormal 0 kOuter 1 kIgnore 2
◆ setNormal()
| void OdDbHatch::setNormal | ( | const OdGeVector3d & | normal | ) |
Sets the WCS normal to the plane of this entity (DXF 210).
- Parameters
-
normal [in] Normal.
◆ setOriginPoint()
| void OdDbHatch::setOriginPoint | ( | const OdGePoint2d & | pt | ) |
Sets the origin point to the current Hatch object.
- Parameters
-
pt [in] Origin point.
◆ setPattern() [1/2]
| void OdDbHatch::setPattern | ( | OdDbHatch::HatchPatternType | patType, |
| const OdString & | patName | ||
| ) |
Sets the pattern data for this Hatch entity.
- Parameters
-
patType [in] Pattern type. patName [in] Pattern name.
- Remarks
- patType must be one of the following:
Value kUserDefined 0 kPreDefined 1 kCustomDefined 2
patName is ignored for patType == kUserDefined; appearance is defined by setPatternAngle(), setPatternSpace() and setPatternDouble().
◆ setPattern() [2/2]
| void OdDbHatch::setPattern | ( | OdDbHatch::HatchPatternType | patType, |
| const OdString & | patName, | ||
| double | angle, | ||
| double | scale, | ||
| const OdHatchPattern & | pat, | ||
| OdGePoint2d | originPoint = OdGePoint2d() |
||
| ) |
Sets the pattern data for this Hatch entity.
- Parameters
-
patType [in] Pattern type. patName [in] Pattern name. angle [in] Pattern angle. scale [in] Pattern scale. pat [in] Pattern definition (as in PAT file) originPoint [in] Origin point.
- Remarks
- patType must be one of the following:
Value kUserDefined 0 kPreDefined 1 kCustomDefined 2
patName is ignored for patType == kUserDefined; appearance is defined by setPatternAngle(), setPatternSpace() and setPatternDouble().
◆ setPatternAngle()
| void OdDbHatch::setPatternAngle | ( | double | angle | ) |
Sets the pattern angle for this Hatch entity (DXF 52).
- Remarks
- All angles are expressed in radians.
◆ setPatternDouble()
| void OdDbHatch::setPatternDouble | ( | bool | isDouble | ) |
Sets the pattern double flag for this Hatch entity (DXF 77).
- Parameters
-
isDouble [in] Sets the pattern double flag if true, clears it otherwise.
- Remarks
- Setting the pattern double flag causes a second set of lines, at 90° to the first, for kUserDefined hatch.
◆ setPatternScale()
| void OdDbHatch::setPatternScale | ( | double | scale | ) |
Sets the pattern scale for this Hatch entity (DXF 41).
- Parameters
-
scale [in] Pattern scale.
◆ setPatternSpace()
| void OdDbHatch::setPatternSpace | ( | double | space | ) |
Sets the pattern spacing for this Hatch entity (DXF 41).
- Parameters
-
space [in] Pattern spacing.
- Remarks
- Pattern spacing is the distance between parallel lines for kUserDefined hatch.
◆ setPixelSize()
| void OdDbHatch::setPixelSize | ( | double | pixelSize | ) |
Sets the pixel size for intersection and ray casting.
- Parameters
-
pixelSize [in] Pixel size.
◆ setRawPattern()
| void OdDbHatch::setRawPattern | ( | OdDbHatch::HatchPatternType | patType, |
| const OdString & | patName, | ||
| double | angle, | ||
| double | scale, | ||
| const OdHatchPattern & | pat | ||
| ) |
Sets the pattern data for this Hatch entity directly, bypassing OdHatchPatternManager (DXF 76 and DXF 2).
- Parameters
-
patType [in] Pattern type. patName [in] Pattern name. angle [in] Pattern angle. scale [in] Pattern scale. pat [in] Pattern definition (already scaled and rotated)
- Remarks
- patType must be one of the following:
Value kUserDefined 0 kPreDefined 1 kCustomDefined 2
patName is ignored for patType == kUserDefined; appearance is defined by setPatternAngle(), setPatternSpace() and setPatternDouble().
- Remarks
- angle and scale are not applied to the pattern.
◆ setSeedPointAt()
| void OdDbHatch::setSeedPointAt | ( | unsigned | seedIndex, |
| const OdGePoint2d & | point | ||
| ) |
Sets the specified seed point for this Hatch entity (DXF 10).
- Parameters
-
seedIndex [in] Seed point index. point [in] Seed point.
◆ setShadeTintValue()
| void OdDbHatch::setShadeTintValue | ( | double | luminance | ) |
Sets the luminance value for this Hatch entity.
- Parameters
-
luminance [in] Luminace value. [0.0 .. 1.0]
If the gradient is using oneColorMode, this function sets the luminance value applied to the first color.
◆ setShadeTintValueAndColor2()
| OdResult OdDbHatch::setShadeTintValueAndColor2 | ( | double | value | ) |
Calculate second hatch gradient color from first color with applied luminance value.
- Parameters
-
value [in] Luminance value in the range from 0.0 to 1.0.
- Returns
- eOk if successful. eInvalidContext if single color mode is false or gradient colors list is empty or hatch object type not kGradientObject. eInvalidInput if the luminance value is out of range.
◆ subClose()
|
virtual |
Called as the first operation as this object is being closed, for database -resident objects only.
- Remarks
- This function is notified just before the current open operation is to be closed, giving this function the ability to perform necessary operatons.
When overriding this function:
1) If the OdDbObject's state is incorrect, throw exception.
2) Call parent class's subClose().
3) If other actions are required before close, do them.
The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
◆ subExplode()
|
virtual |
Reimplemented from OdDbEntity.
◆ subGetClassID()
Reimplemented from OdDbEntity.
◆ subGetGsMarkersAtSubentPath()
|
virtual |
Reimplemented from OdDbEntity.
◆ subGetSubentPathsAtGsMarker()
|
virtual |
Reimplemented from OdDbEntity.
◆ subGetTransformedCopy()
|
virtual |
Reimplemented from OdDbEntity.
◆ subSetDatabaseDefaults()
|
virtual |
Called by setDatabaseDefaults() after the values are set.
- Parameters
-
pDb [in] Pointer to the database whose default values are to be used. doSubents [in] Set to true if subentities should be processed
- Remarks
- If pDb is null, the database containing this entity is used.
This function allows custom classes to inspect and modify the values set by setDatabaseDefaults.
The default implementation of this function returns eNotApplicable. This function can be overridden in custom classes.
- Remarks
- This function is not intended to be called by the user.
Reimplemented from OdDbEntity.
◆ subSubentPtr()
|
virtual |
Reimplemented from OdDbEntity.
◆ subTransformBy()
|
virtual |
Reimplemented from OdDbEntity.
◆ subViewportDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ subWorldDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ unmarkModifiedLoop() [1/2]
| OdResult OdDbHatch::unmarkModifiedLoop | ( | const OdDbHandle | entityHandle | ) |
Remove record about loop from recalculate loop list.
- Parameters
-
entityHandle [in] handle of associated entity.
- Returns
- eOk if related loop was find and erased from recalculate loop list
- Remarks
- Used in group with markModifiedLoop, updateMarkedLoops.
◆ unmarkModifiedLoop() [2/2]
Remove record about loop from recalculate loop list.
- Parameters
-
loopIndex [in] Loop index.
- Returns
- eOk if loop was erased from recalculate loop list
- Remarks
- Used in group with markModifiedLoop, updateMarkedLoops.
◆ updateMarkedLoops()
| OdResult OdDbHatch::updateMarkedLoops | ( | ) |
Update geometry of the loops previously marked as modified, using associated entities geometry.
- Returns
- eOk if recalculation is success. eInvalidInput if recalculation is unsuccessful. eEmptySet if recalculate loop list is empty (use OdDbHatch::markModifiedLoop to fill this list)
- Remarks
- To mark loops use OdDbHatch::markModifiedLoop.
The documentation for this class was generated from the following file: