DbProxyEntity.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 _OD_DB_PROXY_ENTITY_
#define _OD_DB_PROXY_ENTITY_
 
#include "TD_PackPush.h"
 
#include "DbEntity.h"
#include "IdArrays.h"
#include "DwgDeclareMembers.h"

class DBIO_EXPORT OdDbProxyEntity : public OdDbEntity
{
public:
  DWGMAP_DECLARE_MEMBERS(OdDbProxyEntity);
 
  OdDbProxyEntity();
 
  enum GraphicsMetafileType
  {
    kNoMetafile   = 0, // No bounding box or graphics (R13 drawing files only)
    kBoundingBox  = 1, // Bounding Box
    kFullGraphics = 2  // Full Graphics
  };

  virtual OdDbProxyEntity::GraphicsMetafileType graphicsMetafileType() const;
 
  virtual OdDbObjectPtr subDeepClone(OdDbIdMapping& ownerIdMap, OdDbObject*, bool bPrimary) const ODRX_OVERRIDE;
 
  virtual OdDbObjectPtr subWblockClone(OdDbIdMapping& ownerIdMap, OdDbObject*, bool bPrimary) const ODRX_OVERRIDE;
 
 /* Replace OdRxObjectPtrArray */
 
  virtual OdResult subExplode(
    OdRxObjectPtrArray& entitySet) const ODRX_OVERRIDE;
 
  /*
     virtual bool subGetGeomExtents(OdGeExtents3d& extents) const;
  */
 
  enum
  {
    kNoOperation                = 0x000,
    kEraseAllowed               = 0x001,
    kTransformAllowed           = 0x002,
    kColorChangeAllowed         = 0x004,
    kLayerChangeAllowed         = 0x008,
    kLinetypeChangeAllowed      = 0x010,
    kLinetypeScaleChangeAllowed = 0x020,
    kVisibilityChangeAllowed    = 0x040,
    kCloningAllowed             = 0x080,
    kLineWeightChangeAllowed    = 0x100,
    kPlotStyleNameChangeAllowed = 0x200,
    kDisableProxyWarning        = 0x400,
    kMaterialChangeAllowed      = 0x800,
    kAllButCloningAllowed       = 0xB7F,
    kAllAllowedBits             = 0xBFF
  };

  virtual int proxyFlags() const;

  bool eraseAllowed() const               { return GETBIT(proxyFlags(), kEraseAllowed); }
  bool transformAllowed() const           { return GETBIT(proxyFlags(), kTransformAllowed); }
  bool colorChangeAllowed() const         { return GETBIT(proxyFlags(), kColorChangeAllowed); }
  bool layerChangeAllowed() const         { return GETBIT(proxyFlags(), kLayerChangeAllowed); }
  bool linetypeChangeAllowed() const      { return GETBIT(proxyFlags(), kLinetypeChangeAllowed); }
  bool linetypeScaleChangeAllowed() const { return GETBIT(proxyFlags(), kLinetypeScaleChangeAllowed); }
  bool visibilityChangeAllowed() const    { return GETBIT(proxyFlags(), kVisibilityChangeAllowed); }
  bool lineWeightChangeAllowed() const    { return GETBIT(proxyFlags(), kLineWeightChangeAllowed); }
  bool plotStyleNameChangeAllowed() const { return GETBIT(proxyFlags(), kPlotStyleNameChangeAllowed); }
  bool materialChangeAllowed() const    { return GETBIT(proxyFlags(), kMaterialChangeAllowed); }
  bool cloningAllowed() const             { return GETBIT(proxyFlags(), kCloningAllowed); }
  bool allButCloningAllowed() const       { return (proxyFlags() & kAllAllowedBits) == (kAllAllowedBits ^ kAllButCloningAllowed); }
  bool allOperationsAllowed() const       { return (proxyFlags() & kAllAllowedBits) == kAllAllowedBits; }

  bool isR13FormatProxy() const           { return GETBIT(proxyFlags(), 0x8000); }

  virtual OdString originalClassName() const;

  virtual OdString originalDxfName() const;

  virtual OdString applicationDescription() const;

  virtual void getReferences(
    OdTypedIdsArray& objectIds) const;
 
  virtual OdResult dwgInFields(
    OdDbDwgFiler* pFiler);
 
  virtual void dwgOutFields(
    OdDbDwgFiler* pFiler) const;
 
  virtual OdResult dxfInFields(
    OdDbDxfFiler* pFiler);
 
  virtual void dxfOutFields(
    OdDbDxfFiler* pFiler) const;
 
  OdResult dxfIn(
    OdDbDxfFiler* pFiler);
 
  virtual OdResult subTransformBy(
    const OdGeMatrix3d& xfm) ODRX_OVERRIDE;

  
  virtual OdResult setColor(
    const OdCmColor &color, 
    bool doSubents = true);
  virtual OdResult setColorIndex(
    OdUInt16 colorIndex, 
    bool doSubents = true);
  virtual OdResult setColorId(
    OdDbObjectId colorId, 
    bool doSubents = true);
  virtual OdResult setPlotStyleName(
    const OdString& plotStyleName, 
    bool doSubents = true);
  virtual OdResult setPlotStyleName(
    OdDb::PlotStyleNameType plotStyleNameType, 
    OdDbObjectId newId = OdDbObjectId::kNull, 
    bool doSubents = true);
  virtual OdResult setLayer(
    const OdString& layerName, 
    bool doSubents = true,
    bool allowHiddenLayer = false);
  virtual OdResult setLayer(
    OdDbObjectId layerId, 
    bool doSubents = true,
    bool allowHiddenLayer = false);
  virtual OdResult setLinetype(
    const OdString& linetypeName, 
    bool doSubents = true);
  virtual OdResult setLinetype(
    OdDbObjectId linetypeID, 
    bool doSubents = true);
  virtual OdResult setLinetypeScale(
    double linetypeScale, 
    bool doSubents = true);
  virtual OdResult subSetVisibility(
    OdDb::Visibility visibility, 
    bool doSubents = true);
  virtual OdResult setLineWeight(
    OdDb::LineWeight lineWeight, 
    bool doSubents = true);

  virtual OdResult setMaterial(
    const OdString& materialName,
    bool doSubents = true);
  virtual OdResult setMaterial(
    OdDbObjectId materialID,
    bool doSubents = true);
 
  virtual OdResult subErase(
    bool erasing);
};

typedef OdSmartPtr<OdDbProxyEntity> OdDbProxyEntityPtr;
 
#include "TD_PackPop.h"
 
#endif