#include <DbText.h>
Public Member Functions inherited from Detailed Description
<group OdDb_Classes>
This class represents single-line text entities in an OdDbDatabase instance.
Corresponding C++ library: TD_Db
- See also
- <link db_text_single.html, Working with Single-Line Text>
Constructor & Destructor Documentation
◆ OdDbText()
| OdDbText::OdDbText | ( | ) |
Member Function Documentation
◆ adjustAlignment()
|
virtual |
Adjusts the position of this Text entity if its alignent is not left baseline.
- Parameters
-
pDb [in] Pointer to database used to resolve the text style of this Text entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- This function is called by Teigha when a Text entity is closed.
If this Text entity is database resident, pDb is ignored.
If this Text entity is not database resident, pDb cannot be NULL.
◆ alignmentPoint()
| OdGePoint3d OdDbText::alignmentPoint | ( | ) | const |
Returns the alignment point of this Text entity (WCS equivalent of DXF 11).
◆ convertFieldToText()
| void OdDbText::convertFieldToText | ( | ) |
Converts the fields in this Text entity to text, and removes the fields.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- The fields are not evaluated before conversion.
◆ correctSpelling()
| int OdDbText::correctSpelling | ( | ) |
Evokes the spell checker on this Text entity.
- Returns
- Returns 0 is successful, or 1 if not.
◆ 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.
Reimplemented in OdDbAttributeDefinition, and OdDbAttribute.
◆ 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.
Reimplemented in OdDbAttributeDefinition, and OdDbAttribute.
◆ 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.
Reimplemented in OdDbAttributeDefinition, and OdDbAttribute.
◆ dxfInFields_R12()
|
virtual |
Reads the DXF R12 format data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are to be 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 dxfInFields_R12(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfOutFields_R12(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.
Reimplemented in OdDbAttributeDefinition, and OdDbAttribute.
◆ 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.
Reimplemented in OdDbAttributeDefinition, and OdDbAttribute.
◆ dxfOutFields_R12()
|
virtual |
Writes the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are to be written.
- Returns
- Returns the filer status.
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.
Reimplemented from OdDbEntity.
Reimplemented in OdDbAttributeDefinition, and OdDbAttribute.
◆ getBoundingPoints()
| void OdDbText::getBoundingPoints | ( | OdGePoint3dArray & | boundingPoints | ) | const |
Returns the WCS bounding points of this Text entity.
- 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
◆ getPlane()
|
virtual |
Returns the plane that contains this entity.
- Parameters
-
plane [out] Receives the plane that contains this entity. planarity [out] Receives the planarity of this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
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
Reimplemented from OdDbEntity.
◆ height()
| double OdDbText::height | ( | ) | const |
Returns the height of this Text entity (DXF 40).
◆ horizontalMode()
| OdDb::TextHorzMode OdDbText::horizontalMode | ( | ) | const |
Returns the horizontal mode of this Text entity (DXF 72).
- Remarks
- horizontalMode returns one of the following:
Value OdDb::kTextLeft 0 OdDb::kTextCenter 1 OdDb::kTextRight 2 OdDb::kTextAlign 3 OdDb::kTextMid 4
OdDb::kTextFit 5
◆ isDefaultAlignment()
| bool OdDbText::isDefaultAlignment | ( | ) | const |
Return true if and only if this Text entity is in the default alignment.
- Remarks
- The default alignment is when horizontal mode is OdDb::kTextLeft and vertical mode is OdDb::kTextBase, or when horizontal mode is OdDb::kTextMiddle
◆ isMirroredInX()
| bool OdDbText::isMirroredInX | ( | ) | const |
Returns true if and only if this Text entity is mirrored in the X (horizontal) direction (DXF 71, bit 0x02).
◆ isMirroredInY()
| bool OdDbText::isMirroredInY | ( | ) | const |
Returns true if and only if this Text entity is mirrored in the Y (vertical) direction (DXF 71, bit 0x04).
◆ isPlanar()
|
inlinevirtual |
◆ mirrorInX()
| void OdDbText::mirrorInX | ( | bool | mirror | ) |
Controls the mirroring of this Text entity in the X (horizontal) direction (DXF 71, bit 0x02).
- Parameters
-
mirror [in] Controls mirroring.
◆ mirrorInY()
| void OdDbText::mirrorInY | ( | bool | mirror | ) |
Controls the mirroring of this Text entity in the Y (vertical) direction (DXF 71, bit 0x04).
- Parameters
-
mirror [in] Controls mirroring.
◆ normal()
| OdGeVector3d OdDbText::normal | ( | ) | const |
Returns the WCS normal to the plane of this entity (DXF 210).
◆ oblique()
| double OdDbText::oblique | ( | ) | const |
Returns the oblique angle of this Text entity (DXF 51).
- Remarks
- The range of oblique is ±1.48335 radians (±85°).
Oblique angles are measured clockwise from the vertical.
- Remarks
- All angles are expressed in radians.
◆ ODDB_DECLARE_MEMBERS()
| OdDbText::ODDB_DECLARE_MEMBERS | ( | OdDbText | ) |
◆ position()
| OdGePoint3d OdDbText::position | ( | ) | const |
Returns the position of this entity (WCS equivalent of DXF 10).
◆ removeField() [1/2]
|
virtual |
Removes the specified field from the field dictionary of this object.
- Parameters
-
fieldName [in] Name (key) for the entry.
- Remarks
- Returns the Object ID of the removed field if successful, or a null Object ID if not.
Reimplemented from OdDbObject.
◆ removeField() [2/2]
|
virtual |
Removes the specified field from the field dictionary of this object.
- Parameters
-
fieldId [in] Object ID for the field.
- Remarks
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented from OdDbObject.
◆ rotation()
| double OdDbText::rotation | ( | ) | const |
Returns the rotation angle of this Text entity (DXF 50).
- Remarks
- All angles are expressed in radians.
◆ setAlignmentPoint()
| void OdDbText::setAlignmentPoint | ( | const OdGePoint3d & | alignment | ) |
Sets the alignment point of this Text entity (WCS equivalent of DXF 11).
- Parameters
-
alignment [in] Alignment point.
◆ setField()
|
virtual |
Adds the specified field to the field dictionary of this object.
- Parameters
-
fieldName [in] Name (key) for the new entry. pField [in] Pointer to the field object.
- Returns
- Returns the Object ID of the new entry.
Reimplemented from OdDbObject.
◆ setHeight()
| void OdDbText::setHeight | ( | double | height | ) |
Sets the height of this Text entity (DXF 40).
- Parameters
-
height [in] Text height.
◆ setHorizontalMode()
| void OdDbText::setHorizontalMode | ( | OdDb::TextHorzMode | horizontalMode | ) |
Returns the horizontal mode of this Text entity (DXF 72).
- Parameters
-
horizontalMode [in] Horizontal mode.
- Remarks
- horizontalMode returns one of the following:
Value OdDb::kTextLeft 0 OdDb::kTextCenter 1 OdDb::kTextRight 2 OdDb::kTextAlign 3 OdDb::kTextMid 4
OdDb::kTextFit 5
◆ setNormal()
| void OdDbText::setNormal | ( | const OdGeVector3d & | normal | ) |
Sets the WCS normal to the plane of this entity (DXF 210).
- Parameters
-
normal [in] Normal.
◆ setOblique()
| void OdDbText::setOblique | ( | double | oblique | ) |
Sets the oblique angle of this Text entity (DXF 51).
- Parameters
-
oblique [in] Oblique angle.
- Remarks
- The range of oblique is ±1.48335 radians (±85°).
Oblique angles are measured clockwise from the vertical.
- Remarks
- All angles are expressed in radians.
◆ setPosition()
| void OdDbText::setPosition | ( | const OdGePoint3d & | position | ) |
Sets the position of this entity (WCS equivalent of DXF 10).
- Parameters
-
position [in] Position.
◆ setRotation()
| void OdDbText::setRotation | ( | double | rotation | ) |
Sets the rotation angle of this Text entity (DXF 50).
- Parameters
-
rotation [in] Rotation angle.
- Remarks
- All angles are expressed in radians.
◆ setTextString()
Sets the text string of this Text entity (DXF 1).
- Parameters
-
textString [in] Text string.
- Remarks
- textString cannot exceed 256 characters excluding the null terminator.
◆ setTextStyle()
| void OdDbText::setTextStyle | ( | OdDbObjectId | textStyleId | ) |
Sets the Object ID of the text style of this Text entity (DXF 7).
- Parameters
-
textStyleId [in] Text style Object ID.
◆ setThickness()
| void OdDbText::setThickness | ( | double | thickness | ) |
Sets the thickness of this entity (DXF 39).
- Parameters
-
thickness [in] Thickness.
- Remarks
- Thickness is the extrusion length along the normal.
◆ setVerticalMode()
| void OdDbText::setVerticalMode | ( | OdDb::TextVertMode | verticalMode | ) |
Sets the vertical mode of this Text entity (DXF 73).
- Parameters
-
verticalMode [in] Vertical mode.
- Remarks
- verticalMode must be one of the following:
Value OdDb::kTextBase 0 OdDb::kTextBottom 1 OdDb::kTextVertMid 2 OdDb::kTextTop 3
◆ setWidthFactor()
| void OdDbText::setWidthFactor | ( | double | widthFactor | ) |
Sets the width factor of this Text entity (DXF 40).
- Parameters
-
widthFactor [in] Width factor.
◆ 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.
Reimplemented in OdDbAttributeDefinition, and OdDbAttribute.
◆ subGetTransformedCopy()
|
virtual |
Reimplemented from OdDbEntity.
◆ subSetDatabaseDefaults()
|
virtual |
This function is an override for OdDbEntity::subSetDatabaseDefaults() to set the text style of this entity to the current style and text size for the specified database.
Reimplemented from OdDbEntity.
◆ subTransformBy()
|
virtual |
Reimplemented from OdDbEntity.
◆ subViewportDraw()
|
virtual |
Reimplemented from OdDbEntity.
Reimplemented in OdDbAttributeDefinition, and OdDbAttribute.
◆ subWorldDraw()
|
virtual |
Reimplemented from OdDbEntity.
Reimplemented in OdDbAttributeDefinition, and OdDbAttribute.
◆ textString()
| OdString OdDbText::textString | ( | ) | const |
Returns the text string of this Text entity (DXF 1).
◆ textStyle()
| OdDbObjectId OdDbText::textStyle | ( | ) | const |
Returns the Object ID of the text style of this Text entity (DXF 7).
◆ thickness()
| double OdDbText::thickness | ( | ) | const |
Returns the thickness of this entity (DXF 39).
- Remarks
- Thickness is the extrusion length along the normal.
◆ verticalMode()
| OdDb::TextVertMode OdDbText::verticalMode | ( | ) | const |
Returns the vertical mode of this Text entity (DXF 73).
- Remarks
- verticalMode() returns one of the following:
Value OdDb::kTextBase 0 OdDb::kTextBottom 1 OdDb::kTextVertMid 2 OdDb::kTextTop 3
◆ widthFactor()
| double OdDbText::widthFactor | ( | ) | const |
Returns the width factor of this Text entity (DXF 41).
The documentation for this class was generated from the following file: