0031682: Visualization - Prs3d_ShadingAspect::SetTransparency() has no effect with...
[occt.git] / src / PrsMgr / PrsMgr_Presentation.hxx
1 // Created on: 1995-01-25
2 // Created by: Jean-Louis Frenkel
3 // Copyright (c) 1995-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _PrsMgr_Presentation_HeaderFile
18 #define _PrsMgr_Presentation_HeaderFile
19
20 #include <Aspect_TypeOfHighlightMethod.hxx>
21 #include <Prs3d_Presentation.hxx>
22
23 class PrsMgr_PresentationManager;
24 class PrsMgr_PresentableObject;
25 class Quantity_Color;
26 class Graphic3d_Camera;
27 class Prs3d_Drawer;
28 class Graphic3d_Structure;
29 class Graphic3d_DataStructureManager;
30
31 DEFINE_STANDARD_HANDLE(PrsMgr_Presentation, Graphic3d_Structure)
32
33 class PrsMgr_Presentation : public Graphic3d_Structure
34 {
35   DEFINE_STANDARD_RTTIEXT(PrsMgr_Presentation, Graphic3d_Structure)
36   friend class PrsMgr_PresentationManager;
37   friend class PrsMgr_PresentableObject;
38 public:
39
40   //! Destructor
41   Standard_EXPORT ~PrsMgr_Presentation();
42
43   Standard_DEPRECATED("Dummy to simplify porting - returns self")
44   Prs3d_Presentation* Presentation() { return this; }
45
46   //! returns the PresentationManager in which the presentation has been created.
47   const Handle(PrsMgr_PresentationManager)& PresentationManager() const { return myPresentationManager; }
48
49   void SetUpdateStatus (const Standard_Boolean theUpdateStatus) { myMustBeUpdated = theUpdateStatus; }
50
51   Standard_Boolean MustBeUpdated() const { return myMustBeUpdated; }
52
53   //! Return display mode index.
54   Standard_Integer Mode() const { return myMode; }
55
56   //! Display structure.
57   Standard_EXPORT virtual void Display() Standard_OVERRIDE;
58
59   //! Remove structure.
60   Standard_EXPORT virtual void Erase() Standard_OVERRIDE;
61
62   //! Highlight structure.
63   Standard_EXPORT void Highlight (const Handle(Prs3d_Drawer)& theStyle);
64
65   //! Unhighlight structure.
66   Standard_EXPORT void Unhighlight();
67
68   //! Return TRUE if structure has been displayed and in no hidden state.
69   virtual Standard_Boolean IsDisplayed() const Standard_OVERRIDE
70   {
71     return base_type::IsDisplayed()
72         && base_type::IsVisible();
73   }
74
75   //! removes the whole content of the presentation.
76   //! Does not remove the other connected presentations.
77   Standard_EXPORT virtual void Clear (const Standard_Boolean theWithDestruction = Standard_True) Standard_OVERRIDE;
78
79   //! Compute structure using presentation manager.
80   Standard_EXPORT virtual void Compute() Standard_OVERRIDE;
81
82   //! Dumps the content of me into the stream
83   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
84
85 protected:
86
87   //! Main constructor.
88   Standard_EXPORT PrsMgr_Presentation (const Handle(PrsMgr_PresentationManager)& thePresentationManager,
89                                        const Handle(PrsMgr_PresentableObject)& thePresentableObject,
90                                        const Standard_Integer theMode);
91
92   //! Displays myStructure.
93   Standard_EXPORT void display (const Standard_Boolean theIsHighlight);
94
95   Standard_EXPORT virtual void computeHLR (const Handle(Graphic3d_Camera)& theProjector,
96                                            Handle(Graphic3d_Structure)& theGivenStruct) Standard_OVERRIDE;
97 protected:
98
99   Handle(PrsMgr_PresentationManager) myPresentationManager;
100   PrsMgr_PresentableObject* myPresentableObject;
101   Standard_Integer myBeforeHighlightState;
102   Standard_Integer myMode;
103   Standard_Boolean myMustBeUpdated;
104
105 };
106
107 #endif // _PrsMgr_Presentation_HeaderFile