DbGroup.h

Go to the documentation of this file.

// Copyright (C) 2002-2017, 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 Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2017 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 _ODDBGROUP_INCLUDED_
#define _ODDBGROUP_INCLUDED_
 
#include "TD_PackPush.h"
 
#include "DbObject.h"
 
class OdDbGroupIterator;
class OdCmColor;
class OdDbGroupImpl;
class OdDbGroup;
 
class TOOLKIT_EXPORT OdDbGroupIterator : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdDbGroupIterator);
 
  virtual OdDbObjectPtr getObject(
    OdDb::OpenMode openMode) = 0;
 
  virtual OdDbObjectId objectId() const = 0;
 
    virtual bool done() const = 0;
 
    virtual bool next() = 0;
 
  /*
     virtual OdResult subGetClassID(void* pClsid) const;
  */
protected:
  OdDbGroupIterator() {}
};
typedef OdSmartPtr<OdDbGroupIterator> OdDbGroupIteratorPtr;
 
class TOOLKIT_EXPORT OdDbGroup: public OdDbObject
{
public:
  ODDB_DECLARE_MEMBERS(OdDbGroup);
 
  OdDbGroup();
 
  OdDbGroupIteratorPtr newIterator();
 
  OdString description() const;
 
  void setDescription(
    const OdString& description);
 
  bool isSelectable() const;
 
  void setSelectable(
    bool selectable);
 
  OdString name() const;
 
  void setName(const OdString& name);
 
  bool isNotAccessible() const;
 
  bool isAnonymous() const;
 
  void setAnonymous();
 
  void append(
    OdDbObjectId objectId);
 
  void append(
    const OdDbObjectIdArray& objectIds);
 
  void prepend(
    OdDbObjectId objectId);
 
  void prepend(
    const OdDbObjectIdArray& objectIds);
 
  void insertAt(
    OdUInt32 insertionIndex, 
    OdDbObjectId objectId);
 
  void insertAt(
    OdUInt32 insertionIndex, 
    const OdDbObjectIdArray& objectIds);
 
  void remove(
    OdDbObjectId objectId);
 
  void removeAt(
    OdUInt32 entityIndex);
 
  void remove(
    const OdDbObjectIdArray& objectIds);
 
  void removeAt(
    OdUInt32 index, 
    const OdDbObjectIdArray& objectIds);
 
  void replace(
    OdDbObjectId oldId, 
    OdDbObjectId newId);
 
  void transfer(
    OdUInt32 fromIndex, 
    OdUInt32 toIndex, 
    OdUInt32 numItems);
 
  void clear();
 
  OdUInt32 numEntities() const;
 
  bool has(
    const OdDbEntity* pEntity) const;
 
  OdUInt32 allEntityIds(
    OdDbObjectIdArray& objectIds) const;
 
  void getIndex(
    OdDbObjectId objectId, 
    OdUInt32& index) const;
 
  void reverse();
 
  void setColorIndex(
    OdUInt16 colorIndex);
 
  void setColor(
    const OdCmColor& color);
 
  void setLayer(
    const OdString& layer);
 
  void setLayer(
    OdDbObjectId layerId);
 
  void setLinetype(
    const OdString& linetype);
 
  void setLinetype(
    OdDbObjectId linetypeID);
 
  void setLinetypeScale(
    double linetypeScale);
 
  void setVisibility(
    OdDb::Visibility visibility);
 
  void setPlotStyleName(
    const OdString& plotStyleName);
 
  void setLineweight(
    OdDb::LineWeight lineWeight);
 
  OdResult setHighlight(
    bool newVal);
  OdResult setMaterial( 
    const OdString& materialName);
  OdResult setMaterial(
    OdDbObjectId materialID);
 
  virtual OdResult dwgInFields(
    OdDbDwgFiler* pFiler);
 
  virtual void dwgOutFields(
    OdDbDwgFiler* pFiler) const;
 
  virtual OdResult dxfInFields(
    OdDbDxfFiler* pFiler);
 
  virtual void dxfOutFields(
    OdDbDxfFiler* pFiler) const;
 
  virtual void copied (
    const OdDbObject* pObject, 
    const OdDbObject* pNewObject);
 
  virtual void appendToOwner(
    OdDbIdPair& idPair, 
    OdDbObject* pOwnerObject, 
    OdDbIdMapping& ownerIdMap);
 
  virtual OdResult subGetClassID(
    void* pClsid) const;
 
  virtual void subClose() ODRX_OVERRIDE;
  virtual OdDbObjectPtr subWblockClone(OdDbIdMapping& ownerIdMap, OdDbObject*, bool bPrimary) const ODRX_OVERRIDE;
  virtual OdDbObjectPtr subDeepClone(OdDbIdMapping& ownerIdMap, OdDbObject*, bool bPrimary) const ODRX_OVERRIDE;
 
  /*
      void setHighlight(bool newVal);
      virtual void applyPartialUndo(OdDbDwgFiler* undoFiler, OdRxClass* classObj);
      virtual OdResult subErase(bool erasing = true);
      virtual void goodbye(const OdDbObject* dbObj);
  */
 
};
 
typedef OdSmartPtr<OdDbGroup> OdDbGroupPtr;
 
#include "TD_PackPop.h"
 
#endif //_ODDBGROUP_INCLUDED_