#include <DbRasterImageDef.h>
Static Public Member Functions | |
| static OdDbObjectId | createImageDictionary (OdDbDatabase *pDb) |
| static OdDbObjectId | imageDictionary (OdDbDatabase *pDb) |
| static OdString | suggestName (const OdDbDictionary *pImageDictionary, const OdString &strFilePath, int nMaxLength=kMaxSuggestNameSize) |
| static int | classVersion () |
 Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
Additional Inherited Members | |
| Protected Member Functions inherited from OdDbObject | |
| OdDbObject () | |
| virtual OdResult | subGetClassID (void *pClsid) const |
| virtual OdDbObjectPtr | subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const |
| virtual OdDbObjectPtr | subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const |
| Protected Member Functions inherited from OdGiDrawable | |
| OdGiDrawable () | |
| virtual OdUInt32 | subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const |
| virtual OdUInt32 | subRegenSupportFlags () const |
| Protected Attributes inherited from OdDbObject | |
| OdDbObjectImpl * | m_pImpl |
Detailed Description
This virtual base class defines raster image definition objects in an OdDbDatabase instance.
- See also
- TD_Db
- Remarks
- Raster image definitions (OdDbRasterImageDef objects) work with raster image (OdDbRasterImage) entities in much the same way that block table records (OdDbBlockTableRecord objects) work with block references (OdDbBlockReference entities).
<group OdDb_Classes>
Definition at line 56 of file DbRasterImageDef.h.
Member Typedef Documentation
◆ Units
Definition at line 61 of file DbRasterImageDef.h.
Member Enumeration Documentation
◆ anonymous enum
| anonymous enum |
| Enumerator | |
|---|---|
| kMaxSuggestNameSize | |
Definition at line 216 of file DbRasterImageDef.h.
Constructor & Destructor Documentation
◆ OdDbRasterImageDef()
| OdDbRasterImageDef::OdDbRasterImageDef | ( | ) |
Member Function Documentation
◆ activeFileName()
| OdString OdDbRasterImageDef::activeFileName | ( | ) | const |
Returns the actual file name of the raster image associated with this raster image definition object.
◆ classVersion()
|
static |
DOM-IGNORE-BEGIN DOM-IGNORE-END
Returns the version of the raster image associated with this raster image definition object.
◆ createImageDictionary()
|
static |
Creates an image dictionary, if it is not already present, in the specified OdDbDatabase instance.
- Parameters
-
pDb [in] Pointer to the database.
- Returns
- Returns the object ID of the image dictionary.
◆ 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.
◆ entityCount()
| int OdDbRasterImageDef::entityCount | ( | bool * | pbLocked = NULL | ) | const |
Returns the number of raster images associated with this raster image definition object.
- Parameters
-
pbLocked [in] If this value is not NULL, the value 'true' will be set at the pointer.
◆ image()
|
virtual |
Returns the OdGiRasterImage object associated with this RasterImageDef object.
◆ imageDictionary()
|
static |
Returns the object ID of the image dictionary in the specified OdDbDatabase instance.
- Parameters
-
pDb [in] Pointer to the database.
◆ isLoaded()
|
virtual |
Returns true if and only if the image file for this raster image definition object is loaded (DXF 280).
◆ load()
Loads the source image file for this raster image definition object.
- Parameters
-
modifyDatabase [in] If and only if true, an undo recording will be done for this object.
- Remarks
- This function calls searchForActivePath() to determine the active path.
If the image file is currently loaded, the file will not be read.
"Lazy loading" implies that the image file will not be loaded until it is required.
◆ ODDB_DECLARE_MEMBERS()
| OdDbRasterImageDef::ODDB_DECLARE_MEMBERS | ( | OdDbRasterImageDef | ) |
◆ resolutionMMPerPixel()
|
virtual |
Returns the default physical pixel size, in mm/pixel, of the image for this raster image definition object (DXF 10).
- Remarks
- If the image has no default pixel size, this function returns 1.0/(image width in pixels) for XY resolutions.
◆ resolutionUnits()
|
virtual |
Returns the resolution units for the image for this raster image definition object (DXF 281).
◆ setActiveFileName()
Sets the actual file name of the raster image associated with this raster image definition object.
- Parameters
-
pPathName [in] Input actual file name.
◆ setImage()
|
virtual |
Creates an image from the specified OdGiRasterImage object.
- Parameters
-
pImage [in] Pointer to the RasterImage object. modifyDatabase [in] If and only if true, marks the associated OdDbDatabase instance as modified.
- Remarks
- isLoaded() returns false if pImage is NULL. Otherwise, it returns true.
◆ setResolutionMMPerPixel()
|
virtual |
Sets the default physical pixel size, in mm/pixel, of the image for this raster image definition object (DXF 10).
- Remarks
- Loading the actual image file resets this value if the image has a default pixel size.
◆ setResolutionUnits()
|
virtual |
Sets the resolution units for the image for this raster image definition object (DXF 281).
- Remarks
- Loading the actual image file resets this value.
◆ setSourceFileName()
Sets the name of the source file containing the raster image for this raster image definition object (DXF 1).
- Parameters
-
pathName [in] Path name.
◆ size()
|
virtual |
Returns the XY pixel size of the image for this raster image definition (DXF 10).
◆ sourceFileName()
| OdString OdDbRasterImageDef::sourceFileName | ( | ) | const |
Returns the name of the source file containing the raster image for this raster image definition object (DXF 1).
- Remarks
- This function calls searchForActivePath() to determine the active path.
- This RasterImageDef object must be open for reading.
◆ 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.
◆ 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.
◆ subHandOverTo()
|
virtual |
Called as the first operation of the handOverTo function.
- Parameters
-
pNewObject [in] Pointer to the object with which to replace this object in the database.
- Remarks
- This function allows custom classes to populate the new object.
- Overriding this function in a child class allows a child instance to be notified each time an object is handed over.
This function is notified just before an object is to be handed over; giving this function the ability to cancel the handover.
When overriding this function:
1) If the OdDbObject's state is incorrect, throw exception.
2) Call parent class's subHandover().
3) If other actions are required before handover, do them.
The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
◆ suggestName()
|
static |
Modifies the original image filename to return a new image name suitable for an image dictionary.
- Parameters
-
pImageDictionary [in] Pointer to the image dictionary. strFilePath [in] New image file name. nMaxLength [in] Max length of the name returned.
◆ unload()
Unloads the image for this raster image definition object.
- Parameters
-
modifyDatabase [in] If and only if true, an undo recording will be done for this object.
- Remarks
- This RasterImageDef object must be open for writing.
◆ updateEntities()
| void OdDbRasterImageDef::updateEntities | ( | ) | const |
Causes all raster images associated with this raster image definition object to be redrawn.
- Remarks
- Associated raster images will be redrawn after any modifications to this raster image definition object (e.g., load, unload, etc.).
The documentation for this class was generated from the following file: