1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: PartSet_CustomPrs.hxx
4 // Created: 30 Jun 2015
5 // Author: Natalia ERMOLAEVA
7 #ifndef PartSet_CustomPrs_H
8 #define PartSet_CustomPrs_H
12 #include "PartSet_OperationPrs.h"
14 #include <ModelAPI_Object.h>
15 #include <ModelAPI_Result.h>
16 #include <ModelAPI_Feature.h>
18 #include <GeomAPI_ICustomPrs.h>
19 #include <GeomAPI_AISObject.h>
20 #include <GeomAPI_Shape.h>
22 class ModuleBase_IWorkshop;
26 * This is the module custom presentation, which manage an AIS presentation, that can be filled
27 * by a feature and visualized in the viewer additionally to usual workshop objects.
29 class PartSet_CustomPrs
32 PARTSET_EXPORT PartSet_CustomPrs(ModuleBase_IWorkshop* theWorkshop);
33 PARTSET_EXPORT virtual ~PartSet_CustomPrs() {};
35 /// Returns true if the presentation is active
38 /// Initializes the operation presentation by the parameter object and display the presentation
39 /// \param theObject an operation feature source to fill the presentation
40 /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
41 /// \returns true if the presentation is displayed
42 bool activate(const FeaturePtr& theObject, const bool theUpdateViewer);
44 /// Initializes the operation presentation by empty object and erase the presentation
45 /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
46 /// \returns true if the presentation has been displayed and now it is erased
47 bool deactivate(const bool theUpdateViewer);
49 /// If the presentation is active[displayed], the shapes of the presentation is recomputed
50 /// and the presentation is redisplayed.
51 /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
52 /// \returns true if the presentation is redisplayed
53 bool redisplay(const ObjectPtr& theObject, const bool theUpdateViewer);
55 /// Nullify the operation presentation. For example, it can be useful when the viewer/context
56 /// is closed. If this is not performed and the presentation is assigned in another context,
57 /// it caused erroneus case because the presentation has linkage to the previous context.
61 /// Creates the AIS operation presentation
64 /// Returns the AIS presentation
65 Handle(PartSet_OperationPrs) getPresentation();
68 XGUI_Workshop* workshop() const;
70 /// Displays the internal presentation in the viewer of workshop
71 /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
72 void displayPresentation(const bool theUpdateViewer);
74 /// Erases the internal presentation from the viewer of workshop
75 /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
76 void erasePresentation(const bool theUpdateViewer);
78 /// Sets color, point size and width of the presentation
79 /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly
80 void customizePresentation(const bool theUpdateViewer);
84 ModuleBase_IWorkshop* myWorkshop; /// current workshop
85 AISObjectPtr myOperationPrs; /// the AIS presentation, which is displayed/erased in the viewer