#include <DbRasterImageDef.h>
Static Public Member Functions | |
| static void | setEnable (bool enable) |
| 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 class implements raster image definition reactor objects in an OdDbDatabase instance.
- See also
- TD_Db
- Remarks
- Raster image definition reactor (OdDbRasterImageDefReactor) objects are used to notify raster image (OdDbRasterImage) objects of changes to their associated raster image definition (OdDbRasterImage) objects.
Modifications of image definition objects redraw their dependent raster image entities. Deletion of image definition objects delete their dependent raster image entities.
<group OdDb_Classes>
Definition at line 304 of file DbRasterImageDef.h.
Member Enumeration Documentation
◆ DeleteImageEvent
| Enumerator | |
|---|---|
| kUnload | |
| kErase | |
Definition at line 345 of file DbRasterImageDef.h.
Constructor & Destructor Documentation
◆ OdDbRasterImageDefReactor()
| OdDbRasterImageDefReactor::OdDbRasterImageDefReactor | ( | ) |
Member Function Documentation
◆ classVersion()
|
static |
Returns the version of the raster image associated with this object.
◆ 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.
◆ erased()
|
virtual |
Notification function called whenever an object has been erased or unerased.
- Parameters
-
pObject [in] Pointer to the object that was erased/unerased.
erasing [in] True if and only if this object is being erased.
- Remarks
- The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
◆ modified()
|
virtual |
Notification function called whenever an object is opened OdDb::kForWrite, a function has been called that could modify the content 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.
◆ ODDB_DECLARE_MEMBERS()
| OdDbRasterImageDefReactor::ODDB_DECLARE_MEMBERS | ( | OdDbRasterImageDefReactor | ) |
◆ onDeleteImage()
|
virtual |
Notification function called whenever an OdDbRasterImageDef object is about to be unloaded or erased.
- Parameters
-
pImageDef [in] Pointer to the OdDbRasterImageDef object sending this notification. event [in] Event triggering the notification. cancelAllowed [in] True to enable user cancellation, false to disable.
- Returns
- Returns true if and only if not cancelled.
- Remarks
- Event must be one of the following:
Value kUnload 1 kErase 2
- Remarks
- Use imageModified() to determine if the image definition has been modified.
◆ setEnable()
|
static |
Controls notifications of OdDbRasterImage object events.
- Parameters
-
enable [in] If and only if true, enables notifications.
The documentation for this class was generated from the following file: