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 class Handle(OpenGl_Workspace);
  29
  30 typedef NCollection_Sequence<OpenGl_Layer> OpenGl_SequenceOfLayers;
  31 typedef NCollection_DataMap<int, int> OpenGl_LayerSeqIds;
  32
  33 class OpenGl_LayerList
  34 {
  35 public:
  36
  37   //! Constructor
  38   OpenGl_LayerList (const Standard_Integer theNbPriorities = 11);
  39
  40   //! Destructor
  41   virtual ~OpenGl_LayerList();
  42
  43   //! Method returns the number of available priorities
  44   Standard_Integer NbPriorities() const { return myNbPriorities; }
  45
  46   //! Number of displayed structures
  47   Standard_Integer NbStructures() const { return myNbStructures; }
  48
  49   //! Return number of structures within immediate layers
  50   Standard_Integer NbImmediateStructures() const { return myImmediateNbStructures; }
  51
  52   //! Insert a new layer with id.
  53   void AddLayer (const Graphic3d_ZLayerId theLayerId);
  54
  55   //! Remove layer by its id.
  56   void RemoveLayer (const Graphic3d_ZLayerId theLayerId);
  57
  58   //! Add structure to list with given priority. The structure will be inserted
  59   //! to specified layer. If the layer isn't found, the structure will be put
  60   //! to default bottom-level layer.
  61   void AddStructure (const OpenGl_Structure*  theStruct,
  62                      const Graphic3d_ZLayerId theLayerId,
  63                      const Standard_Integer   thePriority,
  64                      Standard_Boolean        isForChangePriority = Standard_False);
  65
  66   //! Remove structure from structure list and return its previous priority
  67   void RemoveStructure (const Handle(Graphic3d_Structure)& theStructure);
  68
  69   //! Change structure z layer
  70   //! If the new layer is not presented, the structure will be displayed
  71   //! in default z layer
  72   void ChangeLayer (const OpenGl_Structure*  theStructure,
  73                     const Graphic3d_ZLayerId theOldLayerId,
  74                     const Graphic3d_ZLayerId theNewLayerId);
  75
  76   //! Changes structure priority within its ZLayer
  77   void ChangePriority (const OpenGl_Structure*  theStructure,
  78                        const Graphic3d_ZLayerId theLayerId,
  79                        const Standard_Integer   theNewPriority);
  80
  81   //! Returns reference to the layer with given ID.
  82   OpenGl_Layer& Layer (const Graphic3d_ZLayerId theLayerId);
  83
  84   //! Returns reference to the layer with given ID.
  85   const OpenGl_Layer& Layer (const Graphic3d_ZLayerId theLayerId) const;
  86
  87   //! Assign new settings to the layer.
  88   void SetLayerSettings (const Graphic3d_ZLayerId        theLayerId,
  89                          const Graphic3d_ZLayerSettings& theSettings);
  90
  91   //! Render this element
  92   void Render (const Handle(OpenGl_Workspace)& theWorkspace,
  93                const Standard_Boolean          theToDrawImmediate,
  94                const OpenGl_LayerFilter        theLayersToProcess) const;
  95
  96   //! Returns the set of OpenGL Z-layers.
  97   const OpenGl_SequenceOfLayers& Layers() const { return myLayers; }
  98
  99   //! Marks BVH tree for given priority list as dirty and
 100   //! marks primitive set for rebuild.
 101   void InvalidateBVHData (const Graphic3d_ZLayerId theLayerId);
 102
 103   //! Returns structure modification state (for ray-tracing).
 104   Standard_Size ModificationState() const { return myModificationState; }
 105
 106 protected:
 107
 108   // number of structures temporary put to default layer
 109   OpenGl_SequenceOfLayers myLayers;
 110   OpenGl_LayerSeqIds      myLayerIds;
 111
 112   Standard_Integer        myNbPriorities;
 113   Standard_Integer        myNbStructures;
 114   Standard_Integer        myImmediateNbStructures; //!< number of structures within immediate layers
 115
 116   mutable Standard_Size   myModificationState;
 117
 118 public:
 119
 120   DEFINE_STANDARD_ALLOC
 121
 122 };
 123
 124 #endif //_OpenGl_LayerList_Header