AcDbEntity.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\AcDbObject.h"
#include "..\acdb17\AcDb.h"
#include "..\acdb17\AcDbFullSubentPath.h"
#include "..\acad\Acad.h"
 
template < typename Param1 > class AcArrayMemCopyReallocator;
template < typename Param1 > class AcArrayObjectCopyReallocator;
class AcCmColor;
class AcCmEntityColor;
class AcCmTransparency;
class AcDbAuditInfo;
class AcDbDatabase;
class AcDbDwgFiler;
class AcDbDxfFiler;
class AcDbExtents;
class AcDbFullSubentPath;
class AcDbGripData;
class AcDbObjectId;
class AcDbSystemInternals;
class AcGeFastTransform;
class AcGeMatrix3d;
class AcGePlane;
class AcGePoint3d;
class AcGeVector3d;
class AcGiDrawable;
class AcGiDrawableTraits;
class AcGiMapper;
class AcGiViewportDraw;
class AcGiWorldDraw;
class AcGsNode;
class AcRxClass;
 
typedef AcArray< AcGePoint3d, AcArrayMemCopyReallocator< AcGePoint3d > > AcGePoint3dArray;
typedef AcArray< void*, AcArrayMemCopyReallocator< void* > >AcDbVoidPtrArray;
typedef AcArray< int, AcArrayMemCopyReallocator< int > > AcDbIntArray;
 
class ARX_API AcDbEntity : public AcDbObject
{
public:
 
    enum VisualStyleType {
        kFullVisualStyle,
        kFaceVisualStyle,
        kEdgeVisualStyle
    };
 
    ACRX_DECLARE_MEMBERS( AcDbEntity );
 
          AcCmColor  color(void)const ;
          AcCmEntityColor  entityColor(void)const ;
          AcCmTransparency  transparency(void)const ;
          AcDbObjectId  blockId(void)const ;
          AcDbObjectId  layerId(void)const ;
          AcDbObjectId  linetypeId(void)const ;
          AcDbObjectId  materialId(void)const ;
         double  linetypeScale(void)const ;
          AcDb::LineWeight  lineWeight(void)const ;
          AcDb::PlotStyleNameType  getPlotStyleNameId( AcDbObjectId &)const ;
          AcDb::Visibility  visibility(void)const ;
          Acad::ErrorStatus  boundingBoxIntersectWith( AcDbEntity const *, AcDb::Intersect, AcGePoint3dArray &, Adesk::GsMarker, Adesk::GsMarker)const ;
          Acad::ErrorStatus  boundingBoxIntersectWith( AcDbEntity const *, AcDb::Intersect, AcGePlane const &, AcGePoint3dArray &, Adesk::GsMarker, Adesk::GsMarker)const ;
          Acad::ErrorStatus  draw(void);
          Acad::ErrorStatus  setPropertiesFrom( AcDbEntity const *,int=1);
         unsigned short  colorIndex(void)const ;
         virtual bool  castShadows(void)const ;
         virtual bool  hideMeForDragging(void)const ;
         virtual bool  receiveShadows(void)const ;
         virtual  AcDbEntity *  subentPtr( AcDbFullSubentPath const &)const ;
         virtual  AcGiDrawable *  drawable(void);
         virtual  AcGsNode *  gsNode(void)const ;
         virtual  AcDb::CollisionType  collisionType(void)const ;
         virtual  Acad::ErrorStatus  addSubentPaths( AcDbFullSubentPathArray const &);
         virtual  Acad::ErrorStatus  applyPartialUndo( AcDbDwgFiler *, AcRxClass *);
         virtual  Acad::ErrorStatus  audit( AcDbAuditInfo *);
         virtual  Acad::ErrorStatus  deleteSubentPaths( AcDbFullSubentPathArray 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  explode( AcDbVoidPtrArray &)const ;
     virtual  Acad::ErrorStatus  copyFrom(AcRxObject const *);
         virtual  Acad::ErrorStatus  getClassID( _GUID *)const ;
         virtual  Acad::ErrorStatus  getCompoundObjectTransform( AcGeMatrix3d &)const ;
         virtual  Acad::ErrorStatus  getGeomExtents( AcDbExtents &)const ;
         virtual  Acad::ErrorStatus  getGripEntityUCS(void const *, AcGeVector3d &, AcGePoint3d &, AcGeVector3d &)const ;
         virtual  Acad::ErrorStatus  getGripPoints( AcDbGripDataPtrArray&, const double, const int, AcGeVector3d const &, const int)const ;
         virtual  Acad::ErrorStatus  getGripPoints( AcGePoint3dArray &, AcGeIntArray &, AcGeIntArray &)const ;
         virtual  Acad::ErrorStatus  getGripPointsAtSubentPath( AcDbFullSubentPath const &, AcDbGripDataPtrArray&,double,int, AcGeVector3d const &,int)const ;
         virtual  Acad::ErrorStatus  getGsMarkersAtSubentPath( AcDbFullSubentPath const &, AcArray<Adesk::GsMarker  , AcArrayMemCopyReallocator<Adesk::GsMarker > > &)const ;
         virtual  Acad::ErrorStatus  getMaterialMapper( AcGiMapper &)const ;
         virtual  Acad::ErrorStatus  getOsnapPoints( AcDb::OsnapMode, Adesk::GsMarker, AcGePoint3d const &, AcGePoint3d const &, AcGeFastTransform const &, AcGePoint3dArray &, AcGeIntArray &)const ;
         virtual  Acad::ErrorStatus  getOsnapPoints( AcDb::OsnapMode, Adesk::GsMarker, AcGePoint3d const &, AcGePoint3d const &, AcGeFastTransform const &, AcGePoint3dArray &, AcGeIntArray &, AcGeMatrix3d const &)const ;
         virtual  Acad::ErrorStatus  getOsnapPoints( AcDb::OsnapMode, Adesk::GsMarker, AcGePoint3d const &, AcGePoint3d const &, AcGeMatrix3d const &, AcGePoint3dArray &, AcGeIntArray &)const ;
         virtual  Acad::ErrorStatus  getOsnapPoints( AcDb::OsnapMode, Adesk::GsMarker, AcGePoint3d const &, AcGePoint3d const &, AcGeMatrix3d const &, AcGePoint3dArray &, AcGeIntArray &, AcGeMatrix3d const &)const ;
         virtual  Acad::ErrorStatus  getStretchPoints( AcGePoint3dArray &)const ;
         virtual  Acad::ErrorStatus  getSubentClassId( AcDbFullSubentPath const &, _GUID *)const ;
         virtual  Acad::ErrorStatus  getSubentPathGeomExtents( AcDbFullSubentPath const &, AcDbExtents &)const ;
         virtual  Acad::ErrorStatus  getSubentPathsAtGsMarker(unsigned long, Adesk::GsMarker, AcGePoint3d const &, AcGeFastTransform const &,int &, AcDbFullSubentPath * &,int = 0, AcDbObjectId * = nullptr)const ;
         virtual  Acad::ErrorStatus  getSubentPathsAtGsMarker(AcDb::SubentType,Adesk::GsMarker, AcGePoint3d const &, AcGeMatrix3d const &,int &, AcDbFullSubentPath * &,int=0, AcDbObjectId * = NULL)const ;
         virtual  Acad::ErrorStatus  getTransformedCopy( AcGeMatrix3d const &, AcDbEntity * &)const ;
         virtual  Acad::ErrorStatus  highlight( AcDbFullSubentPath const & = ::kNullSubent, Adesk::Boolean = 0 )const ;
         virtual  Acad::ErrorStatus  intersectWith( AcDbEntity const *, AcDb::Intersect, AcGePoint3dArray &, Adesk::GsMarker = 0, Adesk::GsMarker = 0)const ;
         virtual  Acad::ErrorStatus  intersectWith( AcDbEntity const *, AcDb::Intersect, AcGePlane const &, AcGePoint3dArray &, Adesk::GsMarker = 0, Adesk::GsMarker = 0)const ;
         virtual  Acad::ErrorStatus  moveGripPointsAt( AcGeIntArray const &, AcGeVector3d const &);
         virtual  Acad::ErrorStatus  moveGripPointsAt( AcDbVoidPtrArray const &, AcGeVector3d const &, const int);
         virtual  Acad::ErrorStatus  moveGripPointsAtSubentPaths( AcDbFullSubentPathArray const &, AcDbVoidPtrArray const &, AcGeVector3d const &,int);
         virtual  Acad::ErrorStatus  moveStretchPointsAt( AcGeIntArray const &, AcGeVector3d const &);
         virtual  Acad::ErrorStatus  setColor( AcCmColor const &,Adesk::Boolean = 1);
         virtual  Acad::ErrorStatus  setColorIndex(unsigned short, Adesk::Boolean = 1 );
         virtual  Acad::ErrorStatus  setLayer( AcDbObjectId, Adesk::Boolean = true,bool = false );
         virtual  Acad::ErrorStatus  setLayer(wchar_t const *, Adesk::Boolean = true,bool = false);
         virtual  Acad::ErrorStatus  setLineWeight( AcDb::LineWeight, Adesk::Boolean = true);
         virtual  Acad::ErrorStatus  setLinetype( AcDbObjectId, Adesk::Boolean = true);
         virtual  Acad::ErrorStatus  setLinetype(wchar_t const *, Adesk::Boolean = true);
         virtual  Acad::ErrorStatus  setLinetypeScale(double, Adesk::Boolean = true);
         virtual  Acad::ErrorStatus  setMaterial( AcDbObjectId, Adesk::Boolean = true);
         virtual  Acad::ErrorStatus  setMaterial(wchar_t const *, Adesk::Boolean = true);
         virtual  Acad::ErrorStatus  setMaterialMapper( AcGiMapper const &, Adesk::Boolean = true);
         virtual  Acad::ErrorStatus  setPlotStyleName( AcDb::PlotStyleNameType, AcDbObjectId = AcDbObjectId::kNull, Adesk::Boolean = 1);
         virtual  Acad::ErrorStatus  setPlotStyleName(wchar_t const *, Adesk::Boolean = 1);
         virtual  Acad::ErrorStatus  setTransparency( AcCmTransparency const &, Adesk::Boolean = 1);
         virtual  Acad::ErrorStatus  setVisibility( AcDb::Visibility, Adesk::Boolean = 1);
         virtual  Acad::ErrorStatus  transformBy( AcGeFastTransform const &);
         virtual  Acad::ErrorStatus  transformBy( AcGeMatrix3d const &);
         virtual  Acad::ErrorStatus  transformSubentPathsBy( AcDbFullSubentPathArray const &, AcGeMatrix3d const &);
         virtual  Acad::ErrorStatus  unhighlight( AcDbFullSubentPath const & = ::kNullSubent, const Adesk::Boolean = 0 )const ;
         virtual Adesk::Boolean  cloneMeForDragging(void);
         virtual Adesk::Boolean  worldDraw( AcGiWorldDraw *);
         virtual unsigned long  setAttributes( AcGiDrawableTraits *);
         virtual void  dragStatus( AcDb::DragStat);
         virtual void  getEcs( AcGeMatrix3d &)const ;
         virtual void  gripStatus( AcDb::GripStat);
         virtual void  list(void)const ;
         virtual void  saveAs( AcGiWorldDraw *, AcDb::SaveType);
         virtual void  setCastShadows(bool);
         virtual void  setGsNode( AcGsNode *);
         virtual void  setReceiveShadows(bool);
         virtual void  subSetDatabaseDefaults( AcDbDatabase *);
         virtual void  subentGripStatus( AcDb::GripStat, AcDbFullSubentPath const &);
         virtual void  viewportDraw( AcGiViewportDraw *);
         void  recordGraphicsModified(int = 1 );
         void  setDatabaseDefaults( AcDbDatabase *);
         void  setDatabaseDefaults(void);
         wchar_t *  layer(void)const ;
         wchar_t *  linetype(void)const ;
         wchar_t *  material(void)const ;
         wchar_t *  plotStyleName(void)const ;
 
     virtual Acad::ErrorStatus subGetOsnapPoints( AcDb::OsnapMode, Adesk::GsMarker, const AcGePoint3d&, const AcGePoint3d&, const AcGeMatrix3d&, AcGePoint3dArray&, AcDbIntArray & )const;
     virtual Acad::ErrorStatus subGetOsnapPoints( AcDb::OsnapMode, Adesk::GsMarker, const AcGePoint3d&, const AcGePoint3d&, const AcGeMatrix3d&, AcGePoint3dArray&, AcDbIntArray &, const AcGeMatrix3d& )const;
 
     virtual Acad::ErrorStatus subGetGripPoints( AcGePoint3dArray&, AcDbIntArray &, AcDbIntArray & )const;
     virtual Acad::ErrorStatus subGetGripPoints( AcDbGripDataPtrArray&,  const double, const int, const AcGeVector3d&, const int )const;
 
     virtual Acad::ErrorStatus subMoveGripPointsAt( const AcDbIntArray &, const AcGeVector3d& );
     virtual Acad::ErrorStatus subMoveGripPointsAt( const AcDbVoidPtrArray&, const AcGeVector3d&, const int );
 
     virtual Acad::ErrorStatus subGetStretchPoints(AcGePoint3dArray &) const;
     virtual Acad::ErrorStatus subMoveStretchPointsAt(AcDbIntArray const &, AcGeVector3d const &);
 
     virtual Acad::ErrorStatus subTransformBy(AcGeMatrix3d const &);
     virtual Acad::ErrorStatus subExplode(AcDbVoidPtrArray &)const;
 
     virtual Acad::ErrorStatus subGetGripPointsAtSubentPath(class AcDbFullSubentPath const &, class AcArray<class AcDbGripData *, class AcArrayMemCopyReallocator<class AcDbGripData * > > &, double, int, class AcGeVector3d const &, int)const;
     virtual Acad::ErrorStatus subMoveGripPointsAtSubentPaths(AcDbFullSubentPathArray const &, class AcArray<void *, class AcArrayMemCopyReallocator<void * > > const &, class AcGeVector3d const &, int);
 
         virtual Adesk::Boolean isPlanar(void)const ;
     virtual Acad::ErrorStatus getPlane(AcGePlane&, AcDb::Planarity&) const
        { return Acad::eNotApplicable; }
 
     virtual Acad::ErrorStatus subGetClassID( CLSID* pClsid ) const;
     virtual bool bounds( AcDbExtents& ) const;
     virtual Acad::ErrorStatus setVisualStyle( AcDbObjectId, AcDbEntity::VisualStyleType = kFullVisualStyle,int = true);
     virtual bool isContentSnappable(void)const;
         virtual Acad::ErrorStatus subSetVisibility(AcDb::Visibility, int);
     virtual Acad::ErrorStatus subGetTransformedCopy(AcGeMatrix3d const & param_1, AcDbEntity * & param_2)const;
     virtual Acad::ErrorStatus subGetGeomExtents( AcDbExtents & )const;
     virtual AcDb::Visibility subVisibility(void)const;
     virtual Acad::ErrorStatus subIntersectWith(AcDbEntity const *, AcDb::Intersect, AcGePlane const &, AcGePoint3dArray&, Adesk::GsMarker, Adesk::GsMarker)const;
     virtual Acad::ErrorStatus subIntersectWith(AcDbEntity const *, AcDb::Intersect, AcGePoint3dArray&, Adesk::GsMarker, Adesk::GsMarker)const;
     virtual Acad::ErrorStatus subGetSubentPathsAtGsMarker(AcDb::SubentType, Adesk::GsMarker, AcGePoint3d const &, AcGeMatrix3d const &, int &, AcDbFullSubentPath * &, int = 0, AcDbObjectId* = 0)const;
     virtual Acad::ErrorStatus subHighlight(AcDbFullSubentPath const & = kNullSubent, Adesk::Boolean const = 0)const;
     virtual Acad::ErrorStatus subUnhighlight(AcDbFullSubentPath const & = kNullSubent, Adesk::Boolean const = 0)const;
     virtual void subList(void)const;
     virtual Acad::ErrorStatus subGetGsMarkersAtSubentPath(AcDbFullSubentPath const &, AcArray<Adesk::GsMarker, AcArrayMemCopyReallocator<Adesk::GsMarker> > &)const;
 
     virtual Acad::ErrorStatus   setColor(const AcCmColor&, bool, AcDbDatabase *);
     Acad::ErrorStatus plotStyleName(AcString &) const;
     Acad::ErrorStatus layer(AcString &) const;
     Acad::ErrorStatus linetype(AcString &) const;
     Acad::ErrorStatus material(AcString &) const;
     AcDbObjectId visualStyleId(VisualStyleType = kFullVisualStyle) const;
protected:
          AcDbEntity( AcDbSystemInternals *);
          AcDbEntity(void);
 
      virtual bool subIsContentSnappable(void)const;
 
      virtual Adesk::Boolean subCloneMeForDragging(void);
      virtual bool subHideMeForDragging(void)const;
      virtual Acad::ErrorStatus subGetSubentClassId(AcDbFullSubentPath const & ,_GUID * )const;
      virtual Acad::ErrorStatus subAddSubentPaths(AcDbFullSubentPathArray const &);
      virtual Acad::ErrorStatus subDeleteSubentPaths(AcDbFullSubentPathArray const &);
      virtual Acad::ErrorStatus subTransformSubentPathsBy(AcDbFullSubentPathArray const &, AcGeMatrix3d const &);
      virtual Acad::ErrorStatus subGetSubentPathGeomExtents(AcDbFullSubentPath const &,class AcDbExtents &)const;
      virtual AcDbEntity * subSubentPtr(AcDbFullSubentPath const &)const;
      virtual void subGripStatus(const AcDb::GripStat);
      virtual void subSubentGripStatus(AcDb::GripStat,AcDbFullSubentPath const &);      
      virtual Acad::ErrorStatus subGetGripEntityUCS(void const *, AcGeVector3d &, AcGePoint3d &, AcGeVector3d & )const;
      virtual Acad::ErrorStatus subGetCompoundObjectTransform( AcGeMatrix3d & )const;
      virtual Acad::ErrorStatus subPushHighlight(AcDbFullSubentPath const &, AcGiHighlightStyle);
      virtual Acad::ErrorStatus subPopHighlight(AcDbFullSubentPath const &);
      virtual AcGiHighlightStyle subHighlightState(AcDbFullSubentPath const &);
 
public:
    virtual ~AcDbEntity(void);
};