#include <DbScale.h>
Static Public Member Functions | |
| static bool | nameExists (const OdString &, OdString *, OdDbDatabase *) |
 Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
Detailed Description
<group OdDb_Classes>
This class implements the scale object that stores information about an annotation scale as an element of the database container. The database stores the scale instances in the dictionary and associates the object ID with an each scale instance. The scale dictionary is accessed from the database object using the getScaleListDictionaryId() method. The root drawing dictionary, associates the "ACAD_SCALELIST" name with the scale dictionary.
- Remarks
- This class is intended for stand-alone applications only. TXSDK developers cannot use it.
- See also
- TD_Db
- <link db_scale_sample_object.html, Example of Working with the Scale Object>
<link db_scale_sample_dictionary.html, Example of Working with the Scale Dictionary Object>
- See also
- <link db_scale.html, Working with Scales>
OdDbAnnotationScale class
Constructor & Destructor Documentation
◆ OdDbScale()
| OdDbScale::OdDbScale | ( | ) |
Builds an instance of the scale object.
- Remarks
- Use the static pseudo-constructor instead it. See: <link db_scale_manipulate.html, Manipulating Objects of the Scale Dictionary>
Member Function Documentation
◆ 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().
Throws:
Cause eInvalidOwnerObject !pOwnerObject->get()
Reimplemented from OdDbObject.
◆ applyPartialUndo()
|
virtual |
Notification function called each time an Undo operation is performed this object is using partial Undo.
- Parameters
-
pUndoFiler [in] A pointer to the undo filer with the partial undo information. pClassObj [in] A pointer to the OdRxClass object for the class that will handle the Undo.
- Remarks
- An object indicates it's using the partial undo mechanism, if and only if it has set autoUndo false in all calls to assertWriteEnabled().
This member function must know which types of fields to scan, and must stop after reading what it it needs.
If the class type specified by pClassObj does not matches the class of this object, this member function must call the parent class's applyPartialUndo() and return whatever it returns.
If it does match the class of this object, this member function must use pUndoFiler to read the undo data, then typically use this object's set() method.
Throws:
Cause eNotThatKindOfClass pClassObj != OdDbObject::desc()
Reimplemented from OdDbObject.
◆ drawingUnits()
| double OdDbScale::drawingUnits | ( | ) | const |
Returns the number of drawing units as a positive Double value.
- See also
- <link db_scale_sample_object.html, Example of Working with the Scale Object>
- <link db_scale.html, Working with Scales>
OdDbScale::setDrawingUnits(), OdDbScale::paperUnits(), OdDbScale::scale() methods
◆ 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 OdDbObject.
◆ 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 OdDbObject.
◆ 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 OdDbObject.
◆ 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 OdDbObject.
◆ getXRefMangledName()
| void OdDbScale::getXRefMangledName | ( | OdString | , |
| OdString & | , | ||
| OdDbDatabase * | |||
| ) |
DOM
For internal use only.
◆ isTemporaryScale()
| bool OdDbScale::isTemporaryScale | ( | ) | const |
Determines whether the scale object is temporary stored in the database and returns True if the
scale is temporary or False if the scale is fixed.
- Remarks
- The temporary scale typically exists because attached XREF objects in the drawing have dependencies on scales that are not directly referenced by other objects in the drawing.
- See also
- <link db_scale_sample_object.html, Example of Working with the Scale Object>
- <link db_scale.html, Working with Scales>
◆ isUnitScale()
| bool OdDbScale::isUnitScale | ( | ) | const |
Determines whether the scale object is selected as one-to-one (1:1) by default and returns True if the scale is selected (1:1) by default or False if the scale is not the default.
- See also
- <link db_scale_sample_object.html, Example of Working with the Scale Object>
- <link db_scale.html, Working with Scales>
OdDbScale::setIsUnitScale() method
◆ nameExists()
|
static |
DOM
For internal use only.
◆ ODDB_DECLARE_MEMBERS()
| OdDbScale::ODDB_DECLARE_MEMBERS | ( | OdDbScale | ) |
◆ paperUnits()
| double OdDbScale::paperUnits | ( | ) | const |
Returns the number of paper units as a positive Double value.
- See also
- <link db_scale_sample_object.html, Example of Working with the Scale Object>
- <link db_scale.html, Working with Scales>
OdDbScale::setPaperUnits(), OdDbScale::drawingUnits(), OdDbScale::scale() methods
◆ scale()
| double OdDbScale::scale | ( | ) | const |
Returns the scale factor as a positive Double value. This factor defines the ratio in which units of model space correlate to the units of paper space and indicates how many paper units fit to one drawing unit.
- See also
- <link db_scale_sample_object.html, Example of Working with the Scale Object>
- <link db_scale.html, Working with Scales>
◆ scaleName()
| class OdString OdDbScale::scaleName | ( | ) | const |
Returns the internal scale name as a String value. This name is used as a comment for the ratio of paper units to drawing units when the scale object is displayed in a list.
- See also
- <link db_scale_sample_object.html, Example of Working with the Scale Object>
- <link db_scale.html, Working with Scales>
OdDbScale::setScaleName() method
◆ setDrawingUnits()
| void OdDbScale::setDrawingUnits | ( | double | vUnits | ) |
Sets the number of drawing units as a positive Double value. The initial value is 1.0 by default.
- Parameters
-
vUnits [in] value of drawing units.
- See also
- <link db_scale_sample_object.html, Example of Working with the Scale Object>
- <link db_scale.html, Working with Scales>
OdDbScale::drawingUnits(), OdDbScale::setPaperUnits(), OdDbScale::scale() methods
◆ setIsTemporaryScale()
| void OdDbScale::setIsTemporaryScale | ( | bool | bStatus | ) |
Sets the scale temporary status as a Boolean value. The initial value is False by default.
- Remarks
- The temporary scale typically exists because attached XREF objects in the drawing have
dependencies on scales that are not directly referenced by other objects in the drawing.
- Parameters
-
bStatus [in] True if the scale is temporary or False if the scale is fixed.
- See also
- <link db_scale_sample_object.html, Example of Working with the Scale Object>
- <link db_scale.html, Working with Scales>
◆ setIsUnitScale()
| void OdDbScale::setIsUnitScale | ( | bool | bStatus | ) |
Sets the scale default status as a Boolean value. The initial value is False by default.
- Parameters
-
bStatus [in] True if the scale is selected (1:1) by default or False if the scale is not the default.
- See also
- <link db_scale_sample_object.html, Example of Working with the Scale Object>
- <link db_scale.html, Working with Scales>
OdDbScale::isUnitScale() method
◆ setPaperUnits()
| void OdDbScale::setPaperUnits | ( | double | vUnits | ) |
Sets the number of paper units as a positive Double value. The initial value is 1.0 by default.
- Parameters
-
vUnits [in] value of paper units.
- See also
- <link db_scale_sample_object.html, Example of Working with the Scale Object>
- <link db_scale.html, Working with Scales>
OdDbScale::paperUnits(), OdDbScale::setDrawingUnits(), OdDbScale::scale() methods
◆ setScaleName()
Sets the internal scale name as a String value. This name is used as a comment for the ratio of paper units to drawing units when the scale object is displayed in a list. The initial value is an empty string by default.
- Parameters
-
sName [in] Scale name as non-empty string.
- See also
- <link db_scale_sample_object.html, Example of Working with the Scale Object>
- <link db_scale.html, Working with Scales>
OdDbScale::scaleName() method
◆ subErase()
|
virtual |
Called as the first operation as this object is being erased or unerased.
- Parameters
-
erasing [in] A copy of the erasing argument passed to erase().
- Remarks
- This function is notified just before the current object is to be erased, giving this function the ability to cancel the erase.
Returns eOk if and only if erase() is to continue.
When overriding this function:
1) If the OdDbObject's state is incorrect, return something other than eOk.
2) If the parent class's subErase() returns anything other than eOk, immediately return it.
3) If other actions are required before erase, do them.
4) Return eOk.
If you must make changes to this object's state, either make them after step 2, or roll them back if step 2 returns other than eOk.
The default implementation of this function does nothing but return eOk. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
The documentation for this class was generated from the following file: