0027961: Visualization - remove unused and no more working OpenGl_AVIWriter
[occt.git] / src / OpenGl / OpenGl_LayerList.hxx
CommitLineData
6aca4d39 1// Created on: 2012-02-02
b311480e 2// Created by: Anton POLETAEV
6aca4d39 3// Copyright (c) 2012-2014 OPEN CASCADE SAS
b311480e 4//
973c2be1 5// This file is part of Open CASCADE Technology software library.
b311480e 6//
d5f74e42 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
973c2be1 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.
b311480e 12//
973c2be1 13// Alternatively, this file may be used under the terms of Open CASCADE
14// commercial license or contractual agreement.
59f45b7c 15
16#ifndef _OpenGl_LayerList_Header
17#define _OpenGl_LayerList_Header
18
c5751993 19#include <OpenGl_Layer.hxx>
91c60b57 20#include <OpenGl_LayerFilter.hxx>
59f45b7c 21
59f45b7c 22#include <NCollection_Sequence.hxx>
23#include <NCollection_DataMap.hxx>
24
25class OpenGl_Structure;
59f45b7c 26
c5751993 27typedef NCollection_Sequence<OpenGl_Layer> OpenGl_SequenceOfLayers;
59f45b7c 28typedef NCollection_DataMap<int, int> OpenGl_LayerSeqIds;
29
bd6a8454 30//! Class defining the list of layers.
59f45b7c 31class OpenGl_LayerList
32{
a1954302 33public:
34
59f45b7c 35 //! Constructor
36 OpenGl_LayerList (const Standard_Integer theNbPriorities = 11);
a1954302 37
59f45b7c 38 //! Destructor
a1954302 39 virtual ~OpenGl_LayerList();
40
59f45b7c 41 //! Method returns the number of available priorities
a1954302 42 Standard_Integer NbPriorities() const { return myNbPriorities; }
59f45b7c 43
44 //! Number of displayed structures
a1954302 45 Standard_Integer NbStructures() const { return myNbStructures; }
46
47 //! Return number of structures within immediate layers
48 Standard_Integer NbImmediateStructures() const { return myImmediateNbStructures; }
59f45b7c 49
50 //! Insert a new layer with id.
a1954302 51 void AddLayer (const Graphic3d_ZLayerId theLayerId);
52
59f45b7c 53 //! Remove layer by its id.
a1954302 54 void RemoveLayer (const Graphic3d_ZLayerId theLayerId);
55
59f45b7c 56 //! Add structure to list with given priority. The structure will be inserted
57 //! to specified layer. If the layer isn't found, the structure will be put
58 //! to default bottom-level layer.
a1954302 59 void AddStructure (const OpenGl_Structure* theStruct,
60 const Graphic3d_ZLayerId theLayerId,
61 const Standard_Integer thePriority,
62 Standard_Boolean isForChangePriority = Standard_False);
63
59f45b7c 64 //! Remove structure from structure list and return its previous priority
c357e426 65 void RemoveStructure (const OpenGl_Structure* theStructure);
a1954302 66
59f45b7c 67 //! Change structure z layer
68 //! If the new layer is not presented, the structure will be displayed
69 //! in default z layer
a1954302 70 void ChangeLayer (const OpenGl_Structure* theStructure,
71 const Graphic3d_ZLayerId theOldLayerId,
72 const Graphic3d_ZLayerId theNewLayerId);
c5751993 73
b7cd4ba7 74 //! Changes structure priority within its ZLayer
a1954302 75 void ChangePriority (const OpenGl_Structure* theStructure,
76 const Graphic3d_ZLayerId theLayerId,
77 const Standard_Integer theNewPriority);
b7cd4ba7 78
c5751993 79 //! Returns reference to the layer with given ID.
a1954302 80 OpenGl_Layer& Layer (const Graphic3d_ZLayerId theLayerId);
c5751993 81
82 //! Returns reference to the layer with given ID.
a1954302 83 const OpenGl_Layer& Layer (const Graphic3d_ZLayerId theLayerId) const;
84
85 //! Assign new settings to the layer.
86 void SetLayerSettings (const Graphic3d_ZLayerId theLayerId,
87 const Graphic3d_ZLayerSettings& theSettings);
88
59f45b7c 89 //! Render this element
a1954302 90 void Render (const Handle(OpenGl_Workspace)& theWorkspace,
91c60b57 91 const Standard_Boolean theToDrawImmediate,
92 const OpenGl_LayerFilter theLayersToProcess) const;
e276548b 93
94 //! Returns the set of OpenGL Z-layers.
95 const OpenGl_SequenceOfLayers& Layers() const { return myLayers; }
e276548b 96
50d06d8f 97 //! Returns the map of Z-layer IDs to indexes.
98 const OpenGl_LayerSeqIds& LayerIDs() const { return myLayerIds; }
99
b7cd4ba7 100 //! Marks BVH tree for given priority list as dirty and
101 //! marks primitive set for rebuild.
a1954302 102 void InvalidateBVHData (const Graphic3d_ZLayerId theLayerId);
b7cd4ba7 103
e276548b 104 //! Returns structure modification state (for ray-tracing).
bd6a8454 105 Standard_Size ModificationStateOfRaytracable() const { return myModifStateOfRaytraceable; }
e276548b 106
a1954302 107protected:
59f45b7c 108
109 // number of structures temporary put to default layer
110 OpenGl_SequenceOfLayers myLayers;
111 OpenGl_LayerSeqIds myLayerIds;
bd6a8454 112 Standard_Integer myDefaultLayerIndex; //!< index of Graphic3d_ZLayerId_Default layer in myLayers sequence
a1954302 113
59f45b7c 114 Standard_Integer myNbPriorities;
115 Standard_Integer myNbStructures;
a1954302 116 Standard_Integer myImmediateNbStructures; //!< number of structures within immediate layers
59f45b7c 117
bd6a8454 118 mutable Standard_Size myModifStateOfRaytraceable;
e276548b 119
a1954302 120public:
121
65c62757 122 DEFINE_STANDARD_ALLOC
a1954302 123
59f45b7c 124};
125
126#endif //_OpenGl_LayerList_Header