#include <DbObjectReactor.h>

Inheritance diagram for OdDbObjectReactor:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdDbObjectReactor)

virtual void	cancelled (const OdDbObject *pObject)

virtual void	copied (const OdDbObject pObject, const OdDbObject pNewObject)

virtual void	erased (const OdDbObject *pObject, bool erasing=true)

virtual void	goodbye (const OdDbObject *pObject)

virtual void	openedForModify (const OdDbObject *pObject)

virtual void	modified (const OdDbObject *pObject)

virtual void	modifiedGraphics (const OdDbObject *pObject)

virtual void	subObjModified (const OdDbObject pObject, const OdDbObject pSubObj)

virtual void	modifyUndone (const OdDbObject *pObject)

virtual void	modifiedXData (const OdDbObject *pObject)

virtual void	unappended (const OdDbObject *pObject)

virtual void	reappended (const OdDbObject *pObject)

virtual void	objectClosed (const OdDbObjectId &objectId)

Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()

	OdRxObject ()

virtual	~OdRxObject ()

virtual OdRxObject *	queryX (const OdRxClass *pClass) const

virtual OdRxObject *	x (const OdRxClass *pClass) const

virtual OdRxClass *	isA () const

virtual void	addRef ()=0

virtual void	release ()=0

virtual long	numRefs () const

bool	isKindOf (const OdRxClass *pClass) const

virtual OdRxObjectPtr	clone () const

virtual void	copyFrom (const OdRxObject *pSource)

virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const

virtual bool	isEqualTo (const OdRxObject *pOther) const

Static Public Member Functions
static OdDbObjectReactor *	findReactor (const OdDbObject pObject, const OdRxClass pKeyClass)

Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

Protected Member Functions
	OdDbObjectReactor ()

Detailed Description

This class is the base class for custom classes that receive notification of OdDbObject events.

Remarks: The default implementations of all methods in this class do nothing but return.

Definition at line 45 of file DbObjectReactor.h.

Constructor & Destructor Documentation

◆ OdDbObjectReactor()

OdDbObjectReactor::OdDbObjectReactor ( )

inlineprotected

Definition at line 48 of file DbObjectReactor.h.

Member Function Documentation

◆ cancelled()

virtual void OdDbObjectReactor::cancelled ( const OdDbObject * pObject )

virtual

Not called.

◆ copied()

virtual void OdDbObjectReactor::copied	(	const OdDbObject *	pObject,
		const OdDbObject *	pNewObject
	)

virtual

Notification function called whenever the notifying object has had its clone() member function called.

Parameters

pObject	[in] Pointer to the notifying object.
pNewObject	[in] Pointer to the object resulting from the copy.

Remarks: The default implementation of this function does nothing. This function can be overridden in custom classes.

◆ erased()

virtual void OdDbObjectReactor::erased	(	const OdDbObject *	pObject,
		bool	erasing = `true`
	)

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.

◆ findReactor()

static OdDbObjectReactor * OdDbObjectReactor::findReactor	(	const OdDbObject *	pObject,
		const OdRxClass *	pKeyClass
	)

static

Returns the first transient reactor of the specified class that is attached to the specified object.

Parameters

pObject	[in] Pointer to the notifying object.
pKeyClass	[in] Pointer to the class desciption.

◆ goodbye()

virtual void OdDbObjectReactor::goodbye ( const OdDbObject * pObject )

virtual

Notification function called just before an object is deleted from memory.

Parameters

pObject [in] Pointer to the object that is being deleted.

Remarks: The default implementation of this function does nothing. This function can be overridden in custom classes.

◆ modified()

virtual void OdDbObjectReactor::modified ( const OdDbObject * pObject )

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.

◆ modifiedGraphics()

virtual void OdDbObjectReactor::modifiedGraphics ( const OdDbObject * pObject )

virtual

Notification function called whenever an object derived from OdDbEntity is modified.

Parameters

pObject [in] Pointer to the modified object.

Remarks: The default implementation of this function does nothing. This function can be overridden in custom classes.

This function is called whenever the following has occurred.

1) The calling object is opened OdDb::kForWrite.

2) One of its member functions either

a Calls its assertWriteEnabled with recordModified == true.

b Calls its recordGraphicsModified(true).

3) The calling object is being closed.

This function is called whenever the object as been modified. It therefore indicates only that the graphics for it may have changed.

◆ modifiedXData()

virtual void OdDbObjectReactor::modifiedXData ( const OdDbObject * pObject )

virtual

Notification function called whenever the XData has been written to the notifying object.

Parameters

pObject [in] Pointer to the notifying object.

Remarks: Notification is made upon pObject->close() or pObject->cancel().

The notifying object is open OdDb::kForRead.

The default implementation of this function does nothing. This function can be overridden in custom classes.

◆ modifyUndone()

virtual void OdDbObjectReactor::modifyUndone ( const OdDbObject * pObject )

virtual

Notification function called whenever the notifying object is in the midst an Undo operation that is undoing modifications.

Parameters

pObject [in] Pointer to the notifying object.

Remarks: The notifying object is open OdDb::kForRead.

The default implementation of this function does nothing. This function can be overridden in custom classes.

◆ objectClosed()

virtual void OdDbObjectReactor::objectClosed ( const OdDbObjectId & objectId )

virtual

Notification function called immediately before an object is closed.

Parameters

objectId [in] Object ID of the object that is being closed.

Remarks: The default implementation of this function does nothing. This function can be overridden in custom classes.

◆ ODRX_DECLARE_MEMBERS()

OdDbObjectReactor::ODRX_DECLARE_MEMBERS ( OdDbObjectReactor )

◆ openedForModify()

virtual void OdDbObjectReactor::openedForModify ( const OdDbObject * pObject )

virtual

Notification function called whenever an object is opened for modify OdDb::kForWrite.

Parameters

pObject [in] Pointer to the object that is being opened.

Remarks: The default implementation of this function does nothing. This function can be overridden in custom classes.

◆ reappended()

virtual void OdDbObjectReactor::reappended ( const OdDbObject * pObject )

virtual

Notification function called whenever a Redo process processes the reappending of the notifying object to the database.

Parameters

pObject [in] Pointer to the notifying object.

Remarks

The default implementation of this function does nothing. This function can be overridden in custom classes.

◆ subObjModified()

virtual void OdDbObjectReactor::subObjModified	(	const OdDbObject *	pObject,
		const OdDbObject *	pSubObj
	)

virtual

Notification function called whenever a method of the specified subobject has called assertWriteEnabled()

Parameters

pObject	[in] Pointer to the notifying object.
pSubObj	[in] A pointer to the subobject owned by pObject.

Remarks: Notification is made upon pObject->close() or pObject->cancel().; This function is called only for the modification of the following:

Vertices of OdDb2dPolylines, OdDb3dPolylines, OdDbPolygonMeshs, and OdDbPolyFaceMeshes OdDbFaceRecords of OdDbPolyFaceMeshs OdDbAttributes owned by OdDbBlockReferences, classes derived from OdDbBlockReference, and OdDbMInsertBlocks

◆ unappended()

virtual void OdDbObjectReactor::unappended ( const OdDbObject * pObject )

virtual

Notification function called whenever the Undo process processes the appending of the notifying object to the database.

Parameters

pObject [in] Pointer to the notifying object.

Remarks: The notifying object is marked as erased. It is not removed the database, and can be unerased, even 'before' it was created.

The default implementation of this function does nothing. This function can be overridden in custom classes.

The documentation for this class was generated from the following file:

DbObjectReactor.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ OdDbObjectReactor()

Member Function Documentation

◆ cancelled()

◆ copied()

◆ erased()

◆ findReactor()

◆ goodbye()

◆ modified()

◆ modifiedGraphics()

◆ modifiedXData()

◆ modifyUndone()

◆ objectClosed()

◆ ODRX_DECLARE_MEMBERS()

◆ openedForModify()

◆ reappended()

◆ subObjModified()

◆ unappended()