OdDgElement Class

Class Hierarchy

Syntax

C++

class OdDgElement : public OdGiDrawable;

File

DgElement.h

Description

Corresponding C++ library: TG_Db

Group

OdDg Classes

Public Methods

	Name	Description
	~OdDgElement
	OdDgElement	This is the overview for the OdDgElement constructor overload.

OdDgElement Enumerations

	Name	Description
	DragStat
	ElementTypes	All types of elements The most types below have appropriate classes that are derived from OdDgElement and have similar names (OdDgMultiline for kMultiline, etc) Some types determine the classes that are derived from OdDgElement but are not available to use Some types are special values for internal use only
	GripStat
	OsnapMode

OdDgElement Methods

	Name	Description
	addLinkage	This is the overview for the addLinkage method overload.
	addPersistentReactor	Adds the specified persistent reactor to this element's reactor list.
	addReactor	Adds the specified transient reactor to this element's reactor list.
	addRef	OdRxObject overridden
	addXAttribute	Adds the XAttribute with specified handler ID.
	appendToOwner	This function appends this object to the specified owner object.
	applyPartialUndo
	assertNotifyEnabled	Throws an exception if this object is not open OdDg::kForNotify.
	assertReadEnabled	Throws an exception if this object is not open OdDg::kForRead.
	assertWriteEnabled	Throws an exception if this object is not open OdDg::kForWrite, and controls automatic undo and notification of modifications.
	cloneMeForDragging	Returns the cloneMeForDragging flag for this entity.
	closed	Notification function called immediately before an element is closed.
	copied	Notification function called whenever the notifying element has had its clone() member function called.
	copyFieldReferencesForWBlockClone	Writes object references of this object during wblock clone.
	copyFrom	Copies the contents of the specified object into this object when possible.
	copyLinkageReferencesForWBlockClone
	copyXAttributeReferencesForWBlockClone
	database	Returns the OdDgDatabase that contains this object.
	deepClone	Performs a deep clone of this object.
	dgnIn	Reads the DGN format data of this object from the specified file.
	dgnInFields	Reads the DGN data of this object.
	dgnOut	Writes the DGN format data of this object to the specified filer.
	dgnOutFields	Writes the DGN data of this object.
	disableUndoRecording	Controls the undo recording of this object in OdDgDatabase.
	downgradeOpen	Downgrades this object from OdDg::kForWrite to OdDg::kForRead, and returns isReadEnabled();
	dragStatus	Notification function called when this entity is involved in a drag operation.
	elementId	Returns the Object ID of this object.
	erase	Sets the erased mode of this object.
	erased	Notification function called whenever an element has been erased or unerased.
	explode
	explodeGeometry
	explodeGeometryToBlock
	explodeToBlock
	getElementSubType	Returns the element subtype.
	getElementType	Returns the element type.
	getGeometryModified
	getGeomExtents	This is the overview for the getGeomExtents method overload.
	getGripPoints	This is the overview for the getGripPoints method overload.
	getLastModifiedTime	Returns the time of the last modification (milliseconds since midnight, January 1, 1970)
	getLinkages	This is the overview for the getLinkages method overload.
	getLockedFlag	Returns true if and only if this element is marked as locked.
	getOsnapPoints	This is the overview for the getOsnapPoints method overload.
	getPersistentReactors	Returns this element's persistent reactors.
	getStretchPoints
	getStringLinkage	Returns the String Linkage value.
	getTransformedCopy	Creates a copy of this element, and applies the supplied transformation to the newly created copy.
	getTransientReactors	Returns this element's transient reactors.
	getXAttributes	This is the overview for the getXAttributes method overload.
	getXDataLinkage	Returns the XData Linkage value.
	goodbye	Notification function called just before an element is deleted from memory.
	gripStatus	Notification function called when this entity is involved in a grip operation.
	gsNode
	handOverTo	Replaces this database -resident (DBRO) object with the specified non- database -resident (NDBRO) object, while retaining this object's elementId, handle, owner, and reactor list.
	hasPersistentReactor	This method returns true if elmId is the Element ID of a reactor attached to this element. Otherwise, it returns false.
	hideMeForDragging	Returns the hideMeForDragging flag for this entity.
	highlight
	id
	isContentSnappable
	isDBRO	Returns true if and only this object is a database -resident object.
	isErased	Returns true if and only if this object is marked as erased.
	isModifiedGraphics	Returns true if and only if an object derived from OdDbEntity has been modified.
	isNewObject	Returns true if and only if this object has not been closed since it was created.
	isNotifyEnabled	Returns true if and only if this object is open OdDg::kForNotify.
	isOdDgElementIdsInFlux	Returns true if and only if this object's Object ID is not valid because the OdDgElement::subDeepClone or OdDgElement::subWblockClone() have yet to be completed.
	isPersistent
	isReadEnabled	Returns true if and only if this object is open OdDg::kForRead.
	isUndoing	Returns true if and only if this object is taking part in an Undo operation.
	isWriteEnabled	Returns true if and only if this object is open OdDg::kForWrite.
	modified	Notification function called whenever an element is opened OdDg::kForWrite, a function has been called that could modify the contents of this element, and this element is now being closed.
	modifiedGeometry	Notification function called whenever an geometry of element derived from OdDgGraphicsElement is modified.
	modifiedGraphics	Notification function called whenever an element derived from OdDgGraphicsElement is modified.
	modifiedLinkages	Notification function called whenever the attribute linkages has been written to the notifying element.
	modifyUndone	Notification function called whenever the notifying element is in the midst an Undo operation that is undoing modifications.
	moveGripPointsAt	This is the overview for the moveGripPointsAt method overload.
	moveStretchPointsAt	Moves the specified stretch points of this entity.
	numRefs
	openedForModify	Notification function called whenever an element is opened for modify OdDg::kForWrite.
	ownerId	Returns the element ID of this element's owner.
	reappended	Notification function called whenever a Redo process processes the reappending of the notifying element to the database.
	recordGraphicsModified	Sets the bit flag indicating the entity's geometry is changed.
	recvPropagateModify	Allows a subelement of a complex element to notify its root element that it has been changed.
	release
	removeLinkages	Removes the linkages with specified application ID.
	removePersistentReactor	Removes the specified persistent reactor from this element's reactor list.
	removeReactor	Removes the specified transient reactor from this element's reactor list.
	removeXAttributes	Removes the XAttributes with specified handler ID.
	setDatabaseDefaults	Applies the default properties of the specified database to this entity.
	setGeometryModified
	setGsNode
	setLinkages	Sets the linkages with specified application ID.
	setLockedFlag
	setOdDgElementIdsInFlux	Called on a new created cloned object to indicate that its Object ID is not valid.
	setOwnerId	Sets this element's ownerId data member.
	setPropertiesFrom	Copies the properties from the specified entity to this entity.
	setStringLinkage	Sets the String Linkage value.
	setXAttributes	Sets the XAttributes with specified handler ID.
	setXDataLinkage	Sets the XData Linkage value.
	subClose	Called as the first operation as this object is being closed, for database -resident objects only. When overriding this function: 1) If the OdDgElement's state is incorrect, return something other than eOk. 2) If the parent class's subClose() returns anything other than eOk, immediately return it. 3) If other actions are required before close, 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 false. The default implementation of this function does nothing but return eOk. This function can be overridden in... more
	subElementModified	Notification function called whenever a method of the specified subelement has called assertWriteEnabled()
	subErase	Called as the first operation as this object is being erased or unerased.
	subGetTransformedCopy
	subHandOverTo	Called as the first operation of the handOverTo function.
	subOpen	Notification function called by the ODA Drawings API for DGN immediately before an object is opened.
	subSetAttributes
	subSetDatabaseDefaults	Called by setDatabaseDefaults() after the values are set.
	subSwapIdWith	Called as the first operation of swapIdWith
	subTransformBy
	subViewportDraw
	subWorldDraw
	swapIdWith	Swaps the elementIDs, and handles between this object and another object.
	transformBy	Applies the specified 3D transformation matrix to this entity.
	unappended	Notification function called whenever the Undo process processes the appending of the notifying element to the database.
	undoFiler	Returns the undo filer associated with this object.
	updateFieldReferencesForWBlockClone
	updateLinkageReferencesForWBlockClone
	updateXAttributeReferencesForWBlockClone
	upgradeOpen	Upgrades this object from OdDg::kForRead to OdDg::kForWrite if there is only one reader, and returns isWriteEnabled();
	wblockClone	Performs a shallow clone of this object.
	xmitPropagateModify	Allows a subelement of a complex element to notify its root element that it has been changed.

Send feedback about this topic