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