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