| 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_PriorityList.hxx> |
| 20 | #include <OpenGl_Layer.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; |
| 45 | |
| 46 | //! Number of displayed structures |
| 47 | Standard_Integer NbStructures () const; |
| 48 | |
| 49 | //! Insert a new layer with id. |
| 50 | void AddLayer (const Standard_Integer theLayerId); |
| 51 | |
| 52 | //! Check whether the layer with given id is already created. |
| 53 | Standard_Boolean HasLayer (const Standard_Integer theLayerId) const; |
| 54 | |
| 55 | //! Remove layer by its id. |
| 56 | void RemoveLayer (const Standard_Integer 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 *theStructure, |
| 62 | const Standard_Integer theLayerId, |
| 63 | const Standard_Integer thePriority); |
| 64 | |
| 65 | //! Remove structure from structure list and return its previous priority |
| 66 | void RemoveStructure (const OpenGl_Structure *theStructure, |
| 67 | const Standard_Integer theZLayerId); |
| 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 Standard_Integer theOldLayerId, |
| 74 | const Standard_Integer theNewLayerId); |
| 75 | |
| 76 | //! Returns reference to the layer with given ID. |
| 77 | OpenGl_Layer& Layer (const Standard_Integer theLayerId); |
| 78 | |
| 79 | //! Returns reference to the layer with given ID. |
| 80 | const OpenGl_Layer& Layer (const Standard_Integer theLayerId) const; |
| 81 | |
| 82 | //! Render this element |
| 83 | void Render (const Handle(OpenGl_Workspace) &theWorkspace) const; |
| 84 | |
| 85 | //! Returns the set of OpenGL Z-layers. |
| 86 | const OpenGl_SequenceOfLayers& Layers() const { return myLayers; } |
| 87 | |
| 88 | //! Returns structure modification state (for ray-tracing). |
| 89 | Standard_Size ModificationState() const { return myModificationState; } |
| 90 | |
| 91 | private: |
| 92 | |
| 93 | //! Get default layer |
| 94 | OpenGl_Layer& defaultLayer (); |
| 95 | |
| 96 | protected: |
| 97 | |
| 98 | // number of structures temporary put to default layer |
| 99 | OpenGl_SequenceOfLayers myLayers; |
| 100 | OpenGl_LayerSeqIds myLayerIds; |
| 101 | Standard_Integer myNbPriorities; |
| 102 | Standard_Integer myNbStructures; |
| 103 | |
| 104 | mutable Standard_Size myModificationState; |
| 105 | |
| 106 | public: |
| 107 | DEFINE_STANDARD_ALLOC |
| 108 | }; |
| 109 | |
| 110 | #endif //_OpenGl_LayerList_Header |