DbSortentsTable.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_DBSORTENTSTABLE_H
#define OD_DBSORTENTSTABLE_H
 
#include "TD_PackPush.h"
 
#include "DbObject.h"
 
#define STL_USING_UTILITY
#include "OdaSTL.h"

typedef std::pair<OdDbHandle, OdDbObjectId> HandlePair;

typedef OdArray<HandlePair, OdMemoryAllocator<HandlePair> > HandlePairsArray;
 

class TOOLKIT_EXPORT OdDbSortentsTable : public OdDbObject
{
public:
  ODDB_DECLARE_MEMBERS(OdDbSortentsTable);
 
  OdDbSortentsTable();

  void getSortHandle(const OdDbObjectId& id, OdDbHandle& h) const;

  void moveToBottom(
    const OdDbObjectIdArray& entityIds);

  void moveToTop(
    const OdDbObjectIdArray& entityIds);

  void moveBelow(
    const OdDbObjectIdArray& entityIds,
    OdDbObjectId targetId);

  void moveAbove(
    const OdDbObjectIdArray& entityIds, 
    OdDbObjectId targetId);

  void swapOrder(
    OdDbObjectId firstId, 
    OdDbObjectId secondId);

  OdDbObjectId  blockId() const; 
        

  bool firstEntityIsDrawnBeforeSecond(
    OdDbObjectId firstID, 
    OdDbObjectId secondID) const;

  void getFullDrawOrder(
    OdDbObjectIdArray& entityIds, 
    OdUInt8 honorSortentsMask = 0) const;

  void getRelativeDrawOrder(
    OdDbObjectIdArray& entityIds, 
    OdUInt8 honorSortentsMask = 0) const;
 

  void setRelativeDrawOrder(
    const OdDbObjectIdArray& entityIds);

  void setAbsoluteDrawOrder(
    const HandlePairsArray& handlePairs);

  void getAbsoluteDrawOrder(
    HandlePairsArray& handlePairs);
 
  virtual OdResult dwgInFields(
    OdDbDwgFiler* pFiler);
 
  virtual void dwgOutFields(
    OdDbDwgFiler* pFiler) const;
 
  virtual OdResult dxfInFields(
    OdDbDxfFiler* pFiler);
 
  virtual void dxfOutFields(
    OdDbDxfFiler* pFiler) const;
 
  virtual OdResult subGetClassID(
    void* pClsid) const;
 
  //FELIX_CHANGE_BEGIN
  // DESKTOP-91012: Consolidating common functionality into one
  private:
    void moveAround(
      const OdDbObjectIdArray& entityIds,
      OdDbObjectId targetId,
      bool movingAbove);
  //FELIX_CHANGE_END
};

typedef OdSmartPtr<OdDbSortentsTable> OdDbSortentsTablePtr;
 
//FELIX_CHANGE_BEGIN
//issue: 38372
TOOLKIT_EXPORT OdDbObjectId fxGetTop( OdDbSortentsTablePtr p, const OdDbObjectIdArray& objects );
TOOLKIT_EXPORT OdDbObjectId fxGetBottom( OdDbSortentsTablePtr p, const OdDbObjectIdArray& objects );
//FELIX_CHANGE_END
 
#include "TD_PackPop.h"
 
#endif //OD_DBSORTENTSTABLE_H