src/OpenGl/OpenGl_LayerList.hxx

   1 // Created on: 2012-02-02
   2 // Created by: Anton POLETAEV
   3 // Copyright (c) 2012-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef _OpenGl_LayerList_Header
  17 #define _OpenGl_LayerList_Header
  18
  19 #include <OpenGl_Layer.hxx>
  20 #include <OpenGl_LayerFilter.hxx>
  21
  22 #include <InterfaceGraphic_telem.hxx>
  23
  24 #include <NCollection_Sequence.hxx>
  25 #include <NCollection_DataMap.hxx>
  26
  27 class OpenGl_Structure;
  28
  29 typedef NCollection_Sequence<OpenGl_Layer> OpenGl_SequenceOfLayers;
  30 typedef NCollection_DataMap<int, int> OpenGl_LayerSeqIds;
  31
  32 class OpenGl_LayerList
  33 {
  34 public:
  35
  36   //! Constructor
  37   OpenGl_LayerList (const Standard_Integer theNbPriorities = 11);
  38
  39   //! Destructor
  40   virtual ~OpenGl_LayerList();
  41
  42   //! Method returns the number of available priorities
  43   Standard_Integer NbPriorities() const { return myNbPriorities; }
  44
  45   //! Number of displayed structures
  46   Standard_Integer NbStructures() const { return myNbStructures; }
  47
  48   //! Return number of structures within immediate layers
  49   Standard_Integer NbImmediateStructures() const { return myImmediateNbStructures; }
  50
  51   //! Insert a new layer with id.
  52   void AddLayer (const Graphic3d_ZLayerId theLayerId);
  53
  54   //! Remove layer by its id.
  55   void RemoveLayer (const Graphic3d_ZLayerId theLayerId);
  56
  57   //! Add structure to list with given priority. The structure will be inserted
  58   //! to specified layer. If the layer isn't found, the structure will be put
  59   //! to default bottom-level layer.
  60   void AddStructure (const OpenGl_Structure*  theStruct,
  61                      const Graphic3d_ZLayerId theLayerId,
  62                      const Standard_Integer   thePriority,
  63                      Standard_Boolean        isForChangePriority = Standard_False);
  64
  65   //! Remove structure from structure list and return its previous priority
  66   void RemoveStructure (const OpenGl_Structure* theStructure);
  67
  68   //! Change structure z layer
  69   //! If the new layer is not presented, the structure will be displayed
  70   //! in default z layer
  71   void ChangeLayer (const OpenGl_Structure*  theStructure,
  72                     const Graphic3d_ZLayerId theOldLayerId,
  73                     const Graphic3d_ZLayerId theNewLayerId);
  74
  75   //! Changes structure priority within its ZLayer
  76   void ChangePriority (const OpenGl_Structure*  theStructure,
  77                        const Graphic3d_ZLayerId theLayerId,
  78                        const Standard_Integer   theNewPriority);
  79
  80   //! Returns reference to the layer with given ID.
  81   OpenGl_Layer& Layer (const Graphic3d_ZLayerId theLayerId);
  82
  83   //! Returns reference to the layer with given ID.
  84   const OpenGl_Layer& Layer (const Graphic3d_ZLayerId theLayerId) const;
  85
  86   //! Assign new settings to the layer.
  87   void SetLayerSettings (const Graphic3d_ZLayerId        theLayerId,
  88                          const Graphic3d_ZLayerSettings& theSettings);
  89
  90   //! Render this element
  91   void Render (const Handle(OpenGl_Workspace)& theWorkspace,
  92                const Standard_Boolean          theToDrawImmediate,
  93                const OpenGl_LayerFilter        theLayersToProcess) const;
  94
  95   //! Returns the set of OpenGL Z-layers.
  96   const OpenGl_SequenceOfLayers& Layers() const { return myLayers; }
  97
  98   //! Returns the map of Z-layer IDs to indexes.
  99   const OpenGl_LayerSeqIds& LayerIDs() const { return myLayerIds; }
 100
 101   //! Marks BVH tree for given priority list as dirty and
 102   //! marks primitive set for rebuild.
 103   void InvalidateBVHData (const Graphic3d_ZLayerId theLayerId);
 104
 105   //! Returns structure modification state (for ray-tracing).
 106   Standard_Size ModificationState() const { return myModificationState; }
 107
 108 protected:
 109
 110   // number of structures temporary put to default layer
 111   OpenGl_SequenceOfLayers myLayers;
 112   OpenGl_LayerSeqIds      myLayerIds;
 113
 114   Standard_Integer        myNbPriorities;
 115   Standard_Integer        myNbStructures;
 116   Standard_Integer        myImmediateNbStructures; //!< number of structures within immediate layers
 117
 118   mutable Standard_Size   myModificationState;
 119
 120 public:
 121
 122   DEFINE_STANDARD_ALLOC
 123
 124 };
 125
 126 #endif //_OpenGl_LayerList_Header