Close

Relief for ODA Team in Ukraine

Learn more
ODA Drawings SDK
API Reference > OdDb Classes > OdDbOleFrame Class
OdDbOleFrame Class
Syntax
C++
class OdDbOleFrame : public OdDbFrame;

This class is the abstract base class for OdDbOle2Frame graphical entities contained in an OdDbDatabase instance. 

 

OdDbOleFrameOdDbOleFrameOdDbOleFrameOdDbOleFrameOdDbOleFrame

File: DbOleFrame.h 

Module: API Reference 

Show:
No members matching the current filter
OdDbEntity
(Inherited from OdDbEntity)
OdDbFrame
(Inherited from OdDbFrame)
OdDbOleFrame
~OdDbObject
(Inherited from OdDbObject)
Show:
No members matching the current filter
DWGMAP_DECLARE_MEMBERS
ODDB_DECLARE_MEMBERS
(Inherited from OdDbEntity)
ODDB_DECLARE_MEMBERS
(Inherited from OdDbFrame)
ODDB_DECLARE_MEMBERS
(Inherited from OdDbObject)
addPersistentReactor
Adds the specified persistent reactor to this object's reactor list.
(Inherited from OdDbObject)
addReactor
Adds the specified transient reactor to this object's reactor list.
(Inherited from OdDbObject)
addRef
Increments the reference count of this object. (Inherited from OdDbObject)
addSubentPaths
(Inherited from OdDbEntity)
appendToOwner
This function appends this object to the specified owner object during the deep or wblock clone operation.
(Inherited from OdDbEntity)
appendToOwner
This function appends this object to the specified owner object during the deep or wblock clone operation.
(Inherited from OdDbObject)
applyPartialUndo
Notification function called each time an Undo operation is performed this object is using partial Undo.
(Inherited from OdDbEntity)
applyPartialUndo
Notification function called each time an Undo operation is performed this object is using partial Undo.
(Inherited from OdDbObject)
assertNotifyEnabled
Throws an exception if this object is not open OdDb::kForNotify. (Inherited from OdDbObject)
assertReadEnabled
Throws an exception if this object is not open OdDb::kForRead. (Inherited from OdDbObject)
assertWriteEnabled
Throws an exception if this object is not open OdDb::kForWrite, and controls automatic undo and notification of modifications.
(Inherited from OdDbObject)
audit
Perform an audit operation on this object.
(Inherited from OdDbObject)
blockId
Returns the Object ID of the OdDbBlockTableRecord that owns this entity. (Inherited from OdDbEntity)
boundingBoxIntersectWith(const OdDbEntity*, OdDb::Intersect, const OdGePlane&, OdGePoint3dArray&, OdGsMarker, OdGsMarker)
This is the overview for the boundingBoxIntersectWith method overload.
castShadows
Returns the CastShadows flag for this entity.. (Inherited from OdDbEntity)
cloneMeForDragging
Returns the cloneMeForDragging flag for this entity. (Inherited from OdDbEntity)
collisionType
Returns the CollisionType for this entity. (Inherited from OdDbEntity)
color
Returns the color information of this entity as an OdCmColor instance. (Inherited from OdDbEntity)
colorId
Returns the Object ID of the OdDbColor object referenced by this entity. (Inherited from OdDbEntity)
colorIndex
Returns the color index of this entity (DXF 62). (Inherited from OdDbEntity)
composeForLoad
After loading from file, performs necessary actions which require accessing other Database objects. For example, processing round-trip data.
(Inherited from OdDbObject)
convertForSave
The method should be called from *decomposeForSave()* of custom container objects for owned child objects. It calls child's decomposeForSave() method plus performs other required actions (handOverTo, exchanging XData, etc.)
(Inherited from OdDbObject)
copied
Notification function called whenever the notifying object has had its clone() member function called.
(Inherited from OdDbObject)
copyFrom
Copies the contents of the specified object into this object when possible.
(Inherited from OdDbEntity)
copyFrom
Copies the contents of the specified object into this object when possible.
(Inherited from OdDbObject)
createExtensionDictionary
Creates an OdDbDictionary extension dictionary of this object. (Inherited from OdDbObject)
createXrecord
Creates or retrieves the specified Xrecord in this object's extension dictionary.
(Inherited from OdDbObject)
database
Returns the OdDbDatabase that contains this object. (Inherited from OdDbObject)
decomposeForSave(OdDb::DwgVersion, OdDbObjectId&, bool&)
This is the overview for the decomposeForSave method overload.
deepClone
Performs a deep clone of this object.
(Inherited from OdDbObject)
deleteSubentPaths
(Inherited from OdDbEntity)
disableUndoRecording
Controls the undo recording of this object in OdDbDatabase.
(Inherited from OdDbObject)
downgradeOpen
Downgrades this object from OdDb::kForWrite to OdDb::kForRead (Inherited from OdDbObject)
dragStatus
Notification function called when this entity is involved in a drag operation.
(Inherited from OdDbEntity)
drawable
Returns a pointer to the OdGiDrawable for the object. If the object doesn't have an associated OdGiDrawable object, this function returns NULL. (Inherited from OdDbEntity)
drawable
Returns a pointer to the OdGiDrawable for the object. If the object doesn't have an associated OdGiDrawable object, this function returns NULL. (Inherited from OdDbObject)
dwgIn
Reads the .dwg file format data of this object from the specified file.
(Inherited from OdDbObject)
dwgInFields
Reads the .dwg file data of this object.
(Inherited from OdDbEntity)
dwgInFields
Reads the .dwg file data of this object.
(Inherited from OdDbObject)
dwgOut
Writes the .dwg file format data of this object to the specified filer.
(Inherited from OdDbObject)
dwgOutFields
Writes the .dwg file data of this object.
(Inherited from OdDbEntity)
dwgOutFields
Writes the .dwg file data of this object.
(Inherited from OdDbObject)
dxfIn
Reads the DXF format data of this object from the specified filer.
(Inherited from OdDbEntity)
dxfIn
Reads the DXF format data of this object from the specified filer.
(Inherited from OdDbObject)
dxfInFields
Reads the DXF data of this object.
(Inherited from OdDbEntity)
dxfInFields
Reads the DXF data of this object.
(Inherited from OdDbObject)
dxfInFields_R12
Reads the DXF R12 format data of this object.
(Inherited from OdDbEntity)
dxfInFields_R12
Reads the DXF R12 format data of this object.
(Inherited from OdDbObject)
dxfOut
Writes the DXF format data of this object to the specified filer.
(Inherited from OdDbEntity)
dxfOut
Writes the DXF format data of this object to the specified filer.
(Inherited from OdDbObject)
dxfOutFields
Writes the DXF data of this object.
(Inherited from OdDbEntity)
dxfOutFields
Writes the DXF data of this object.
(Inherited from OdDbObject)
dxfOutFields_R12
Writes the DXF data of this object.
(Inherited from OdDbEntity)
dxfOutFields_R12
Writes the DXF data of this object.
(Inherited from OdDbObject)
entityColor
Returns the OdCmEntityColor settings of this object. (Inherited from OdDbEntity)
erase
Sets the erased mode of this object.
(Inherited from OdDbObject)
erased
Notification function called whenever an object has been erased or unerased.
(Inherited from OdDbObject)
explode
Explodes this entity into a set of simpler entities.
(Inherited from OdDbEntity)
explodeGeometry
Explodes this entity into a set of simpler entities.
(Inherited from OdDbEntity)
explodeGeometryToBlock
Explodes this entity into a set of simpler entities, and adds them to the specified block.
(Inherited from OdDbEntity)
explodeToBlock
Explodes this entity into a set of simpler entities, and adds them to the specified block table record.
(Inherited from OdDbEntity)
extensionDictionary
Returns the Object ID of this object's extension dictionary. (Inherited from OdDbObject)
getClassID
Returns the CLSID value associated with this object.
(Inherited from OdDbObject)
getCompoundObjectTransform
Is applicable for compound objects only which return the kDrawableIsCompoundObject flag from subSetAttributes(). The matrix returned is the one that is passed to pushModelTransform before rendering nested objects. Default implementation returns OdDb::eNotApplicable and the identity matrix in xM. (Inherited from OdDbEntity)
getDbHandle
Returns the persistent handle of this database object. (Inherited from OdDbObject)
getEcs
Returns the entity coordinate system matrix. (Inherited from OdDbEntity)
getField(const OdString&)
This is the overview for the getField method overload.
getFieldDictionary()
This is the overview for the getFieldDictionary method overload.
getGeomExtents
(Inherited from OdDbEntity)
getGripPoints(OdDbGripDataPtrArray&, const double, const int, const OdGeVector3d&, const int)
This is the overview for the getGripPoints method overload.
getGripPointsAtSubentPath
(Inherited from OdDbEntity)
getGsMarkersAtSubentPath
(Inherited from OdDbEntity)
getObjectSaveVersion
Returns the drawing and maintenance release version into which this object must be stored.
(Inherited from OdDbObject)
getOsnapPoints(OdDb::OsnapMode, OdGsMarker, const OdGePoint3d&, const OdGePoint3d&, const OdGeMatrix3d&, OdGePoint3dArray&)
This is the overview for the getOsnapPoints method overload.
getPersistentReactors
Returns Object IDs of this object's persistent reactors. (Inherited from OdDbObject)
getPlane
Returns the plane that contains this entity.
(Inherited from OdDbEntity)
getPlotStyleNameId
Returns the PlotStyleName of this entity.
(Inherited from OdDbEntity)
getStretchPoints
Returns all stretch points of this entity.
(Inherited from OdDbEntity)
getSubentClassId
(Inherited from OdDbEntity)
getSubentPathGeomExtents
(Inherited from OdDbEntity)
getSubentPathsAtGsMarker
(Inherited from OdDbEntity)
getTransformedCopy
Creates a copy of this entity, and applies the supplied transformation to the newly created copy.
(Inherited from OdDbEntity)
getTransientReactors
Returns this object's transient reactors. (Inherited from OdDbObject)
goodbye
Notification function called just before an object is deleted from memory.
(Inherited from OdDbObject)
gripStatus
Notification function called when this entity is involved in a grip operation.
(Inherited from OdDbEntity)
gsNode
Returns the OdGsCache of an OdGiDrawable object. (Inherited from OdDbObject)
handOverTo
Replaces this database -resident (DBRO) object with the specified non- database -resident (NDBRO) object, while retaining this object's objectId, handle, owner, and reactor list.
(Inherited from OdDbObject)
handle
Returns the persistent handle of this database object. (Inherited from OdDbObject)
hasFields
Returns true if and only if this object has fields. (Inherited from OdDbObject)
hasPersistentReactor
This method returns true if objId is the Object ID of a reactor attached to this object. Otherwise, it returns false.
(Inherited from OdDbObject)
hasSaveVersionOverride
Returns true if and only if this object has its bit set to override the filer version. (Inherited from OdDbObject)
hideMeForDragging
Returns the hideMeForDragging flag for this entity. (Inherited from OdDbEntity)
highlight
(Inherited from OdDbEntity)
id
Returns the database ID corresponding to this object. (Inherited from OdDbObject)
intersectWith(const OdDbEntity*, OdDb::Intersect, const OdGePlane&, OdGePoint3dArray&, OdGsMarker, OdGsMarker)
This is the overview for the intersectWith method overload.
isAProxy
Returns true if and only if this object is a proxy object or entity. (Inherited from OdDbObject)
isContentSnappable
(Inherited from OdDbEntity)
isDBRO
Returns true if and only this object is a database -resident object. (Inherited from OdDbObject)
isEraseStatusToggled
Returns true if and only if this object's erased status has been toggled since it was opened. (Inherited from OdDbObject)
isErased
Returns true if and only if this object is marked as erased. (Inherited from OdDbObject)
isModified
Returns true if and only if this object's assertWriteEnabled() has been called since it was opened. (Inherited from OdDbObject)
isModifiedGraphics
Returns true if and only if an object derived from OdDbEntity has been modified. (Inherited from OdDbObject)
isModifiedXData
Returns true if and only this object's assertWriteEnabled() and setXData() have been called since it was opened. (Inherited from OdDbObject)
isNewObject
Returns true if and only if this object has not been closed since it was created. (Inherited from OdDbObject)
isNotifyEnabled
Returns true if and only if this object is open OdDb::kForNotify. (Inherited from OdDbObject)
isNotifying
Returns true if and only if this object is sending notification. (Inherited from OdDbObject)
isOdDbObjectIdsInFlux
Returns true if and only if this object's Object ID is not valid because the OdDbObject::subDeepClone or OdDbObject::subWblockClone() have yet to be completed. (Inherited from OdDbObject)
isPersistent
Return true if and only if this object is database -resident (DBRO). (Inherited from OdDbObject)
isPlanar
Returns true if and only if this entity is planar. (Inherited from OdDbEntity)
isReadEnabled
Returns true if and only if this object is open OdDb::kForRead. (Inherited from OdDbObject)
isReallyClosing
Returns true if and only if a call to close would completely close this object at this time. (Inherited from OdDbObject)
isUndoing
Returns true if and only if this object is taking part in an Undo operation. (Inherited from OdDbObject)
isWriteEnabled
Returns true if and only if this object is open OdDb::kForWrite. (Inherited from OdDbObject)
layer
Returns the name of the layer referenced by this entity (DXF 8). (Inherited from OdDbEntity)
layerId
Returns the Object ID of the OdDbLayerTableRecord referenced by this entity. (Inherited from OdDbEntity)
lineWeight
Returns the lineweight property of this entity (DXF 370). (Inherited from OdDbEntity)
linetype
Returns the name of the linetype referenced by this entity (DXF 6). (Inherited from OdDbEntity)
linetypeId
Returns the Object ID of the linetype referenced by this entity (DXF 6). (Inherited from OdDbEntity)
linetypeScale
Returns the linetype scale of this entity (DXF 48). (Inherited from OdDbEntity)
list
This method is triggered by the standard LIST command and is to be display the dxf format contents of the entity to the display. (Inherited from OdDbEntity)
material
Returns the name of the material referenced by this entity (DXF 347). (Inherited from OdDbEntity)
materialId
Returns the Object ID of the material referenced by this entity (DXF 347). (Inherited from OdDbEntity)
materialMapper
Returns OdGiMapper used to map a material to the entity. Returns null if the default mapper is used. (Inherited from OdDbEntity)
mergeStyle
Returns the merge style of this object. (Inherited from OdDbObject)
modified
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.
(Inherited from OdDbObject)
modifiedGraphics
Notification function called whenever an object derived from OdDbEntity is modified.
(Inherited from OdDbObject)
modifiedXData
Notification function called whenever the XData has been written to the notifying object.
(Inherited from OdDbObject)
modifyUndone
Notification function called whenever the notifying object is in the midst an Undo operation that is undoing modifications.
(Inherited from OdDbObject)
moveGripPointsAt(const OdDbVoidPtrArray&, const OdGeVector3d&, int)
This is the overview for the moveGripPointsAt method overload.
moveGripPointsAtSubentPaths
(Inherited from OdDbEntity)
moveStretchPointsAt
Moves the specified stretch points of this entity.
(Inherited from OdDbEntity)
numRefs
Returns the reference count of this object. (Inherited from OdDbObject)
objectClosed
Notification function called immediately before an object is closed.
(Inherited from OdDbObject)
objectId
Returns the Object ID of this object. (Inherited from OdDbObject)
openedForModify
Notification function called whenever an object is opened for modify OdDb::kForWrite.
(Inherited from OdDbObject)
ownerId
Returns the Object ID of this object's owner. (Inherited from OdDbObject)
plotStyleName
Returns the name of the plotStyleName string associated with this entity (DXF 390). (Inherited from OdDbEntity)
reappended
Notification function called whenever a Redo process processes the reappending of the notifying object to the database.
(Inherited from OdDbObject)
receiveShadows
Returns the ReceiveShadows flag for this entity.. (Inherited from OdDbEntity)
recordGraphicsModified
Sets the bit flag indicating the entity's geometry is changed.
(Inherited from OdDbEntity)
recvPropagateModify
Allows a subobject of a complex object to notify its root object that it has been changed.
(Inherited from OdDbObject)
release
Decrements the reference count of this object. (Inherited from OdDbObject)
releaseExtensionDictionary
Releases and erases this object's extension dictionary if it exists and is empty. (Inherited from OdDbObject)
removeField(OdDbObjectId)
This is the overview for the removeField method overload.
removePersistentReactor
Removes the specified persistent reactor from this object's reactor list.
(Inherited from OdDbObject)
removeReactor
Removes the specified transient reactor from this object's reactor list.
(Inherited from OdDbObject)
saveAs
Creates a geometric representation of this entity for saving proxy graphics or converting to previous formats.
(Inherited from OdDbEntity)
saveAsClass
!DOM (Inherited from OdDbObject)
setCastShadows
Controls the CastShadows flag for this entity. (Inherited from OdDbEntity)
setColor
Sets the color information of this entity from an OdCmColor instance.
(Inherited from OdDbEntity)
setColorId
Assigns the specified OdDbColor object to this entity.
(Inherited from OdDbEntity)
setColorIndex
Sets the color index of this entity (DXF 62).
(Inherited from OdDbEntity)
setDatabaseDefaults
Applies the default properties of the specified database to this entity.
(Inherited from OdDbEntity)
setField
Adds the specified field to the field dictionary of this object.
(Inherited from OdDbObject)
setGsNode
Assigns the specified OdGsCache to the calling object.
(Inherited from OdDbObject)
setHasSaveVersionOverride
Controls the flag specifying that this object overrides the save filer version.
(Inherited from OdDbObject)
setLayer(OdDbObjectId, bool, bool)
This is the overview for the setLayer method overload.
setLineWeight
Sets the lineweight property of this entity (DXF 370).
(Inherited from OdDbEntity)
setLinetype(OdDbObjectId, bool)
This is the overview for the setLinetype method overload.
setLinetypeScale
Sets the Linetype scale of this entity (DXF 48).
(Inherited from OdDbEntity)
setMaterial(OdDbObjectId, bool)
This is the overview for the setMaterial method overload.
setMaterialMapper
Sets the mapper used to map a material to the entity.
(Inherited from OdDbEntity)
setOdDbObjectIdsInFlux
Called on a new created cloned object to indicate that its Object ID is not valid. (Inherited from OdDbObject)
setOwnerId
Sets this object's ownerId data member.
(Inherited from OdDbObject)
setPlotStyleName(OdDb::PlotStyleNameType, OdDbObjectId, bool)
This is the overview for the setPlotStyleName method overload.
setPropertiesFrom
Copies the properties from the specified entity to this entity. (Inherited from OdDbEntity)
setReceiveShadows
Controls the Receivehadows flag for this entity. (Inherited from OdDbEntity)
setTempVisibility
Sets the temporary (not saved to file) visibility status of this entity.
(Inherited from OdDbEntity)
setTransparency
Sets the transparency setting of this entity, and returns eOk if successful.
(Inherited from OdDbEntity)
setVisibility
Sets the visibility status of this entity (DXF 60).
(Inherited from OdDbEntity)
setVisualStyle
Sets the *visual style* to be used by this entity.
(Inherited from OdDbEntity)
setXData
Sets the XData of this object.
(Inherited from OdDbObject)
subClose
Called as the first operation as this object is being closed, for database -resident objects only. (Inherited from OdDbObject)
subErase
Called as the first operation as this object is being erased or unerased.
(Inherited from OdDbEntity)
subErase
Called as the first operation as this object is being erased or unerased.
(Inherited from OdDbObject)
subGetClassID
overridables (Inherited from OdDbEntity)
subHandOverTo
Called as the first operation of the handOverTo function.
(Inherited from OdDbEntity)
subHandOverTo
Called as the first operation of the handOverTo function.
(Inherited from OdDbObject)
subList
(Inherited from OdDbEntity)
subObjModified
Notification function called whenever a method of the specified subobject has called assertWriteEnabled()
(Inherited from OdDbObject)
subOpen
Notification function called by the Drawings framework immediately before an object is opened.
(Inherited from OdDbEntity)
subOpen
Notification function called by the Drawings framework immediately before an object is opened.
(Inherited from OdDbObject)
subSetAttributes
Sets the values of this object's subentity traits, and returns with the calling object's subentity traits.
(Inherited from OdDbEntity)
subSetAttributes
Sets the values of this object's subentity traits, and returns with the calling object's subentity traits.
(Inherited from OdDbObject)
subSetDatabaseDefaults
Called by setDatabaseDefaults() after the values are set.
(Inherited from OdDbEntity)
subSwapIdWith
This function is called as the first operation of the swapIdWith() function.
(Inherited from OdDbEntity)
subSwapIdWith
Called as the first operation of swapIdWith
(Inherited from OdDbObject)
subViewportDraw
(Inherited from OdDbEntity)
subViewportDraw
(Inherited from OdDbObject)
subWorldDraw
(Inherited from OdDbEntity)
subWorldDraw
(Inherited from OdDbObject)
subentGripStatus
(Inherited from OdDbEntity)
subentPtr
(Inherited from OdDbEntity)
swapIdWith
Swaps the objectIDs, handles, XData,and extension dictionary between this object and another object.
(Inherited from OdDbObject)
tempVisibility
Returns the temporary (not saved) visibility status of this entity. (Inherited from OdDbEntity)
transformBy
Applies the specified 3D transformation matrix to this entity.
(Inherited from OdDbEntity)
transformSubentPathsBy
(Inherited from OdDbEntity)
transparency
Returns the transparency setting of this entity. (Inherited from OdDbEntity)
unappended
Notification function called whenever the Undo process processes the appending of the notifying object to the database.
(Inherited from OdDbObject)
undoFiler
Returns the undo filer associated with this object. (Inherited from OdDbObject)
upgradeOpen
Upgrades this object from OdDb::kForRead to OdDb::kForWrite. (Inherited from OdDbObject)
visibility
Returns the visibility status of this entity. It takes into account both permanent (DXF 60) and temporary visibility statuses: the entity is visible only if it's visible in both parts. (Inherited from OdDbEntity)
visualStyleId
Returns the Object ID of the *visual style* used by this entity. (Inherited from OdDbEntity)
wblockClone
Performs a shallow clone of this object.
(Inherited from OdDbObject)
xData
Returns a linked list of ResBufs containing a copy of the XData of this object.
(Inherited from OdDbObject)
xDataTransformBy
Applies the 3D transformation matrix to the XData of this object.
(Inherited from OdDbObject)
xmitPropagateModify
Allows a subobject of a complex object to notify its root object that it has been changed. (Inherited from OdDbObject)
Send feedback about this topic
Copyright © 2002-2022. Open Design Alliance All rights reserved.