DbEntity.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef _ODDBENTITY_INCLUDED_
#define _ODDBENTITY_INCLUDED_ /* { Secret} */
 
#include "TD_PackPush.h"
 
#include "DbObject.h"
#include "Ge/GePoint3d.h"
#include "Ge/GeLine3d.h"
#include "Ge/GePlane.h"
#include "CmColor.h"
#include "IntArray.h"
#include "DbDatabase.h"
#include "DbSubentId.h"
#include "GsMarkerArray.h"
#include "DbGrip.h"
#include "OdaDefs.h"
 
class OdGePlane;
class OdGeMatrix3d;
class OdDbFullSubentPath;
class OdGePoint3d;
class OdGeVector3d;
class OdDbBlockTableRecord;

typedef OdSmartPtr<OdDbEntity> OdDbEntityPtr;

typedef OdArray<OdDbEntityPtr> OdDbEntityPtrArray;

namespace OdDb
{
 
  enum EntSaveAsType
  {
    kNoSave = 0,
    kSaveAsR12,
    kSaveAsR13,
    kSaveAsR14
  };
 
  enum Planarity
  {
    kNonPlanar = 0,
    kPlanar    = 1,
    kLinear    = 2
  };
}

class TOOLKIT_EXPORT OdDbEntity : public OdDbObject
{
public:
  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);
 
 
  enum VisualStyleType
  {
    kFullVisualStyle,
    kFaceVisualStyle,
    kEdgeVisualStyle
  };

  OdDbObjectId visualStyleId(
    VisualStyleType vstype = kFullVisualStyle) const;

  virtual OdResult setVisualStyle(
    OdDbObjectId visualStyleId,
    VisualStyleType vstype = kFullVisualStyle,
    bool doSubents = true);

  virtual const OdGiMapper* materialMapper() 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_FINAL;

  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);

  virtual bool isPlanar() const;

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

 
  void subHandOverTo(
    OdDbObject* pNewObject);

  ODRX_SEALED_VIRTUAL OdResult transformBy(
    const OdGeMatrix3d& xfm) ODRX_FINAL;

  ODRX_SEALED_VIRTUAL OdResult getTransformedCopy(
    const OdGeMatrix3d& xfm,
    OdDbEntityPtr& pCopy) const ODRX_FINAL;

  ODRX_SEALED_VIRTUAL OdResult explode(
    OdRxObjectPtrArray& entitySet) const ODRX_FINAL;

  virtual OdResult explodeToBlock(
    OdDbBlockTableRecord *pBlockRecord,
    OdDbObjectIdArray *ids = 0);

  virtual OdResult explodeGeometry(
    OdRxObjectPtrArray& entitySet) const;

  virtual OdResult explodeGeometryToBlock(
    OdDbBlockTableRecord *pBlockRecord,
    OdDbObjectIdArray *ids = 0);
 
  virtual bool subWorldDraw(OdGiWorldDraw* pWd) const;
 
  virtual void subViewportDraw(OdGiViewportDraw* pVd) const;

  void setDatabaseDefaults(
    OdDbDatabase* pDb = 0,
    bool doSubents = false);

  virtual void subSetDatabaseDefaults(
    OdDbDatabase* pDb,
    bool doSubents);
 
  virtual void applyPartialUndo(
    OdDbDwgFiler* pUndoFiler,
    OdRxClass* pClassObj);
 
  virtual OdResult dwgInFields(
    OdDbDwgFiler* pFiler);
 
  virtual void dwgOutFields(
    OdDbDwgFiler* pFiler) const;
 
  void appendToOwner(
    OdDbIdPair& idPair,
    OdDbObject* pOwnerObject,
    OdDbIdMapping& ownerIdMap);
 
  virtual OdResult dxfIn(
    OdDbDxfFiler* pFiler);
 
  virtual void dxfOut(
    OdDbDxfFiler* 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 OdGiDrawable* drawable();
 
  virtual OdUInt32 subSetAttributes(
    OdGiDrawableTraits* pTraits) const;
 
    virtual void subList() const;
    virtual OdResult subGetClassID(void* pClsid) const;

  void subSwapIdWith(
    const OdDbObjectId& otherId,
    bool swapXdata = false,
    bool swapExtDict = false);
 
   virtual OdResult subErase( bool erasing) ODRX_OVERRIDE;
 
   virtual OdResult subOpen(OdDb::OpenMode mode) ODRX_OVERRIDE;

  void recordGraphicsModified(bool graphicsModified = true);
 
  virtual void copyFrom(const OdRxObject* pSource);
 
/* No implementation
  Cause this entity, and any other entity who's draw bit is set, to be be drawn.
    void draw();
  */

  ODRX_SEALED_VIRTUAL void list() const ODRX_FINAL;
 
  virtual OdResult getGeomExtents(OdGeExtents3d& extents) const ODRX_FINAL;
 
  ODRX_SEALED_VIRTUAL void highlight(bool bDoIt = true, const OdDbFullSubentPath* pSubId = 0,
    bool highlightAll = false) const ODRX_FINAL;

  ODRX_SEALED_VIRTUAL OdResult getOsnapPoints(
    OdDb::OsnapMode osnapMode,
    OdGsMarker gsSelectionMark,
    const OdGePoint3d& pickPoint,
    const OdGePoint3d& lastPoint,
    const OdGeMatrix3d& xWorldToEye,
    OdGePoint3dArray& snapPoints ) const ODRX_FINAL;

  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_FINAL;
  
  ODRX_SEALED_VIRTUAL bool isContentSnappable() const ODRX_FINAL;

  ODRX_SEALED_VIRTUAL OdResult getGripPoints( OdGePoint3dArray& gripPoints ) const ODRX_FINAL;

  ODRX_SEALED_VIRTUAL OdResult moveGripPointsAt(
    const OdIntArray& indices,
    const OdGeVector3d& offset ) ODRX_FINAL;

  ODRX_SEALED_VIRTUAL OdResult getGripPoints(
    OdDbGripDataPtrArray& grips,
    const double curViewUnitSize,
    const int gripSize,
    const OdGeVector3d& curViewDir,
    const int bitFlags ) const ODRX_FINAL;

  ODRX_SEALED_VIRTUAL OdResult moveGripPointsAt(
    const OdDbVoidPtrArray& grips,
    const OdGeVector3d& offset,
    int bitFlags ) ODRX_FINAL;

  ODRX_SEALED_VIRTUAL OdResult getStretchPoints( OdGePoint3dArray& stretchPoints ) const ODRX_FINAL;

  ODRX_SEALED_VIRTUAL OdResult moveStretchPointsAt(
    const OdIntArray& indices,
    const OdGeVector3d& offset ) ODRX_FINAL;

  virtual void dragStatus( const OdDb::DragStat status );

  ODRX_SEALED_VIRTUAL void gripStatus( const OdDb::GripStat status ) ODRX_FINAL;

  ODRX_SEALED_VIRTUAL bool cloneMeForDragging() ODRX_FINAL;

  ODRX_SEALED_VIRTUAL bool hideMeForDragging() const ODRX_FINAL;

  virtual void saveAs(
    OdGiWorldDraw* pWd,
    OdDb::DwgVersion ver ) const;
 
 

  ODRX_SEALED_VIRTUAL OdResult getCompoundObjectTransform(OdGeMatrix3d & xM) const ODRX_FINAL;

  ODRX_SEALED_VIRTUAL OdResult intersectWith(const OdDbEntity* pEnt, OdDb::Intersect intType,
                             OdGePoint3dArray& points, OdGsMarker thisGsMarker = 0,
                             OdGsMarker otherGsMarker = 0) const ODRX_FINAL;

  ODRX_SEALED_VIRTUAL OdResult intersectWith(const OdDbEntity* pEnt, OdDb::Intersect intType,
                             const OdGePlane& projPlane, OdGePoint3dArray& points,
                             OdGsMarker thisGsMarker = 0, OdGsMarker otherGsMarker = 0) const ODRX_FINAL;

  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_FINAL;

 
  ODRX_SEALED_VIRTUAL OdResult getGsMarkersAtSubentPath( const OdDbFullSubentPath& subPath, 
    OdGsMarkerArray& gsMarkers) const ODRX_FINAL;

 
  ODRX_SEALED_VIRTUAL OdResult getGripPointsAtSubentPath( const OdDbFullSubentPath& path, OdDbGripDataPtrArray& grips,
                                                                                          const double curViewUnitSize, const int gripSize,
                        const OdGeVector3d& curViewDir, const OdUInt32 bitflags) const ODRX_FINAL;

 
  ODRX_SEALED_VIRTUAL OdResult moveGripPointsAtSubentPaths( const OdDbFullSubentPathArray& paths,
    const OdDbVoidPtrArray& gripAppData, const OdGeVector3d& offset, const OdUInt32 bitflags) ODRX_FINAL;

 
  ODRX_SEALED_VIRTUAL OdResult deleteSubentPaths(const OdDbFullSubentPathArray& paths) ODRX_FINAL;

 
  ODRX_SEALED_VIRTUAL OdResult addSubentPaths(const OdDbFullSubentPathArray& paths) ODRX_FINAL;

 
  ODRX_SEALED_VIRTUAL OdDbEntityPtr subentPtr(const OdDbFullSubentPath& path) const ODRX_FINAL;

 
  ODRX_SEALED_VIRTUAL OdResult transformSubentPathsBy(const OdDbFullSubentPathArray &paths, const OdGeMatrix3d & xform) ODRX_FINAL;

 
  ODRX_SEALED_VIRTUAL OdResult getSubentClassId( const OdDbFullSubentPath& path, void* clsId ) ODRX_FINAL;

 
  ODRX_SEALED_VIRTUAL OdResult getSubentPathGeomExtents( const OdDbFullSubentPath& path, OdGeExtents3d& extents ) ODRX_FINAL;
 
  ODRX_SEALED_VIRTUAL  void  subentGripStatus(OdDb::GripStat status, const OdDbFullSubentPath& subentity) ODRX_FINAL;
  
  virtual OdGeMatrix3d getEcs() const;
 
protected:
  virtual OdDbObjectPtr subWblockClone(OdDbIdMapping& ownerIdMap, OdDbObject*, bool bPrimary) const ODRX_OVERRIDE;
  virtual OdDbObjectPtr subDeepClone(OdDbIdMapping& ownerIdMap, OdDbObject*, bool bPrimary) const ODRX_OVERRIDE;
 
  virtual OdResult subTransformBy(
    const OdGeMatrix3d& xfm);
  virtual OdResult subGetTransformedCopy(
    const OdGeMatrix3d& xfm,
    OdDbEntityPtr& pCopy) const;
  virtual OdResult subExplode(
    OdRxObjectPtrArray& entitySet) const;
  virtual OdResult subGetCompoundObjectTransform(OdGeMatrix3d & xM) const;
 
  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 subGetGeomExtents(
      OdGeExtents3d& extents) const;
  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 OdResult subGetSubentPathsAtGsMarker(OdDb::SubentType type, OdGsMarker gsMark, 
    const OdGePoint3d& pickPoint,const OdGeMatrix3d& xfm, 
    OdDbFullSubentPathArray& subentPaths, 
    const OdDbObjectIdArray* pEntAndInsertStack = 0) const;
  virtual OdResult subGetGsMarkersAtSubentPath( const OdDbFullSubentPath& subPath, 
    OdGsMarkerArray& gsMarkers) 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);
 
  friend class OdDbPropertiesOverrule;
  friend class OdDbOsnapOverrule;
  friend class OdDbTransformOverrule;
  friend class OdDbGripOverrule;
  friend class OdDbSubentityOverrule;
  friend class OdDbHighlightOverrule;
  friend class OdDbVisibilityOverrule;
  friend class OdDbGeometryOverrule;
};
 
#include "TD_PackPop.h"
 
#endif /* _ODDBENTITY_INCLUDED_ */