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