AcDbObject.h

Go to the documentation of this file.

#pragma once
 
//
// (C) Copyright 2005-2024 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#include "..\acdb17\AcGiDrawable.h"
#include "..\acdb17\AcDb.h"
#include "..\acad\Acad.h"
 
template < typename Param1 > class AcArrayMemCopyReallocator;
class AcDbAuditInfo;
class AcDbDatabase;
class AcDbDictionary;
class AcDbDwgFiler;
class AcDbDxfFiler;
class AcDbEntity;
class AcDbField;
class AcDbHandle;
class AcDbIdMapping;
class AcDbObjectId;
class AcDbObjectReactor;
class AcDbSystemInternals;
class AcGeMatrix3d;
class AcGiDrawable;
class AcGiDrawableTraits;
class AcGiViewportDraw;
class AcGiWorldDraw;
class AcGsNode;
class AcRxClass;
class AcRxObject;
class AcDbObjectImpl;
struct resbuf;
 
class ARX_API AcDbObject : public AcGiDrawable
{
public:
    ACRX_DECLARE_MEMBERS( AcDbObject );
 
    bool  hasFields(void)const ;
    bool  hasPersistentReactor( AcDbObjectId)const ;
    bool  hasSaveVersionOverride(void);
    bool  isUndoRecordingDisabled(void)const ;
    AcDbVoidPtrArray const *  reactors(void)const ;
    AcDbDatabase *  database(void)const ;
    AcDbDwgFiler *  undoFiler(void);
    AcDbObjectId  extensionDictionary(void)const ;
    AcDbObjectId  getFieldDictionary(void)const ;
    AcDbObjectId  objectId(void)const ;
    AcDbObjectId  ownerId(void)const ;
    Acad::ErrorStatus  cancel(void);
    Acad::ErrorStatus  close(void);
    Acad::ErrorStatus  closeAndPage(int = 0);
    Acad::ErrorStatus  createExtensionDictionary(void);
    Acad::ErrorStatus  downgradeOpen(void);
    Acad::ErrorStatus  downgradeToNotify(Adesk::Boolean);
    Acad::ErrorStatus  dwgIn( AcDbDwgFiler *);
    Acad::ErrorStatus  dwgOut( AcDbDwgFiler *)const ;
    Acad::ErrorStatus  dxfIn( AcDbDxfFiler *);
    Acad::ErrorStatus  dxfOut( AcDbDxfFiler *, Adesk::Boolean,unsigned char *)const ;
    Acad::ErrorStatus  erase(Adesk::Boolean = true);
    Acad::ErrorStatus  getBinaryData(wchar_t const *,long &,char * &)const ;
    Acad::ErrorStatus  getField(wchar_t const *, AcDbField * &, AcDb::OpenMode)const ;
    Acad::ErrorStatus  getField(wchar_t const *, AcDbObjectId &)const ;
    Acad::ErrorStatus  getFieldDictionary( AcDbDictionary * &, AcDb::OpenMode)const ;
    Acad::ErrorStatus  getObjectBirthVersion( AcDb::AcDbDwgVersion &, AcDb::MaintenanceReleaseVersion &);
    Acad::ErrorStatus  handOverTo( AcDbObject *, Adesk::Boolean = 1, Adesk::Boolean = 1);
    Acad::ErrorStatus  releaseExtensionDictionary(void);
    Acad::ErrorStatus  setBinaryData(wchar_t const *,long,char const *);
    Acad::ErrorStatus  swapIdWith( AcDbObjectId, Adesk::Boolean = 0, Adesk::Boolean = 0);
    Acad::ErrorStatus  upgradeFromNotify(Adesk::Boolean &);
    Acad::ErrorStatus  upgradeOpen(void);
    Acad::ErrorStatus  xDataTransformBy( AcGeMatrix3d const &);
    Adesk::Boolean  isAProxy(void)const ;
    Adesk::Boolean  isAcDbObjectIdsInFlux(void)const ;
    Adesk::Boolean  isCancelling(void)const ;
    Adesk::Boolean  isEraseStatusToggled(void)const ;
    Adesk::Boolean  isErased(void)const ;
    Adesk::Boolean  isModified(void)const ;
    Adesk::Boolean  isModifiedGraphics(void)const ;
    Adesk::Boolean  isModifiedXData(void)const ;
    Adesk::Boolean  isNewObject(void)const ;
    Adesk::Boolean  isNotifyEnabled(void)const ;
    Adesk::Boolean  isNotifying(void)const ;
    Adesk::Boolean  isReadEnabled(void)const ;
    Adesk::Boolean  isReallyClosing(void)const ;
    Adesk::Boolean  isTransactionResident(void)const ;
    Adesk::Boolean  isUndoing(void)const ;
    Adesk::Boolean isWriteEnabled(void)const ;
    virtual  ~AcDbObject(void);
    virtual  AcDbObjectId  id(void)const ;
    virtual  AcGiDrawable *  drawable(void);
    virtual  AcGsNode *  gsNode(void)const ;
    virtual  AcRxObject *  clone(void)const ;
    virtual  AcDb::DuplicateRecordCloning  mergeStyle(void)const ;
    virtual  Acad::ErrorStatus  applyPartialUndo( AcDbDwgFiler *, AcRxClass *);
    virtual  Acad::ErrorStatus  audit( AcDbAuditInfo *);
    virtual  Acad::ErrorStatus  copyFrom( AcRxObject const *);
    virtual  Acad::ErrorStatus  decomposeForSave( AcDb::AcDbDwgVersion, AcDbObject * &, AcDbObjectId &,int &);
    virtual  Acad::ErrorStatus  deepClone( AcDbObject *, AcDbObject * &, AcDbIdMapping &, Adesk::Boolean = 1)const ;
    virtual  Acad::ErrorStatus  dwgInFields( AcDbDwgFiler *);
    virtual  Acad::ErrorStatus  dwgOutFields( AcDbDwgFiler *)const ;
    virtual  Acad::ErrorStatus  dxfInFields( AcDbDxfFiler *);
    virtual  Acad::ErrorStatus  dxfOutFields( AcDbDxfFiler *)const ;
    virtual  Acad::ErrorStatus  getClassID( _GUID *)const ;
    virtual  Acad::ErrorStatus  getObjectSaveVersion( AcDbDwgFiler const *, AcDb::AcDbDwgVersion &, AcDb::MaintenanceReleaseVersion &);
    virtual  Acad::ErrorStatus  getObjectSaveVersion( AcDbDxfFiler const *, AcDb::AcDbDwgVersion &, AcDb::MaintenanceReleaseVersion &);
    virtual  Acad::ErrorStatus  removeField( AcDbObjectId);
    virtual  Acad::ErrorStatus  removeField(wchar_t const *);
    virtual  Acad::ErrorStatus  removeField(wchar_t const *, AcDbObjectId &);
    virtual  Acad::ErrorStatus  removePersistentReactor( AcDbObjectId);
    virtual  Acad::ErrorStatus  setField(wchar_t const *, AcDbField *, AcDbObjectId &);
    virtual  Acad::ErrorStatus  setOwnerId( AcDbObjectId);
    virtual  Acad::ErrorStatus  setXData( resbuf const *);
    virtual  Acad::ErrorStatus  subCancel(void);
    virtual  Acad::ErrorStatus  subClose(void);
    virtual  Acad::ErrorStatus  subErase(Adesk::Boolean);
    virtual  Acad::ErrorStatus  subHandOverTo( AcDbObject *);
    virtual  Acad::ErrorStatus  subOpen( AcDb::OpenMode);
    virtual  Acad::ErrorStatus  subSwapIdWith( AcDbObjectId, Adesk::Boolean = 0, Adesk::Boolean = 0);
    virtual  Acad::ErrorStatus  swapReferences( AcDbIdMapping const &);
    virtual  Acad::ErrorStatus  wblockClone( AcRxObject *, AcDbObject * &, AcDbIdMapping &, Adesk::Boolean = 1)const ;
    virtual  Adesk::UInt32 subSetAttributes( AcGiDrawableTraits* pTraits );
    virtual void subViewportDraw( AcGiViewportDraw *);
    virtual Adesk::Boolean  isPersistent(void)const ;
    virtual Adesk::Boolean  worldDraw( AcGiWorldDraw *);
    virtual  resbuf * xData(wchar_t const * = NULL)const;
    virtual unsigned long  setAttributes( AcGiDrawableTraits *);
    virtual void  addPersistentReactor( AcDbObjectId);
    virtual void  cancelled( AcDbObject const *);
    virtual void  copied( AcDbObject const *, AcDbObject const *);
    virtual void  erased( AcDbObject const *,Adesk::Boolean);
    virtual void  goodbye( AcDbObject const *);
    virtual void  modified( AcDbObject const *);
    virtual void  modifiedGraphics( AcDbEntity const *);
    virtual void  modifiedXData( AcDbObject const *);
    virtual void  modifyUndone( AcDbObject const *);
    virtual void  objectClosed( AcDbObjectId const );
    virtual void  openedForModify( AcDbObject const *);
    virtual void  reappended( AcDbObject const *);
    virtual void  recvPropagateModify( AcDbObject const *);
    virtual void  setGsNode( AcGsNode *);
    virtual void  subObjModified( AcDbObject const *, AcDbObject const *);
    virtual void  unappended( AcDbObject const *);
    virtual void  viewportDraw( AcGiViewportDraw *);
    virtual void  xmitPropagateModify(void)const ;
    void  addReactor( AcDbObjectReactor *)const ;
    void  assertNotifyEnabled(void)const ;
    void  assertReadEnabled(void)const ;
    void  assertWriteEnabled(Adesk::Boolean = 1, Adesk::Boolean = 1);
    void  disableUndoRecording(Adesk::Boolean);
    void  getAcDbHandle( AcDbHandle &)const ;
    void  removeReactor( AcDbObjectReactor *)const ;
    void  setAcDbObjectIdsInFlux(void);
    void  setHasSaveVersionOverride(bool);
 
    virtual Adesk::Boolean subWorldDraw( AcGiWorldDraw * );
    virtual Acad::ErrorStatus subDeepClone(AcDbObject *, AcDbObject * &, AcDbIdMapping &, Adesk::Boolean = 1)const;
    virtual Acad::ErrorStatus subWblockClone(AcRxObject *, AcDbObject * &, AcDbIdMapping &, Adesk::Boolean = 1)const;
    virtual Acad::ErrorStatus subGetClassID(_GUID *)const;
 
protected:
    AcDbObject( AcDbSystemInternals *);
    AcDbObject(void);
 
friend class AcDbObjectImpl;
protected:
    AcDbObjectImpl* m_pImpl;
};