#include <DbProxyObject.h>

Inheritance diagram for OdDbProxyObject:

Public Types
enum	{ kNoOperation = 0 , kEraseAllowed = 0x1 , kCloningAllowed = 0x80 , kAllButCloningAllowed = 0x1 , kAllAllowedBits = 0x81 , kMergeIgnore = 0 , kMergeReplace = 0x100 , kMergeMangleName = 0x200 , kDisableProxyWarning = 0x400 }

Public Types inherited from OdGiDrawable
enum	SetAttributesFlags { kDrawableNone = 0 , kDrawableIsAnEntity = 1 , kDrawableUsesNesting = 2 , kDrawableIsCompoundObject = 4 , kDrawableViewIndependentViewportDraw = 8 , kDrawableIsInvisible = 16 , kDrawableHasAttributes = 32 , kDrawableRegenTypeDependantGeometry = 64 , kDrawableIsDimension = (kDrawableIsAnEntity + kDrawableIsCompoundObject + 128) , kDrawableRegenDraw = 256 , kDrawableStandardDisplaySingleLOD = 512 , kDrawableShadedDisplaySingleLOD = 1024 , kDrawableViewDependentViewportDraw = 2048 , kDrawableBlockDependentViewportDraw = 4096 , kDrawableIsExternalReference = 8192 , kDrawableNotPlottable = 16384 , kDrawableNotAllowLCS = 32768 , kDrawableMergeControlOff = 65536 , kLastFlag = kDrawableMergeControlOff }

enum	DrawableType { kGeometry = 0 , kDistantLight = 1 , kPointLight = 2 , kSpotLight = 3 , kAmbientLight , kSolidBackground , kGradientBackground , kImageBackground , kGroundPlaneBackground , kViewport , kWebLight , kSkyBackground , kImageBasedLightingBackground }

Public Member Functions
	DWGMAP_DECLARE_MEMBERS (OdDbProxyObject)

	OdDbProxyObject ()

virtual OdResult	dwgInFields (OdDbDwgFiler *pFiler)

virtual void	dwgOutFields (OdDbDwgFiler *pFiler) const

virtual OdResult	dxfInFields (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields (OdDbDxfFiler *pFiler) const

virtual OdResult	dxfIn (OdDbDxfFiler *filer)

int	proxyFlags () const

virtual OdString	originalClassName () const

OdString	originalDxfName () const

OdString	applicationDescription () const

void	getReferences (OdTypedIdsArray &objectIds) const

OdDb::DuplicateRecordCloning	mergeStyle () const

virtual OdDbObjectPtr	subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *, bool bPrimary) const ODRX_OVERRIDE

virtual OdDbObjectPtr	subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *, bool bPrimary) const ODRX_OVERRIDE

bool	eraseAllowed () const

bool	allButCloningAllowed () const

bool	cloningAllowed () const

bool	allOperationsAllowed () const

bool	isR13FormatProxy () const

virtual OdResult	subErase (bool erasing)

Public Member Functions inherited from OdDbObject
	ODDB_DECLARE_MEMBERS (OdDbObject)

	~OdDbObject ()

void	addRef ()

void	release ()

long	numRefs () const

OdDbObjectId	objectId () const

OdDbHandle	getDbHandle () const

OdDbHandle	handle () const

OdDbObjectId	ownerId () const

virtual void	setOwnerId (OdDbObjectId ownerId)

OdDbDatabase *	database () const

void	createExtensionDictionary ()

OdDbObjectId	extensionDictionary () const

bool	releaseExtensionDictionary ()

OdDbXrecordPtr	createXrecord (const OdString &xrecordName, OdDb::DuplicateRecordCloning style=OdDb::kDrcIgnore)

void	upgradeOpen ()

void	downgradeOpen ()

void	cancel ()

virtual OdResult	subOpen (OdDb::OpenMode mode)

virtual void	subClose ()

OdResult	erase (bool eraseIt=true)

virtual OdResult	subErase (bool erasing)

void	handOverTo (OdDbObject *pNewObject, bool keepXData=true, bool keepExtDict=true)

virtual void	subHandOverTo (OdDbObject *pNewObject)

void	swapIdWith (OdDbObjectId otherId, bool swapXdata=false, bool swapExtDict=false)

virtual void	subSwapIdWith (const OdDbObjectId &otherId, bool swapXdata=false, bool swapExtDict=false)

virtual void	audit (OdDbAuditInfo *pAuditInfo)

void	dwgIn (OdDbDwgFiler *pFiler)

void	dwgOut (OdDbDwgFiler *pFiler) const

virtual OdResult	dxfIn (OdDbDxfFiler *pFiler)

virtual void	dxfOut (OdDbDxfFiler *pFiler) const

virtual OdResult	dwgInFields (OdDbDwgFiler *pFiler)

virtual void	dwgOutFields (OdDbDwgFiler *pFiler) const

virtual OdResult	dxfInFields (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields (OdDbDxfFiler *pFiler) const

virtual OdResult	dxfInFields_R12 (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields_R12 (OdDbDxfFiler *pFiler) const

virtual OdDb::DuplicateRecordCloning	mergeStyle () const

virtual OdResBufPtr	xData (const OdString &regappName=OdString::kEmpty) const

virtual void	setXData (const OdResBuf *pRb)

bool	isEraseStatusToggled () const

bool	isErased () const

bool	isReadEnabled () const

bool	isWriteEnabled () const

bool	isNotifyEnabled () const

bool	isModified () const

bool	isModifiedXData () const

bool	isModifiedGraphics () const

bool	isNewObject () const

bool	isNotifying () const

bool	isUndoing () const

bool	isReallyClosing () const

bool	isDBRO () const

void	assertReadEnabled () const

void	assertWriteEnabled (bool autoUndo=true, bool recordModified=true)

void	assertNotifyEnabled () const

void	disableUndoRecording (bool disable)

bool	isUndoRecordingDisabled () const

OdDbDwgFiler *	undoFiler ()

virtual void	applyPartialUndo (OdDbDwgFiler pUndoFiler, OdRxClass pClassObj)

void	addReactor (OdDbObjectReactor *pReactor) const

void	removeReactor (OdDbObjectReactor *pReactor) const

virtual void	addPersistentReactor (const OdDbObjectId &objId)

virtual void	removePersistentReactor (const OdDbObjectId &objId)

bool	hasPersistentReactor (const OdDbObjectId &objId) const

OdDbObjectIdArray	getPersistentReactors () const

OdDbObjectReactorArray	getTransientReactors () const

virtual void	recvPropagateModify (const OdDbObject *pSubObj)

virtual void	xmitPropagateModify () const

ODRX_SEALED_VIRTUAL OdDbObjectPtr	deepClone (OdDbIdMapping &idMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdDbObjectPtr	wblockClone (OdDbIdMapping &idMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED

virtual void	appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &idMap)

void	setOdDbObjectIdsInFlux ()

bool	isOdDbObjectIdsInFlux () const

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	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)

bool	isAProxy () const

virtual void	objectClosed (const OdDbObjectId &objectId)

virtual void	modifiedGraphics (const OdDbObject *pObject)

virtual void	copyFrom (const OdRxObject *pSource)

bool	hasSaveVersionOverride () const

void	setHasSaveVersionOverride (bool hasSaveVersionOverride)

virtual OdDb::DwgVersion	getObjectSaveVersion (const OdDbFiler pFiler, OdDb::MaintReleaseVer pMaintVer=0) const

virtual OdDbObjectPtr	decomposeForSave (OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)

virtual OdDbObjectPtr	decomposeForSave (OdDb::SaveType format, OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)

void	convertForSave (OdDb::DwgVersion ver)

virtual void	composeForLoad (OdDb::SaveType format, OdDb::DwgVersion version, OdDbAuditInfo *pAuditInfo)

virtual OdGiDrawable *	drawable ()

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *pTraits) const

virtual bool	subWorldDraw (OdGiWorldDraw *pWd) const

virtual void	subViewportDraw (OdGiViewportDraw *pVd) const

virtual bool	isPersistent () const

virtual OdDbStub *	id () const

ODRX_SEALED_VIRTUAL OdResult	getClassID (void *pClsid) const ODRX_SEALED

void	setGsNode (OdGsCache *pNode)

OdGsCache *	gsNode () const

void	xDataTransformBy (const OdGeMatrix3d &xfm)

bool	hasFields () const

OdDbObjectId	getField (const OdString &fieldName) const

OdDbObjectPtr	getField (const OdString &fieldName, OdDb::OpenMode mode) const

virtual OdDbObjectId	setField (const OdString &fieldName, OdDbField *pField)

virtual OdResult	removeField (OdDbObjectId fieldId)

virtual OdDbObjectId	removeField (const OdString &fieldName)

OdDbObjectId	getFieldDictionary () const

OdDbObjectPtr	getFieldDictionary (OdDb::OpenMode mode) const

virtual OdRxClass *	saveAsClass (OdRxClass *pClass) const

Public Member Functions inherited from OdGiDrawable
	ODRX_DECLARE_MEMBERS (OdGiDrawable)

virtual DrawableType	drawableType () const

ODRX_SEALED_VIRTUAL OdUInt32	setAttributes (OdGiDrawableTraits *pTraits) const ODRX_SEALED

ODRX_SEALED_VIRTUAL bool	worldDraw (OdGiWorldDraw *pWd) const ODRX_SEALED

ODRX_SEALED_VIRTUAL void	viewportDraw (OdGiViewportDraw *pVd) const ODRX_SEALED

virtual bool	isPersistent () const =0

virtual OdDbStub *	id () const =0

virtual void	setGsNode (OdGsCache *pGsNode)=0

virtual OdGsCache *	gsNode () const =0

ODRX_SEALED_VIRTUAL OdUInt32	viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_SEALED

virtual OdResult	getGeomExtents (OdGeExtents3d &extents) const

ODRX_SEALED_VIRTUAL OdUInt32	regenSupportFlags () const ODRX_SEALED

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

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

static OdRxClass *	desc ()

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	subSetAttributes (OdGiDrawableTraits *traits) const =0

virtual bool	subWorldDraw (OdGiWorldDraw *wd) const =0

virtual void	subViewportDraw (OdGiViewportDraw *vd) const =0

virtual OdUInt32	subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const

virtual OdUInt32	subRegenSupportFlags () const

Protected Attributes inherited from OdDbObject
OdDbObjectImpl *	m_pImpl

Detailed Description

This class is the abstract base class for Proxy objects in an OdDbDatabase instance.

Definition at line 42 of file DbProxyObject.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
kNoOperation
kEraseAllowed
kCloningAllowed
kAllButCloningAllowed
kAllAllowedBits
kMergeIgnore
kMergeReplace
kMergeMangleName
kDisableProxyWarning

Definition at line 111 of file DbProxyObject.h.

Constructor & Destructor Documentation

◆ OdDbProxyObject()

OdDbProxyObject::OdDbProxyObject ( )

Member Function Documentation

◆ allButCloningAllowed()

bool OdDbProxyObject::allButCloningAllowed ( ) const

inline

Returns true if and only if all but the subDeepClone() and subWblockClone() methods are allowed for this Proxy object.

Definition at line 131 of file DbProxyObject.h.

◆ allOperationsAllowed()

bool OdDbProxyObject::allOperationsAllowed ( ) const

inline

Returns true if and only if all methods are allowed for this Proxy entity.

Remarks: The allowed methods are as follows

@untitled table subDeepClone() erase() subWblockClone()

Definition at line 149 of file DbProxyObject.h.

◆ applicationDescription()

OdString OdDbProxyObject::applicationDescription ( ) const

Returns the application description of the object represented by this Proxy object.

◆ cloningAllowed()

bool OdDbProxyObject::cloningAllowed ( ) const

inline

Returns true if and only if the subDeepClone() and subWblockClone() methods are allowed for this Proxy object.

Definition at line 136 of file DbProxyObject.h.

◆ dwgInFields()

virtual OdResult OdDbProxyObject::dwgInFields ( OdDbDwgFiler * pFiler )

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.

◆ DWGMAP_DECLARE_MEMBERS()

OdDbProxyObject::DWGMAP_DECLARE_MEMBERS ( OdDbProxyObject )

◆ dwgOutFields()

virtual void OdDbProxyObject::dwgOutFields ( OdDbDwgFiler * pFiler ) const

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.

◆ dxfIn()

virtual OdResult OdDbProxyObject::dxfIn ( OdDbDxfFiler * pFiler )

virtual

Reads the DXF format data of this object from the specified filer.

Parameters

pFiler [in] Pointer to the filer from which the data are to be read.

Returns: Returns the filer status.

This function calls this object's dxfInFields(pFiler), then loads any Xdata associated with this object.

Reimplemented from OdDbObject.

◆ dxfInFields()

virtual OdResult OdDbProxyObject::dxfInFields ( OdDbDxfFiler * pFiler )

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 void OdDbProxyObject::dxfOutFields ( OdDbDxfFiler * pFiler ) const

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.

◆ eraseAllowed()

bool OdDbProxyObject::eraseAllowed ( ) const

inline

Returns true if and only if the erase() method is allowed for this Proxy entity.

Definition at line 127 of file DbProxyObject.h.

◆ getReferences()

void OdDbProxyObject::getReferences ( OdTypedIdsArray & objectIds ) const

Returns an array of the Object IDs referenced by this Proxy object.

Parameters

objectIds [out] Receives an array of the reference Object IDs.

◆ isR13FormatProxy()

bool OdDbProxyObject::isR13FormatProxy ( ) const

inline

Returns true if and only this Proxy entity is a R13 format Proxy object.

Definition at line 154 of file DbProxyObject.h.

◆ mergeStyle()

OdDb::DuplicateRecordCloning OdDbProxyObject::mergeStyle ( ) const

virtual

Returns the merge style of this object.

Reimplemented from OdDbObject.

◆ originalClassName()

virtual OdString OdDbProxyObject::originalClassName ( ) const

virtual

Returns the class name of the object represented by this Proxy object.

◆ originalDxfName()

OdString OdDbProxyObject::originalDxfName ( ) const

Returns the DXF name of the object represented by this Proxy object.

◆ proxyFlags()

int OdDbProxyObject::proxyFlags ( ) const

Returns the edit flags for the class contained in this Proxy object.

Remarks: proxyFlags() returns a combination of one or more of the following:

Value Description kNoOperation 0x0 None kEraseAllowed 0x1 erase() kCloningAllowed 0x80 subDeepClone(), subWblockClone() kAllButCloningAllowed 0x1 erase() kAllAllowedBits 0x81 erase(), subDeepClone(), subWblockClone() kMergeIgnore 0x00 Keep orignal names. kMergeReplace 0x100 Use clone. kMergeMangleName 0x200 Create anonymous name.

◆ subDeepClone()

virtual OdDbObjectPtr OdDbProxyObject::subDeepClone	(	OdDbIdMapping &	ownerIdMap,
		OdDbObject *	,
		bool	bPrimary
	)		const

virtual

Reimplemented from OdDbObject.

◆ subErase()

virtual OdResult OdDbProxyObject::subErase ( bool erasing )

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.

◆ subWblockClone()

virtual OdDbObjectPtr OdDbProxyObject::subWblockClone	(	OdDbIdMapping &	ownerIdMap,
		OdDbObject *	,
		bool	bPrimary
	)		const

virtual

Reimplemented from OdDbObject.

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

DbProxyObject.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ OdDbProxyObject()

Member Function Documentation

◆ allButCloningAllowed()

◆ allOperationsAllowed()

◆ applicationDescription()

◆ cloningAllowed()

◆ dwgInFields()

◆ DWGMAP_DECLARE_MEMBERS()

◆ dwgOutFields()

◆ dxfIn()

◆ dxfInFields()

◆ dxfOutFields()

◆ eraseAllowed()

◆ getReferences()

◆ isR13FormatProxy()

◆ mergeStyle()

◆ originalClassName()

◆ originalDxfName()

◆ proxyFlags()

◆ subDeepClone()

◆ subErase()

◆ subWblockClone()