#include <DbFcf.h>
Public Types inherited from Detailed Description
This class represents feature control frames in an OdDbDatabase instance.
<group OdDb_Classes>
Member Enumeration Documentation
◆ whichLine
| enum OdDbFcf::whichLine |
Constructor & Destructor Documentation
◆ OdDbFcf()
| OdDbFcf::OdDbFcf | ( | ) |
Member Function Documentation
◆ 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.
◆ dimclrd()
| OdCmColor OdDbFcf::dimclrd | ( | ) | const |
Returns the DIMCLRD value of this object.
- Remarks
- DIMCLRD specifies the color of dimension lines, leader lines, frames, and arrowheads.
- The value from the dimension style of this object will be returned unless that value has been overridden, in which case, the override value will be returned.
◆ dimclrt()
| OdCmColor OdDbFcf::dimclrt | ( | ) | const |
Returns the DIMCLRT value of this object.
- Remarks
- DIMCLRT specifies the color of dimension text.
- The value from the dimension style of this object will be returned unless that value has been overridden, in which case, the override value will be returned.
◆ dimensionStyle()
|
virtual |
Returns the dimension style (OdDbDimStyleTableRecord) used by this feature control frame (DXF 3).
◆ dimgap()
| double OdDbFcf::dimgap | ( | ) | const |
Returns the DIMGAP value of this object.
- Remarks
- DIMGAP specifies the gap between dimension text and dimension lines.
A negative value for DIMGAP draws a reference box round the dimension text.
Text is placed inside a dimension line only if there will be two line segments each as long as abs(DIMGAP).
- Remarks
- The value from the dimension style of this object will be returned unless that value has been overridden, in which case, the override value will be returned.
◆ dimscale()
| double OdDbFcf::dimscale | ( | ) | const |
Returns the DIMSCALE value of this object.
- Remarks
- DIMSCALE is an scale factor applied to all dimension variables that regulate sizes, offsets, and distances.
DIMSCALE serves as an overall "volume control" for dimensions and leaders.
Description 0,0 A "reasonable" value is computed for model space viewports.
0.0 If set to the inverse of the plot scale, plotted dimensions will be at the sizes specified by the other dimension variables.
- Remarks
- The value from the dimension style of this object will be returned unless that value has been overridden, in which case, the override value will be returned.
◆ dimtxsty()
| OdDbObjectId OdDbFcf::dimtxsty | ( | ) | const |
Returns the DIMTXSTY value of this object.
- Remarks
- DIMTXSTY specifies the text style of the dimension text.
- The value from the dimension style of this object will be returned unless that value has been overridden, in which case, the override value will be returned.
◆ dimtxt()
| double OdDbFcf::dimtxt | ( | ) | const |
Returns the DIMTXT value of this object.
- Remarks
- DIMTXT specifies the size of the dimension text.
- The value from the dimension style of this object will be returned unless that value has been overridden, in which case, the override value will be returned.
◆ direction()
|
virtual |
Returns the WCS X-axis direction vector of this feature control frame (DXF 11).
◆ 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.
◆ getBoundingPline()
|
virtual |
Appends the consecutive distinct corner points of this feature control frame to the specified array.
- Parameters
-
ptArray [in/out] Receives corner points.
◆ getBoundingPoints()
|
virtual |
Returns the WCS bounding points of this feature control frame.
- Parameters
-
boundingPoints [out] Receives the bounding points.
- Remarks
- The points are returned as follows:
Corner boundingPoints[0] Top left boundingPoints[1] Top right boundingPoints[2] Bottom right boundingPoints[3] Bottom left
◆ getDimstyleData()
| void OdDbFcf::getDimstyleData | ( | OdDbDimStyleTableRecord * | pRecord | ) | const |
Copies the dimension style settings, including overrides, of this entity into the specified dimension style table record.
- Parameters
-
pRecord [out] Receives the effective dimension style data.
- Remarks
- The copied data includes the dimension style data with all applicable overrides.
◆ location()
|
virtual |
Returns the insertion point of this feature control frame (WCS equivalent of DXF 10).
- Remarks
- The insertion point is the middle of the left edge of the feature control frame.
◆ modified()
|
virtual |
Notification function called whenever an object is opened OdDb::kForWrite, a function has been called that could modify the contents of this object, and this object is now being closed.
- Parameters
-
pObject [in] Pointer to the object that is being closed after being modified.
- Remarks
- The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
◆ normal()
|
virtual |
Returns the WCS normal to the plane of this feature control frame (DXF 210).
◆ ODDB_DECLARE_MEMBERS()
| OdDbFcf::ODDB_DECLARE_MEMBERS | ( | OdDbFcf | ) |
◆ setDimclrd()
Sets the DIMCLRD override for this object.
- Parameters
-
val [in] New value for DIMCLRD.
- Remarks
- DIMCLRD specifies the color of dimension lines, leader lines, frames, and arrowheads.
◆ setDimclrt()
Sets the DIMCLRT override for this object.
- Parameters
-
val [in] New value for DIMCLRT.
- Remarks
- DIMCLRT specifies the color of dimension text.
◆ setDimensionStyle()
|
virtual |
Sets the dimension style (OdDbDimStyleTableRecord) to used by this feature control frame (DXF 3).
- Parameters
-
dimStyleId [in] Object ID of the dimension style.
◆ setDimgap()
| void OdDbFcf::setDimgap | ( | double | val | ) |
Sets the DIMGAP override for this object.
- Parameters
-
val [in] New value for DIMGAP.
- Remarks
- DIMGAP specifies the gap between dimension text and dimension lines.
A negative value for DIMGAP draws a reference box round the dimension text.
Text is placed inside a dimension line only if there will be two line segments each as long as abs(DIMGAP).
◆ setDimscale()
| void OdDbFcf::setDimscale | ( | double | val | ) |
Sets the DIMSCALE override for this object.
- Parameters
-
val [in] New value for DIMSCALE.
- Remarks
- DIMSCALE is an scale factor applied to all dimension variables that regulate sizes, offsets, and distances.
DIMSCALE serves as an overall "volume control" for dimensions and leaders.
Description 0.0 A "reasonable" value is computed for model space viewports.
0.0 If set to the inverse of the plot scale, plotted dimensions will be at the sizes specified by the other dimension variables.
◆ setDimstyleData() [1/2]
| void OdDbFcf::setDimstyleData | ( | const OdDbDimStyleTableRecord * | pDimstyle | ) |
Copies the dimension style settings, including overrides, from the specified dimension style table record to this entity.
- Parameters
-
pDimstyle [in] Pointer to non- database -resident dimension style record.
- Remarks
- The copied data includes the dimension style with all applicable overrides.
◆ setDimstyleData() [2/2]
| void OdDbFcf::setDimstyleData | ( | OdDbObjectId | dimstyleID | ) |
Copies the dimension style settings, including overrides, from the specified dimension style table record to this entity.
- Parameters
-
dimstyleID [in] Database-resident dimension style record.
- Remarks
- The copied data includes the dimension style with all applicable overrides.
◆ setDimtxsty()
| void OdDbFcf::setDimtxsty | ( | OdDbObjectId | val | ) |
Sets the DIMTXSTY override for this object.
- Parameters
-
val [in] New value for DIMTXSTY.
- Remarks
- DIMTXSTY specifies the text style of the dimension text.
◆ setDimtxt()
| void OdDbFcf::setDimtxt | ( | double | val | ) |
Sets the DIMTXT override for this object.
- Parameters
-
val [in] New value for DIMTXT.
- Remarks
- DIMTXT specifies the size of the dimension text.
◆ setLocation()
|
virtual |
Sets the insertion point of this feature control frame (WCS equivalent of DXF 10).
- Parameters
-
insPoint [in] Insertion point.
- Remarks
- The insertion point is the middle of the left edge of the feature control frame.
◆ setOrientation()
|
virtual |
Sets the orientation vectors of this feature control frame (DXF 210 and 11).
- Parameters
-
normal [in] WCS normal to plane of feature control frame. direction [in] WCS X-axis direction vector of feature control frame.
◆ setText()
Sets the text string of this feature control frame (DXF 1).
- Parameters
-
fcfText [in] Text of this feature control frame.
- Remarks
- The following escape sequences are used to specify the feature control frame:
Meaning
newline {\Fgdt;a} angularity {\Fgdt;b} perpendicularity {\Fgdt;c} flatness {\Fgdt;d} profile of a surface {\Fgdt;e} circularity {\Fgdt;f} parallelism {\Fgdt;g} cylindricity {\Fgdt;h} circular runout {\Fgdt;i} symmetry {\Fgdt;j} positional (+) {\Fgdt;k} profile of a line {\Fgdt;l} least material condition {\Fgdt;m} maximum material condition {\Fgdt;n} diameter {\Fgdt;p} positional(P) {\Fgdt;r} concentricity {\Fgdt;s} regardless of feature size {\Fgdt;t} total runout {\Fgdt;u} straightness %v vertical side of frame box
◆ 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.
◆ subGetClassID()
Reimplemented from OdDbEntity.
◆ subGetGeomExtents()
|
virtual |
Reimplemented from OdDbEntity.
◆ subSetDatabaseDefaults()
|
virtual |
This function is an override for OdDbEntity::subSetDatabaseDefaults() to set the dimension style of this entity to the current style for the specified database.
Reimplemented from OdDbEntity.
◆ subTransformBy()
|
virtual |
Reimplemented from OdDbEntity.
◆ subViewportDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ subWblockClone()
|
virtual |
Reimplemented from OdDbEntity.
◆ subWorldDraw()
|
virtual |
Reimplemented from OdDbEntity.
◆ text()
Returns the text string of this feature control frame (DXF 1).
- Parameters
-
lineNo [in] Index of the line desired.
- Remarks
- The following escape sequences are used to specify the feature control frame:
Meaning
newline {\Fgdt;a} angularity {\Fgdt;b} perpendicularity {\Fgdt;c} flatness {\Fgdt;d} profile of a surface {\Fgdt;e} circularity {\Fgdt;f} parallelism {\Fgdt;g} cylindricity {\Fgdt;h} circular runout {\Fgdt;i} symmetry {\Fgdt;j} positional (+) {\Fgdt;k} profile of a line {\Fgdt;l} least material condition {\Fgdt;m} maximum material condition {\Fgdt;n} diameter {\Fgdt;p} positional (P) {\Fgdt;r} concentricity {\Fgdt;s} regardless of feature size {\Fgdt;t} total runout {\Fgdt;u} straightness %v vertical side of frame box
- Remarks
- lineNo is not currently implemented. All lines of text will be returned, separated by
.
The documentation for this class was generated from the following file: