0027818: Visualization - provide an interface to define highlight presentation properties
[occt.git] / src / PrsMgr / PrsMgr_PresentationManager.hxx
CommitLineData
42cf5bc1 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_PresentationManager_HeaderFile
18#define _PrsMgr_PresentationManager_HeaderFile
19
c357e426 20#include <Graphic3d_NameOfMaterial.hxx>
21#include <Graphic3d_StructureManager.hxx>
22#include <Graphic3d_ZLayerId.hxx>
23#include <MMgt_TShared.hxx>
42cf5bc1 24#include <PrsMgr_ListOfPresentations.hxx>
25#include <Quantity_Color.hxx>
42cf5bc1 26#include <Quantity_NameOfColor.hxx>
c357e426 27#include <Standard.hxx>
28#include <Standard_Boolean.hxx>
29#include <Standard_Integer.hxx>
30#include <Standard_Type.hxx>
31
42cf5bc1 32class Geom_Transformation;
c357e426 33class Prs3d_Presentation;
c357e426 34class PrsMgr_PresentableObject;
42cf5bc1 35class PrsMgr_Presentation;
c357e426 36class Standard_NoSuchObject;
37class V3d_Viewer;
42cf5bc1 38
39class PrsMgr_PresentationManager;
40DEFINE_STANDARD_HANDLE(PrsMgr_PresentationManager, MMgt_TShared)
41
42//! A framework to manage 3D displays, graphic entities and their updates.
43//! Used in the AIS package (Application Interactive Services), to enable the advanced user to define the
44//! default display mode of a new interactive object which extends the list of signatures and types.
45//! Definition of new display types is handled by calling the presentation algorithms provided by the StdPrs package.
46class PrsMgr_PresentationManager : public MMgt_TShared
47{
48
49public:
50
51
52
53 //! Creates a framework to manage displays and graphic entities with the 3D view theStructureManager.
c357e426 54 Standard_EXPORT PrsMgr_PresentationManager(const Handle(Graphic3d_StructureManager)& theStructureManager);
42cf5bc1 55
56 //! Displays the presentation of the object in the given Presentation manager with the given mode.
57 //! The mode should be enumerated by the object which inherits PresentableObject.
58 Standard_EXPORT void Display (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0);
59
60 //! erases the presentation of the object in the given
61 //! Presentation manager with the given mode.
e2d7642f 62 //! If @theMode is -1, then erases all presentations of the object.
42cf5bc1 63 Standard_EXPORT void Erase (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0);
64
65
66 //! Clears the presentation of the presentable object thePrsObject in this framework with the display mode theMode.
67 Standard_EXPORT virtual void Clear (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0);
68
69 //! Sets the visibility of presentable object.
70 Standard_EXPORT void SetVisibility (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode, const Standard_Boolean theValue);
8e5fb5ea 71
42cf5bc1 72 //! Removes highlighting from the presentation of the
73 //! presentable object thePrsObject in this framework with the display mode theMode.
74 Standard_EXPORT void Unhighlight (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0);
75
76
77 //! Sets the display priority theNewPrior of the
78 //! presentable object thePrsObject in this framework with the display mode theMode.
79 Standard_EXPORT void SetDisplayPriority (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode, const Standard_Integer theNewPrior) const;
80
81
82 //! Returns the display priority of the presentable object
83 //! thePrsObject in this framework with the display mode theMode.
84 Standard_EXPORT Standard_Integer DisplayPriority (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode) const;
85
86 //! Set Z layer ID for all presentations of the object.
87 Standard_EXPORT void SetZLayer (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theLayerId);
88
89 //! Get Z layer ID assigned to all presentations of the object.
90 //! Method returns -1 value if object has no presentations and is
91 //! impossible to get layer index.
92 Standard_EXPORT Standard_Integer GetZLayer (const Handle(PrsMgr_PresentableObject)& thePrsObject) const;
93
94 Standard_EXPORT Standard_Boolean IsDisplayed (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0) const;
95
96 //! Returns true if the presentation of the presentable
97 //! object thePrsObject in this framework with the display mode theMode is highlighted.
98 Standard_EXPORT Standard_Boolean IsHighlighted (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0) const;
99
100 //! Updates the presentation of the presentable object
101 //! thePrsObject in this framework with the display mode theMode.
102 Standard_EXPORT void Update (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0) const;
103
104 //! Resets the transient list of presentations previously displayed in immediate mode
105 //! and begins accumulation of new list by following AddToImmediateList()/Color()/Highlight() calls.
106 Standard_EXPORT void BeginImmediateDraw();
107
108 //! Resets the transient list of presentations previously displayed in immediate mode.
109 Standard_EXPORT void ClearImmediateDraw();
110
111 //! Stores thePrs in the transient list of presentations to be displayed in immediate mode.
112 //! Will be taken in account in EndImmediateDraw method.
113 Standard_EXPORT void AddToImmediateList (const Handle(Prs3d_Presentation)& thePrs);
c3282ec1 114
115 //! Allows rapid drawing of the each view in theViewer by avoiding an update of the whole background.
116 Standard_EXPORT void EndImmediateDraw (const Handle(V3d_Viewer)& theViewer);
117
118 //! Clears and redisplays immediate structures of the viewer taking into account its affinity.
119 Standard_EXPORT void RedrawImmediate (const Handle(V3d_Viewer)& theViewer);
120
42cf5bc1 121 //! Returns true if Presentation Manager is accumulating transient list of presentations to be displayed in immediate mode.
be5c3602 122 Standard_Boolean IsImmediateModeOn() const;
c3282ec1 123
42cf5bc1 124 //! Highlights the graphic object thePrsObject in the color theColor.
125 //! thePrsObject has the display mode theMode;
126 //! this has the default value of 0, that is, the wireframe display mode.
c3282ec1 127 Standard_EXPORT void Color (const Handle(PrsMgr_PresentableObject)& thePrsObject,
8e5fb5ea 128 const Handle(Graphic3d_HighlightStyle)& theStyle,
c3282ec1 129 const Standard_Integer theMode = 0,
130 const Handle(PrsMgr_PresentableObject)& theSelObj = NULL,
131 const Graphic3d_ZLayerId theImmediateStructLayerId = Graphic3d_ZLayerId_Topmost);
42cf5bc1 132
133 Standard_EXPORT void Connect (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Handle(PrsMgr_PresentableObject)& theOtherObject, const Standard_Integer theMode = 0, const Standard_Integer theOtherMode = 0);
134
135
136 //! Sets the transformation theTransformation for the presentable object thePrsObject.
137 //! thePrsObject has the display mode theMode; this has the default value of 0, that is, the wireframe display mode.
138 Standard_EXPORT void Transform (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Handle(Geom_Transformation)& theTransformation, const Standard_Integer theMode = 0);
139
140 //! Returns the structure manager.
2831708b 141 const Handle(Graphic3d_StructureManager)& StructureManager() const;
142
42cf5bc1 143 //! Returns true if there is a presentation of the
144 //! presentable object thePrsObject in this framework, thePrsObject having the display mode theMode.
145 Standard_EXPORT Standard_Boolean HasPresentation (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0) const;
146
147 //! Returns the presentation Presentation of the presentable object thePrsObject in this framework.
148 //! When theToCreate is true - automatically creates presentation for specified mode when not exist.
149 //! Optional argument theSelObj specifies parent decomposed object to inherit its view affinity.
150 Standard_EXPORT Handle(PrsMgr_Presentation) Presentation (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0, const Standard_Boolean theToCreate = Standard_False, const Handle(PrsMgr_PresentableObject)& theSelObj = NULL) const;
151
5396886c 152 //! Allows to apply location transformation to shadow highlight presentation immediately.
153 //! @param theObj defines the base object, it local transformation will be applied to corresponding highlight structure
154 //! @param theMode defines display mode of the base object
155 //! @param theSelObj defines the object produced after decomposition of the base object for local selection
156 Standard_EXPORT void UpdateHighlightTrsf (const Handle(V3d_Viewer)& theViewer,
157 const Handle(PrsMgr_PresentableObject)& theObj,
158 const Standard_Integer theMode = 0,
159 const Handle(PrsMgr_PresentableObject)& theSelObj = NULL);
42cf5bc1 160
161
162
92efcf78 163 DEFINE_STANDARD_RTTIEXT(PrsMgr_PresentationManager,MMgt_TShared)
42cf5bc1 164
165protected:
166
167
168 //! Removes a presentation of the presentable object thePrsObject to this framework. thePrsObject has the display mode theMode.
169 Standard_EXPORT Standard_Boolean RemovePresentation (const Handle(PrsMgr_PresentableObject)& thePrsObject, const Standard_Integer theMode = 0);
170
c357e426 171 Handle(Graphic3d_StructureManager) myStructureManager;
42cf5bc1 172 Standard_Integer myImmediateModeOn;
173 PrsMgr_ListOfPresentations myImmediateList;
c3282ec1 174 PrsMgr_ListOfPresentations myViewDependentImmediateList;
42cf5bc1 175
176
177private:
178
c3282ec1 179 //! Handles the structures from <myImmediateList> and displays it separating view-dependent structures and taking into account
180 //! structure visibility by setting proper affinity.
181 void displayImmediate (const Handle(V3d_Viewer)& theViewer);
42cf5bc1 182};
183
184
185#include <PrsMgr_PresentationManager.lxx>
186
187
188
189
190
191#endif // _PrsMgr_PresentationManager_HeaderFile