CFx SDK Documentation  2023 SP0
Public Member Functions | List of all members
OdDbBlockReference Class Reference

#include <DbBlockReference.h>

Inheritance diagram for OdDbBlockReference:
OdDbEntity OdDbObject OdGiDrawable OdRxObject OdDbMInsertBlock OdDbTable OdDbViewRepBlockReference

Public Member Functions

 ODDB_DECLARE_MEMBERS (OdDbBlockReference)
 
 OdDbBlockReference ()
 
OdDbObjectId blockTableRecord () const
 
virtual void setBlockTableRecord (OdDbObjectId objectId)
 
virtual OdGePoint3d position () const
 
virtual void setPosition (const OdGePoint3d &position)
 
OdGeScale3d scaleFactors () const
 
virtual void setScaleFactors (const OdGeScale3d &scale)
 
double rotation () const
 
virtual void setRotation (double angle)
 
OdGeVector3d normal () const
 
virtual void setNormal (const OdGeVector3d &normal)
 
virtual bool isPlanar () const
 
virtual OdResult getPlane (OdGePlane &plane, OdDb::Planarity &planarity) const
 
OdGeMatrix3d blockTransform () const
 
virtual OdResult setBlockTransform (const OdGeMatrix3d &xfm)
 
OdDbObjectId appendAttribute (OdDbAttribute *pAttr)
 
OdDbAttributePtr openAttribute (OdDbObjectId ObjId, OdDb::OpenMode mode, bool openErasedOne=false)
 
OdDbSequenceEndPtr openSequenceEnd (OdDb::OpenMode mode)
 
OdDbObjectIteratorPtr attributeIterator () const
 
virtual OdResult explodeToBlock (OdDbBlockTableRecord *BlockRecord, OdDbObjectIdArray *ids=0)
 
OdUInt32 subSetAttributes (OdGiDrawableTraits *pTraits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *pWd) const
 
virtual void subViewportDraw (OdGiViewportDraw *pVd) 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 OdResult dxfIn (OdDbDxfFiler *pFiler)
 
virtual void dxfOut (OdDbDxfFiler *pFiler) const
 
void subClose ()
 
virtual OdResult subGetClassID (void *pClsid) const
 
virtual OdResult subTransformBy (const OdGeMatrix3d &xfm) ODRX_OVERRIDE
 
virtual OdResult subGetTransformedCopy (const OdGeMatrix3d &xfm, OdDbEntityPtr &pCopy) const ODRX_OVERRIDE
 
virtual OdResult subExplode (OdRxObjectPtrArray &entitySet) const ODRX_OVERRIDE
 
void subHandOverTo (OdDbObject *pNewObject)
 
OdResult subGetGeomExtents (OdGeExtents3d &extents) const
 
OdResult explodeGeometry (OdRxObjectPtrArray &entitySet) const
 
virtual bool treatAsOdDbBlockRefForExplode () const
 
OdResult geomExtentsBestFit (OdGeExtents3d &extents, const OdGeMatrix3d &parentXform=OdGeMatrix3d::kIdentity) const
 
virtual OdResult explodeToOwnerSpace () const
 
virtual void copyFrom (const OdRxObject *pSrc) ODRX_OVERRIDE
 
ODRX_SEALED_VIRTUAL OdResult subGetCompoundObjectTransform (OdGeMatrix3d &xM) const ODRX_OVERRIDE
 
ODRX_SEALED_VIRTUAL OdResult subGetSubentPathsAtGsMarker (OdDb::SubentType type, OdGsMarker gsMark, const OdGePoint3d &pickPoint, const OdGeMatrix3d &viewXform, OdDbFullSubentPathArray &subentPaths, const OdDbObjectIdArray *pEntAndInsertStack) const ODRX_OVERRIDE
 
ODRX_SEALED_VIRTUAL OdResult subGetGsMarkersAtSubentPath (const OdDbFullSubentPath &subPath, OdGsMarkerArray &gsMarkers) const ODRX_OVERRIDE
 
- Public Member Functions inherited from OdDbEntity
 ODDB_DECLARE_MEMBERS (OdDbEntity)
 
 OdDbEntity ()
 
OdDbObjectId blockId () const
 
OdCmColor color () const
 
virtual OdResult setColor (const OdCmColor &color, bool doSubents=true)
 
OdUInt16 colorIndex () const
 
virtual OdCmEntityColor entityColor () const
 
virtual OdResult setColorIndex (OdUInt16 colorIndex, bool doSubents=true)
 
OdDbObjectId colorId () const
 
virtual OdResult setColorId (OdDbObjectId colorId, bool doSubents=true)
 
OdCmTransparency transparency () const
 
virtual OdResult setTransparency (const OdCmTransparency &transparency, bool doSubents=true)
 
OdString plotStyleName () const
 
OdDb::PlotStyleNameType getPlotStyleNameId (OdDbObjectId &plotStyleNameId) const
 
virtual OdResult setPlotStyleName (const OdString &plotStyleName, bool doSubents=true)
 
virtual OdResult setPlotStyleName (OdDb::PlotStyleNameType plotStyleNameType, OdDbObjectId plotStyleNameId=OdDbObjectId::kNull, bool doSubents=true)
 
OdString layer () const
 
OdDbObjectId layerId () const
 
virtual OdResult setLayer (const OdString &layerName, bool doSubents=true, bool allowHiddenLayer=false)
 
virtual OdResult setLayer (OdDbObjectId layerId, bool doSubents=true, bool allowHiddenLayer=false)
 
OdString linetype () const
 
OdDbObjectId linetypeId () const
 
virtual OdResult setLinetype (const OdString &linetypeName, bool doSubents=true)
 
virtual OdResult setLinetype (OdDbObjectId linetypeID, bool doSubents=true)
 
OdString material () const
 
OdDbObjectId materialId () const
 
virtual OdResult setMaterial (const OdString &materialName, bool doSubents=true)
 
virtual OdResult setMaterial (OdDbObjectId materialID, bool doSubents=true)
 
OdDbObjectId visualStyleId (VisualStyleType vstype=kFullVisualStyle) const
 
virtual OdResult setVisualStyle (OdDbObjectId visualStyleId, VisualStyleType vstype=kFullVisualStyle, bool doSubents=true)
 
virtual const OdGiMappermaterialMapper () const
 
virtual void setMaterialMapper (const OdGiMapper *mapper, bool doSubents=true)
 
double linetypeScale () const
 
virtual OdResult setLinetypeScale (double linetypeScale, bool doSubents=true)
 
OdDb::Visibility visibility () const
 
ODRX_SEALED_VIRTUAL OdResult setVisibility (OdDb::Visibility visibility, bool doSubents=true) ODRX_SEALED
 
OdDb::Visibility tempVisibility () const
 
void setTempVisibility (OdDb::Visibility visibility)
 
OdDb::LineWeight lineWeight () const
 
virtual OdResult setLineWeight (OdDb::LineWeight lineWeight, bool doSubents=true)
 
virtual bool castShadows () const
 
virtual void setCastShadows (bool castShadows)
 
virtual bool receiveShadows () const
 
virtual void setReceiveShadows (bool receiveShadows)
 
virtual OdDb::CollisionType collisionType () const
 
void setPropertiesFrom (const OdDbEntity *pSource, bool doSubents=true)
 
void subHandOverTo (OdDbObject *pNewObject)
 
ODRX_SEALED_VIRTUAL OdResult transformBy (const OdGeMatrix3d &xfm) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getTransformedCopy (const OdGeMatrix3d &xfm, OdDbEntityPtr &pCopy) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult explode (OdRxObjectPtrArray &entitySet) const ODRX_SEALED
 
virtual OdResult explodeGeometryToBlock (OdDbBlockTableRecord *pBlockRecord, OdDbObjectIdArray *ids=0)
 
void setDatabaseDefaults (OdDbDatabase *pDb=0, bool doSubents=false)
 
virtual void subSetDatabaseDefaults (OdDbDatabase *pDb, bool doSubents)
 
virtual void applyPartialUndo (OdDbDwgFiler *pUndoFiler, OdRxClass *pClassObj)
 
void appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &ownerIdMap)
 
virtual OdGiDrawabledrawable ()
 
virtual void subList () const
 
void subSwapIdWith (const OdDbObjectId &otherId, bool swapXdata=false, bool swapExtDict=false)
 
virtual OdResult subErase (bool erasing) ODRX_OVERRIDE
 
void recordGraphicsModified (bool graphicsModified=true)
 
ODRX_SEALED_VIRTUAL void list () const ODRX_SEALED
 
virtual OdResult getGeomExtents (OdGeExtents3d &extents) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL void highlight (bool bDoIt=true, const OdDbFullSubentPath *pSubId=0, bool highlightAll=false) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getOsnapPoints (OdDb::OsnapMode osnapMode, OdGsMarker gsSelectionMark, const OdGePoint3d &pickPoint, const OdGePoint3d &lastPoint, const OdGeMatrix3d &xWorldToEye, OdGePoint3dArray &snapPoints) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getOsnapPoints (OdDb::OsnapMode osnapMode, OdGsMarker gsSelectionMark, const OdGePoint3d &pickPoint, const OdGePoint3d &lastPoint, const OdGeMatrix3d &xWorldToEye, OdGePoint3dArray &snapPoints, const OdGeMatrix3d &insertionMat) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL bool isContentSnappable () const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getGripPoints (OdGePoint3dArray &gripPoints) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult moveGripPointsAt (const OdIntArray &indices, const OdGeVector3d &offset) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getGripPoints (OdDbGripDataPtrArray &grips, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const int bitFlags) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult moveGripPointsAt (const OdDbVoidPtrArray &grips, const OdGeVector3d &offset, int bitFlags) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getStretchPoints (OdGePoint3dArray &stretchPoints) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult moveStretchPointsAt (const OdIntArray &indices, const OdGeVector3d &offset) ODRX_SEALED
 
virtual void dragStatus (const OdDb::DragStat status)
 
ODRX_SEALED_VIRTUAL void gripStatus (const OdDb::GripStat status) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL bool cloneMeForDragging () ODRX_SEALED
 
ODRX_SEALED_VIRTUAL bool hideMeForDragging () const ODRX_SEALED
 
virtual void saveAs (OdGiWorldDraw *pWd, OdDb::DwgVersion ver) const
 
ODRX_SEALED_VIRTUAL OdResult getCompoundObjectTransform (OdGeMatrix3d &xM) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult intersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, OdGePoint3dArray &points, OdGsMarker thisGsMarker=0, OdGsMarker otherGsMarker=0) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult intersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, const OdGePlane &projPlane, OdGePoint3dArray &points, OdGsMarker thisGsMarker=0, OdGsMarker otherGsMarker=0) const ODRX_SEALED
 
OdResult boundingBoxIntersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, OdGePoint3dArray &points, OdGsMarker thisGsMarker, OdGsMarker otherGsMarker) const
 
OdResult boundingBoxIntersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, const OdGePlane &projPlane, OdGePoint3dArray &points, OdGsMarker thisGsMarker, OdGsMarker otherGsMarker) const
 
ODRX_SEALED_VIRTUAL OdResult getSubentPathsAtGsMarker (OdDb::SubentType type, OdGsMarker gsMark, const OdGePoint3d &pickPoint, const OdGeMatrix3d &xfm, OdDbFullSubentPathArray &subentPaths, const OdDbObjectIdArray *pEntAndInsertStack=0) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getGsMarkersAtSubentPath (const OdDbFullSubentPath &subPath, OdGsMarkerArray &gsMarkers) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getGripPointsAtSubentPath (const OdDbFullSubentPath &path, OdDbGripDataPtrArray &grips, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const OdUInt32 bitflags) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult moveGripPointsAtSubentPaths (const OdDbFullSubentPathArray &paths, const OdDbVoidPtrArray &gripAppData, const OdGeVector3d &offset, const OdUInt32 bitflags) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult deleteSubentPaths (const OdDbFullSubentPathArray &paths) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult addSubentPaths (const OdDbFullSubentPathArray &paths) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdDbEntityPtr subentPtr (const OdDbFullSubentPath &path) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult transformSubentPathsBy (const OdDbFullSubentPathArray &paths, const OdGeMatrix3d &xform) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getSubentClassId (const OdDbFullSubentPath &path, void *clsId) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getSubentPathGeomExtents (const OdDbFullSubentPath &path, OdGeExtents3d &extents) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL void subentGripStatus (OdDb::GripStat status, const OdDbFullSubentPath &subentity) ODRX_SEALED
 
virtual OdGeMatrix3d getEcs () const
 
- 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)
 
OdDbDatabasedatabase () 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)
 
OdResult erase (bool eraseIt=true)
 
void handOverTo (OdDbObject *pNewObject, bool keepXData=true, bool keepExtDict=true)
 
void swapIdWith (OdDbObjectId otherId, bool swapXdata=false, bool swapExtDict=false)
 
virtual void audit (OdDbAuditInfo *pAuditInfo)
 
void dwgIn (OdDbDwgFiler *pFiler)
 
void dwgOut (OdDbDwgFiler *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
 
OdDbDwgFilerundoFiler ()
 
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 &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdDbObjectPtr wblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
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)
 
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 bool isPersistent () const
 
virtual OdDbStub * id () const
 
ODRX_SEALED_VIRTUAL OdResult getClassID (void *pClsid) const ODRX_SEALED
 
void setGsNode (OdGsCache *pNode)
 
OdGsCachegsNode () 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 OdRxClasssaveAsClass (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
 
ODRX_SEALED_VIRTUAL OdUInt32 viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdUInt32 regenSupportFlags () const ODRX_SEALED
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Additional Inherited Members

- Public Types inherited from OdDbEntity
enum  VisualStyleType { kFullVisualStyle , kFaceVisualStyle , kEdgeVisualStyle }
 
- 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 ,
  kLastFlag = kDrawableNotPlottable
}
 
enum  DrawableType {
  kGeometry = 0 , kDistantLight = 1 , kPointLight = 2 , kSpotLight = 3 ,
  kAmbientLight , kSolidBackground , kGradientBackground , kImageBackground ,
  kGroundPlaneBackground , kViewport , kWebLight , kSkyBackground ,
  kImageBasedLightingBackground
}
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
- Protected Member Functions inherited from OdDbEntity
virtual OdDbObjectPtr subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *, bool bPrimary) const ODRX_OVERRIDE
 
virtual OdDbObjectPtr subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *, bool bPrimary) const ODRX_OVERRIDE
 
virtual bool subCloneMeForDragging ()
 
virtual bool subHideMeForDragging () const
 
virtual void subGripStatus (const OdDb::GripStat status)
 
virtual OdResult subGetOsnapPoints (OdDb::OsnapMode osnapMode, OdGsMarker gsSelectionMark, const OdGePoint3d &pickPoint, const OdGePoint3d &lastPoint, const OdGeMatrix3d &xWorldToEye, OdGePoint3dArray &snapPoints) const
 
virtual OdResult subGetOsnapPoints (OdDb::OsnapMode osnapMode, OdGsMarker gsSelectionMark, const OdGePoint3d &pickPoint, const OdGePoint3d &lastPoint, const OdGeMatrix3d &xWorldToEye, OdGePoint3dArray &snapPoints, const OdGeMatrix3d &insertionMat) const
 
virtual bool subIsContentSnappable () const
 
virtual OdResult subGetGripPoints (OdGePoint3dArray &gripPoints) const
 
virtual OdResult subMoveGripPointsAt (const OdIntArray &indices, const OdGeVector3d &offset)
 
virtual OdResult subGetGripPoints (OdDbGripDataPtrArray &grips, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const int bitFlags) const
 
virtual OdResult subMoveGripPointsAt (const OdDbVoidPtrArray &grips, const OdGeVector3d &offset, int bitFlags)
 
virtual OdResult subGetStretchPoints (OdGePoint3dArray &stretchPoints) const
 
virtual OdResult subMoveStretchPointsAt (const OdIntArray &indices, const OdGeVector3d &offset)
 
virtual OdResult subIntersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, OdGePoint3dArray &points, OdGsMarker thisGsMarker=0, OdGsMarker otherGsMarker=0) const
 
virtual OdResult subIntersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, const OdGePlane &projPlane, OdGePoint3dArray &points, OdGsMarker thisGsMarker=0, OdGsMarker otherGsMarker=0) const
 
virtual void subHighlight (bool bDoIt=true, const OdDbFullSubentPath *pSubId=0, bool highlightAll=false) const
 
virtual OdDb::Visibility subVisibility () const
 
virtual OdResult subSetVisibility (OdDb::Visibility visibility, bool doSubents=true)
 
virtual OdResult subDeleteSubentPaths (const OdDbFullSubentPathArray &paths)
 
virtual OdResult subAddSubentPaths (const OdDbFullSubentPathArray &paths)
 
virtual OdResult subMoveGripPointsAtSubentPaths (const OdDbFullSubentPathArray &paths, const OdDbVoidPtrArray &gripAppData, const OdGeVector3d &offset, const OdUInt32 bitflags)
 
virtual OdResult subGetGripPointsAtSubentPath (const OdDbFullSubentPath &path, OdDbGripDataPtrArray &grips, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const OdUInt32 bitflags) const
 
virtual OdDbEntityPtr subSubentPtr (const OdDbFullSubentPath &path) const
 
virtual OdResult subTransformSubentPathsBy (const OdDbFullSubentPathArray &paths, const OdGeMatrix3d &xform)
 
virtual OdResult subGetSubentClassId (const OdDbFullSubentPath &path, void *clsId) const
 
virtual OdResult subGetSubentPathGeomExtents (const OdDbFullSubentPath &path, OdGeExtents3d &extents) const
 
virtual void subSubentGripStatus (OdDb::GripStat status, const OdDbFullSubentPath &subentity)
 
- Protected Member Functions inherited from OdDbObject
 OdDbObject ()
 
- Protected Member Functions inherited from OdGiDrawable
 OdGiDrawable ()
 
virtual OdUInt32 subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const
 
virtual OdUInt32 subRegenSupportFlags () const
 
- Protected Attributes inherited from OdDbObject
OdDbObjectImplm_pImpl
 

Detailed Description

This class represents block references (Inserts) in an OdDbDatabase instance.

See also
TD_Db

<group OdDb_Classes>

Definition at line 56 of file DbBlockReference.h.

Constructor & Destructor Documentation

◆ OdDbBlockReference()

OdDbBlockReference::OdDbBlockReference ( )

Member Function Documentation

◆ appendAttribute()

OdDbObjectId OdDbBlockReference::appendAttribute ( OdDbAttribute pAttr)

Appends the specified OdDbAttribute to the attribute list of this block reference.

Parameters
pAttr[in] Pointer to the attribute to be added.
Returns
Returns the Object ID of the newly appended attribute.
Remarks
This block reference becomes the owner of the passed in attribute, and the attribute is added to the database to which this block reference belongs.
This block reference must be added to a database before calling this function. The object's attribute list should not be added by the client application.

◆ attributeIterator()

OdDbObjectIteratorPtr OdDbBlockReference::attributeIterator ( ) const

Returns an AttributeIterator for this block reference.

◆ blockTableRecord()

OdDbObjectId OdDbBlockReference::blockTableRecord ( ) const

Returns the Object ID of the block table record associated with this OdDbBlockReference (DXF 2).

◆ blockTransform()

OdGeMatrix3d OdDbBlockReference::blockTransform ( ) const

Returns the transformation matrix mapping a point in the MCS to the WCS.

Remarks
The Microspace Coordinate System (MCS) is the WCS within the block definition. Applying this matrix to the center of an arc within the block definition returns the center of the arc as it appears in the block reference.

◆ copyFrom()

virtual void OdDbBlockReference::copyFrom ( const OdRxObject pSrc)
virtual

Copies the contents of the specified object into this object.

Parameters
pSrc[in] Pointer to the source object.
Remarks
The default implementation of this function does nothing but throw an eNotApplicable exception. The source object and this object need not be of the same type. This function is meaningful only when implemented by custom classes.

Reimplemented from OdDbEntity.

Reimplemented in OdDbTable.

◆ dwgInFields()

virtual OdResult OdDbBlockReference::dwgInFields ( OdDbDwgFiler pFiler)
virtual

Reads the .dwg file data of this object.

Parameters
pFiler[in] Filer object from which data are read.
Remarks
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 OdDbEntity.

Reimplemented in OdDbViewRepBlockReference, OdDbTable, and OdDbMInsertBlock.

◆ dwgOutFields()

virtual void OdDbBlockReference::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 OdDbEntity.

Reimplemented in OdDbViewRepBlockReference, OdDbTable, and OdDbMInsertBlock.

◆ dxfIn()

virtual OdResult OdDbBlockReference::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.
Remarks
Returns the filer status. This function calls this object's dxfInFields(pFiler), then loads any Xdata associated with this object.

Reimplemented from OdDbEntity.

◆ dxfInFields()

virtual OdResult OdDbBlockReference::dxfInFields ( OdDbDxfFiler pFiler)
virtual

Reads the DXF data of this object.

Parameters
pFiler[in] Pointer to the filer from which data are read.
Remarks
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 OdDbEntity.

Reimplemented in OdDbViewRepBlockReference, OdDbTable, and OdDbMInsertBlock.

◆ dxfInFields_R12()

virtual OdResult OdDbBlockReference::dxfInFields_R12 ( OdDbDxfFiler pFiler)
virtual

Reads the DXF R12 format data of this object.

Parameters
pFiler[in] Pointer to the filer from which data are to be read.
Remarks
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 dxfInFields_R12(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfOutFields_R12(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 OdDbEntity.

◆ dxfOut()

virtual void OdDbBlockReference::dxfOut ( OdDbDxfFiler pFiler) const
virtual

Writes the DXF format data of this object to the specified filer.

Parameters
pFiler[in] Pointer to the filer to which the data are to be written.
Remarks
This function calls this object's dxfOutFields(pFiler) function, writes any Xdata associated with this object.

Reimplemented from OdDbEntity.

◆ dxfOutFields()

virtual void OdDbBlockReference::dxfOutFields ( OdDbDxfFiler pFiler) const
virtual

Reads the DXF data of this object.

Parameters
pFiler[in] Pointer to the filer from which data are read.
Remarks
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 OdDbEntity.

Reimplemented in OdDbViewRepBlockReference, OdDbTable, and OdDbMInsertBlock.

◆ dxfOutFields_R12()

virtual void OdDbBlockReference::dxfOutFields_R12 ( 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
Returns the filer status. 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). 3) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.

Reimplemented from OdDbEntity.

◆ explodeGeometry()

OdResult OdDbBlockReference::explodeGeometry ( OdRxObjectPtrArray entitySet) const
virtual

Explodes this entity into a set of simpler entities.

Parameters
entitySet[in/out] Receives an array of pointers to the new entities.
Remarks
The newly created entities will be not database resident.
Returns

Returns eOk if successful, or an appropriate error code if not.
Remarks
Entities resulting from the explosion are appended to the specified array. The default implementation of this function calls subWorldDraw() and makes entities from geometry generated by subWorldDraw(). This function can be overridden in custom classes.

Reimplemented from OdDbEntity.

◆ explodeToBlock()

virtual OdResult OdDbBlockReference::explodeToBlock ( OdDbBlockTableRecord BlockRecord,
OdDbObjectIdArray ids = 0 
)
virtual

Explodes this entity into a set of simpler entities, and adds them to the specified block table record.

Parameters
BlockRecord[out] Pointer to the Block Table Record.
ids[in/out] Receives an array of Object IDs of the new Block References.
Returns
Entities resulting from the explosion are appended to the specified array. The newly created entities are database resident or not depending on the block table record they are appended to. If block table record is database resident the entities are database resident as well. If block table record is not database resident newly created entities are not database resident. The default implementation of this function returns eNotApplicable. This function can be overridden in custom classes.

Reimplemented from OdDbEntity.

Reimplemented in OdDbMInsertBlock.

◆ explodeToOwnerSpace()

virtual OdResult OdDbBlockReference::explodeToOwnerSpace ( ) const
virtual

Explodes the current object and appends resulting entities to the block table record which owns the current OdDbBlockReference object that calls this method.

Remarks
The block reference entity must be in a database and must be uniformly scaled.

◆ geomExtentsBestFit()

OdResult OdDbBlockReference::geomExtentsBestFit ( OdGeExtents3d extents,
const OdGeMatrix3d parentXform = OdGeMatrix3d::kIdentity 
) const

This method gets copies of all entities in the referenced block table record, applies parentXform to them and after this calculates extents on the resulting object collection.

Parameters
extents[out] WCS extents of the block reference.
parentXform[in] Transformation matrix for block reference's geometry.

◆ getPlane()

virtual OdResult OdDbBlockReference::getPlane ( OdGePlane plane,
OdDb::Planarity planarity 
) const
virtual

Returns the plane that contains this entity.

Parameters
plane[out] Receives the plane that contains this entity.
planarity[out] Receives the planarity of this entity.
Returns
Returns eOk if successful, or an appropriate error code if not. planarity and plane return values as follows:
Value Description Plane kNonPlanar 0 Non-planar Not set kPlanar 1 Planar Entity plane kLinear 2 Linear Arbitrary plane containing this entity

Reimplemented from OdDbEntity.

◆ isPlanar()

virtual bool OdDbBlockReference::isPlanar ( ) const
inlinevirtual

Returns true if and only if there is a plane that contains the entity. In another case this method returns false.

Reimplemented from OdDbEntity.

Definition at line 152 of file DbBlockReference.h.

◆ normal()

OdGeVector3d OdDbBlockReference::normal ( ) const

Returns the WCS normal to the plane of this entity (DXF 210).

◆ ODDB_DECLARE_MEMBERS()

OdDbBlockReference::ODDB_DECLARE_MEMBERS ( OdDbBlockReference  )

◆ openAttribute()

OdDbAttributePtr OdDbBlockReference::openAttribute ( OdDbObjectId  ObjId,
OdDb::OpenMode  mode,
bool  openErasedOne = false 
)

Opens an attribute owned by this block reference.

Parameters
objId[in] Object ID of the attribute to be opened.
mode[in] Mode in which the attribute is to be opened.
openErasedOne[in] If and only if true, erased objects will be opened.
Returns
Returns a SmartPointer to the opened object if successful, otherwise a null SmartPointer.

◆ openSequenceEnd()

OdDbSequenceEndPtr OdDbBlockReference::openSequenceEnd ( OdDb::OpenMode  mode)

Opens the OdDbSequenceEnd entity for this block reference.

Parameters
mode[in] Mode in which to open the OdDbSequenceEnd entity.
Returns
Returns a SmartPointer to the newly opened OdDbSequenceEnd, or a null SmartPointer.
Remarks
This method is provided solely for applications that store XData on OdDbSequenceEnd entities; this is not recommended.

◆ position()

virtual OdGePoint3d OdDbBlockReference::position ( ) const
virtual

Returns the insertion point of this block reference (WCS equivalent of DXF 10).

Reimplemented in OdDbViewRepBlockReference.

◆ rotation()

double OdDbBlockReference::rotation ( ) const

Returns the rotation angle applied to this block reference (DXF 50).

Remarks
Rotation is about the Z axis, relative the X-axis, in the coordinate system parallel to this object's OCS, but with its origin at this object's insertion point.
All angles are expressed in radians.

◆ scaleFactors()

OdGeScale3d OdDbBlockReference::scaleFactors ( ) const

Returns the scale factors applied to this block reference (DXF 41, 42, 43).

◆ setBlockTableRecord()

virtual void OdDbBlockReference::setBlockTableRecord ( OdDbObjectId  objectId)
virtual

Sets the Object ID of the block table record associated with this OdDbBlockReference (DXF 2).

Parameters
objectId[in] Object ID of the block.

◆ setBlockTransform()

virtual OdResult OdDbBlockReference::setBlockTransform ( const OdGeMatrix3d xfm)
virtual

Sets the transformation matrix mapping a point in the MCS to the WCS.

Parameters
xfm[in] Any 3D transformation matrix.
Remarks
The Microspace Coordinate System (MCS) is the WCS within the block definition. Applying this matrix to the center of an arc within the block definition returns the center of the arc as it appears in the block reference.

◆ setNormal()

virtual void OdDbBlockReference::setNormal ( const OdGeVector3d normal)
virtual

Sets the WCS normal to the plane of this entity (DXF 210).

Parameters
normal[in] Normal.

◆ setPosition()

virtual void OdDbBlockReference::setPosition ( const OdGePoint3d position)
virtual

Sets the insertion point of this block reference. (WCS equivalent of DXF 10.)

Parameters
position[in] Any 3D point.

◆ setRotation()

virtual void OdDbBlockReference::setRotation ( double  angle)
virtual

Sets the rotation angle to be applied to this block reference, in radians (DXF 50).

Remarks
Rotation is about the Z axis, relative the X-axis, in the coordinate system parallel to this object's OCS, but with its origin at this object's insertion point.
Parameters
angle[in] Rotation angle.
Remarks
All angles are expressed in radians.

Reimplemented in OdDbTable.

◆ setScaleFactors()

virtual void OdDbBlockReference::setScaleFactors ( const OdGeScale3d scale)
virtual

Sets the scale factors to be applied to this block reference (DXF 41, 42, 43).

Parameters
scale[in] Any 3D scale factor.

Throws:

Cause eInvalidInput One or more scale factors is 0

◆ subClose()

void OdDbBlockReference::subClose ( )
virtual

Called as the first operation as this object is being closed, for database-resident objects only.

Remarks
This function is notified just before the current open operation is to be closed, giving this function the ability to perform necessary operations. When overriding this function: 1) If the OdDbObject's state is incorrect, throw exception. 2) Call parent class's subClose(). 3) If other actions are required before close, do them. The default implementation of this function does nothing. This function can be overridden in custom classes.

Reimplemented from OdDbObject.

Reimplemented in OdDbTable.

◆ subExplode()

virtual OdResult OdDbBlockReference::subExplode ( OdRxObjectPtrArray entitySet) const
virtual

Explodes this entity into a set of simpler entities.

Parameters
entitySet[in] Receives an array of pointers to the new entities.
Returns
Returns eOk if successful, or an appropriate error code if not.

Reimplemented from OdDbEntity.

Reimplemented in OdDbTable, and OdDbMInsertBlock.

◆ subGetClassID()

virtual OdResult OdDbBlockReference::subGetClassID ( void pClsid) const
virtual

Overridables

Reimplemented from OdDbEntity.

Reimplemented in OdDbTable, and OdDbMInsertBlock.

◆ subGetCompoundObjectTransform()

ODRX_SEALED_VIRTUAL OdResult OdDbBlockReference::subGetCompoundObjectTransform ( OdGeMatrix3d xM) const
virtual

Returns the transformation matrix of compound object.

Parameters
xM[out] Transformation matrix.
Returns
Returns eOk if successful, or an appropriate error code if not.

Reimplemented from OdDbEntity.

◆ subGetGeomExtents()

OdResult OdDbBlockReference::subGetGeomExtents ( OdGeExtents3d extents) const
virtual

This is subGetGeomExtents, a member of class OdDbBlockReference.

Parameters
extents[out] An output extents.

Reimplemented from OdDbEntity.

Reimplemented in OdDbViewRepBlockReference, OdDbTable, and OdDbMInsertBlock.

◆ subGetGsMarkersAtSubentPath()

ODRX_SEALED_VIRTUAL OdResult OdDbBlockReference::subGetGsMarkersAtSubentPath ( const OdDbFullSubentPath subPath,
OdGsMarkerArray gsMarkers 
) const
virtual

This is subGetGsMarkersAtSubentPath, a member of class OdDbBlockReference.

Parameters
subPath[in] Information needed to identify the subentity (or subentities).
gsMarkers[out] Array of Gs markers for the subentity or subentities.
Returns
Returns eOk if successful, or an appropriate error code if not.

Reimplemented from OdDbEntity.

Reimplemented in OdDbViewRepBlockReference.

◆ subGetSubentPathsAtGsMarker()

ODRX_SEALED_VIRTUAL OdResult OdDbBlockReference::subGetSubentPathsAtGsMarker ( OdDb::SubentType  type,
OdGsMarker  gsMark,
const OdGePoint3d pickPoint,
const OdGeMatrix3d viewXform,
OdDbFullSubentPathArray subentPaths,
const OdDbObjectIdArray pEntAndInsertStack 
) const
virtual

This is subGetSubentPathsAtGsMarker, a member of class OdDbBlockReference.

Parameters
type[in] Subentity type.
gsMark[in] Gs marker representing a subentity.
pickPoint[in] WCS point picked during selection of the entity.
viewXform[in] Transformation matrix to transform from WCS to DCS.
subentPaths[out] Array of OdDbFullSubentPath objects.
pEntAndInsertStack[in] Array of object IDs of the objects which are the subcontainers of the subentity.
Returns
Returns eOk if successful, or an appropriate error code if not.

Reimplemented from OdDbEntity.

◆ subGetTransformedCopy()

virtual OdResult OdDbBlockReference::subGetTransformedCopy ( const OdGeMatrix3d xfm,
OdDbEntityPtr pCopy 
) const
virtual

This is subGetTransformedCopy, a member of class OdDbBlockReference.

Parameters
xfm[in] Input matrix for transforming the copy of the entity.
pCopy[out] Pointer to the transformed copy of the entity.

Reimplemented from OdDbEntity.

Reimplemented in OdDbTable.

◆ subHandOverTo()

void OdDbBlockReference::subHandOverTo ( OdDbObject pNewObject)
virtual

Called as the first operation of the handOverTo function.

Parameters
pNewObject[in] Pointer to the object with which to replace this object in the database.
Remarks
This function allows custom classes to populate the new object. Overriding this function in a child class allows a child instance to be notified each time an object is handed over. This function is notified just before an object is to be handed over; giving this function the ability to cancel the handover. When overriding this function: 1) If the OdDbObject's state is incorrect, throw exception. 2) Call parent class's subHandover(). 3) If other actions are required before handover, do them. The default implementation of this function does nothing. This function can be overridden in custom classes.

Reimplemented from OdDbObject.

◆ subSetAttributes()

OdUInt32 OdDbBlockReference::subSetAttributes ( OdGiDrawableTraits pTraits) const
virtual

Sets the values of this object's subentity traits, and returns with the calling object's subentity traits.

Parameters
pTraits[in] Pointer to the OdGiDrawableTraits object to be set.
Remarks
When overriding subSetAttributes(), you must OR (|) the return value of <base class>::subSetAttributes(pTraits) with any flags you add. A derived class may not remove flags for any reason. The default implementation does nothing but returns kDrawableNone. This function can be overridden in custom classes.

Reimplemented from OdDbEntity.

◆ subTransformBy()

virtual OdResult OdDbBlockReference::subTransformBy ( const OdGeMatrix3d xfm)
virtual

Applies the specified 3D transformation matrix to this entity.

Parameters
xfm[in] 3D transformation matrix.
Returns
Returns eOk if successful, or an appropriate error code if not.

Reimplemented from OdDbEntity.

Reimplemented in OdDbTable, and OdDbMInsertBlock.

◆ subViewportDraw()

virtual void OdDbBlockReference::subViewportDraw ( OdGiViewportDraw pVd) const
virtual

Computes the entity to produce the right appearance given each viewport's possibly different viewpoint of the entity.Draws an entity in layout viewports.

Parameters
pVd[in] Pointer to the OdGiViewportDraw object.

Reimplemented from OdDbEntity.

Reimplemented in OdDbViewRepBlockReference.

◆ subWorldDraw()

virtual bool OdDbBlockReference::subWorldDraw ( OdGiWorldDraw pWd) const
virtual

Returns true if the entity has no view-dependent graphics. In another case returns false.

Parameters
pWd[in] Pointer to the OdGiWorldDraw object.

Reimplemented from OdDbEntity.

Reimplemented in OdDbViewRepBlockReference, OdDbTable, and OdDbMInsertBlock.

◆ treatAsOdDbBlockRefForExplode()

virtual bool OdDbBlockReference::treatAsOdDbBlockRefForExplode ( ) const
virtual

This is treatAsOdDbBlockRefForExplode, a member of class OdDbBlockReference. Determines how the entity should be exploded.


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