X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FXGUI%2FXGUI_Displayer.h;h=dfaffc9bb1162d26e2cdec91e915abdb558993e6;hb=65a616a3bb6cbdf09c61fed7eb91d1f5d9667988;hp=7f117fea5e0a586366f3423a7144b0cd4ba85f64;hpb=7778069b85fb13f2cd02c3cf5ad8ba6233b24e11;p=modules%2Fshaper.git diff --git a/src/XGUI/XGUI_Displayer.h b/src/XGUI/XGUI_Displayer.h index 7f117fea5..dfaffc9bb 100644 --- a/src/XGUI/XGUI_Displayer.h +++ b/src/XGUI/XGUI_Displayer.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D --> + // File: XGUI_Displayer.h // Created: 20 Apr 2014 // Author: Natalia ERMOLAEVA @@ -7,11 +9,7 @@ #include "XGUI.h" -#include -#include - #include - #include #include #include @@ -22,11 +20,15 @@ #include #include -#include -#include -#include +#include + +#include + +#include +#include +#include +#include -class XGUI_Viewer; class ModelAPI_Feature; class XGUI_Workshop; @@ -34,159 +36,286 @@ class XGUI_Workshop; * \ingroup GUI * \brief Displayer. Provides mechanizm of display/erase of objects in the viewer */ -class XGUI_EXPORT XGUI_Displayer +class XGUI_EXPORT XGUI_Displayer: public QObject { + Q_OBJECT public: - enum DisplayMode { NoMode = -1, Wireframe, Shading }; + /// \enum DisplayMode display mode + enum DisplayMode { + /// Mode is not defined + NoMode = -1, + /// Wireframe display mode + Wireframe, + /// Shading display mode + Shading + }; /// Constructor - /// \param theViewer the viewer + /// \param theWorkshop a workshop instance XGUI_Displayer(XGUI_Workshop* theWorkshop); + /// Destructor virtual ~XGUI_Displayer(); /// Returns the feature visibility state. - /// \param theFeature a feature instance + /// \param theObject an object instance bool isVisible(ObjectPtr theObject) const; /// Display the feature. Obtain the visualized object from the feature. - /// \param theFeature a feature instance - /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly + /// \param theObject an object to display + /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly /// Returns true if the Feature succesfully displayed - void display(ObjectPtr theObject, bool isUpdateViewer = true); + void display(ObjectPtr theObject, bool theUpdateViewer = true); + + /// Display the given AIS object. This object is not added to the displayer internal map of objects + /// So, it can not be obtained from displayer. This is just a wrap method of OCC display in order + /// to perform the display with correct flags. + /// \param theAIS AIOS object to display + /// \param toActivateInSelectionModes boolean value whether the presentation should be + /// activated in the current selection modes + /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly + void displayAIS(AISObjectPtr theAIS, const bool toActivateInSelectionModes, + bool theUpdateViewer = true); - /// Display the given AIS object. To hide this object use corresponde erase method - void display(AISObjectPtr theAIS, bool isUpdate = true); + /** Redisplay the shape if it was displayed + * \param theObject an object instance + * \param theUpdateViewer the parameter whether the viewer should be update immediatelly + */ + void redisplay(ObjectPtr theObject, bool theUpdateViewer = true); - /// Stop the current selection and color the given features to the selection color - /// \param theFeatures a list of features to be disabled - /// \param theToStop the boolean state whether it it stopped or non stopped - /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly - void stopSelection(const QList& theFeatures, const bool isStop, - const bool isUpdateViewer); + /** + * Sends and flushes a signal to redisplay all visualized objects. + */ + void redisplayObjects(); /** - * Add presentations which corresponds to the given features to current selection - * \param theFeatures a list of features to be selected - * isUpdateViewer the parameter whether the viewer should be update immediatelly + * Add presentations to current selection. It unhighlight and deselect the current selection. + * The shape and result components are processed in the values. If the presentation shape is not + * empty, select it, otherwise select the result. + * \param theValues a list of presentation to be selected + * \param theUpdateViewer the parameter whether the viewer should be update immediatelly */ - void setSelected(const QList& theFeatures, bool isUpdateViewer = true); + void setSelected(const QList& theValues, bool theUpdateViewer = true); - /// Un select all objects + /// Unselect all objects void clearSelected(); /// Erase the feature and a shape. - /// \param theFeature a feature instance - /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly - void erase(ObjectPtr theObject, const bool isUpdateViewer = true); + /// \param theObject an object instance + /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly + void erase(ObjectPtr theObject, const bool theUpdateViewer = true); /// Erase the given AIS object displayed by corresponded display method - void erase(AISObjectPtr theAIS, const bool isUpdate = true); + /// \param theAIS instance of AIS object + /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly + void eraseAIS(AISObjectPtr theAIS, const bool theUpdateViewer = true); /// Erase all presentations - /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly - void eraseAll(const bool isUpdateViewer = true); - - /// Erase AIS interactive objects, which has an empty feature in the internal map - /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly - void eraseDeletedResults(const bool isUpdateViewer = true); - - /// Opens local context. Does nothing if it is already opened. - void openLocalContext(); + /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly + void eraseAll(const bool theUpdateViewer = true); /// Deactivates selection of sub-shapes - /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly - void closeLocalContexts(const bool isUpdateViewer = true); + /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly + void closeLocalContexts(const bool theUpdateViewer = true); - /* - * Set modes of selections. Selection mode has to be defined by TopAbs_ShapeEnum. - * It doesn't manages a local context - * \param theModes - list of selection modes. If the list is empty then all selectoin modes will be cleared. - */ - void setSelectionModes(const QIntList& theModes); + // Remove default selection filters of the module from the current viewer + void deactivateSelectionFilters(); + /// \brief Add selection filter + /// \param theFilter a filter instance void addSelectionFilter(const Handle(SelectMgr_Filter)& theFilter); + /// \brief Remove selection filter + /// \param theFilter a filter instance void removeSelectionFilter(const Handle(SelectMgr_Filter)& theFilter); + /// Returns true if the selection filter is set to the viewer + /// \param theFilter a selection filter + virtual bool hasSelectionFilter(const Handle(SelectMgr_Filter)& theFilter); + + /// Remove all selection filters + void removeFilters(); + + /** + * Sets a flag to the displayer whether the internal viewer can be updated by + * the updateViewer method call. If it is not enabled, this method do nothing + * \param isEnabled a boolean value + */ + bool enableUpdateViewer(const bool isEnabled); + /// Updates the viewer - void updateViewer(); + void updateViewer() const; + + /// Activate interactive context + /// \param theIO + /// \param theMode + void activateAIS(const Handle(AIS_InteractiveObject)& theIO, const int theMode, + const bool theUpdateViewer) const; + + /// Activate interactive context. It is necessary to call ClearOutdatedSelection after deactivation + void deactivateAIS(const Handle(AIS_InteractiveObject)& theIO, const int theMode = -1) const; /// Searches the interactive object by feature - /// \param theFeature the feature or NULL if it not visualized + /// \param theObject the object or presentable feature /// \return theIO an interactive object - AISObjectPtr getAISObject(ObjectPtr theFeature) const; + AISObjectPtr getAISObject(ObjectPtr theObject) const; /// Searches the feature by interactive object /// \param theIO an interactive object /// \return feature the feature or NULL if it not visualized ObjectPtr getObject(const AISObjectPtr& theIO) const; + + /// Searches the feature by interactive object + /// \param theIO an interactive object + /// \return corresponded object or NULL if it not found ObjectPtr getObject(const Handle(AIS_InteractiveObject)& theIO) const; - /// Deactivates the given object (not allow selection) - void deactivate(ObjectPtr theFeature); + /// Deactivates the given objects (not allow selection) + /// \param theObjList - list of objects which has to be deactivated. + /// \param theUpdateViewer update viewer flag + void deactivateObjects(const QObjectPtrList& theObjList, + const bool theUpdateViewer = true); /// Activates the given object (it can be selected) + /// \param theObject object to activate /// \param theModes - modes on which it has to be activated (can be empty) - void activate(ObjectPtr theFeature, const QIntList& theModes); + //void activate(ObjectPtr theObject, const QIntList& theModes); + + /// Returns the modes of activation + /// \param theObject the feature or NULL if it not visualized + /// \param theModes - modes on which it is activated (can be empty) + void getModesOfActivation(ObjectPtr theObject, QIntList& theModes); + + /// Activates the given object with default modes + /// \param theObject object to activate + //void activate(ObjectPtr theObject); /// Returns true if the given object can be selected + /// \param theObject object to check bool isActive(ObjectPtr theObject) const; /// Activates in local context displayed outside of the context. /// \param theModes - modes on which it has to be activated (can be empty) - void activateObjectsOutOfContext(const QIntList& theModes); - - /// Activates in local context displayed outside of the context. - void deactivateObjectsOutOfContext(); + /// \param theObjList - list of objects which has to be activated. + void activateObjects(const QIntList& theModes, const QObjectPtrList& theObjList, + const bool theUpdateViewer = true); /// Sets display mode for the given object if this object is displayed - void setDisplayMode(ObjectPtr theObject, DisplayMode theMode, bool toUpdate = true); + void setDisplayMode(ObjectPtr theObject, DisplayMode theMode, bool theUpdateViewer = true); /// Returns current display mode for the given object. - /// If object is not displayed then returns NoMode. + /// If object is not dis played then returns NoMode. + /// \param theObject object to check DisplayMode displayMode(ObjectPtr theObject) const; + /// Displays only objects listed in the list + /// \param theList list of objects + void showOnly(const QObjectPtrList& theList); + /// Returns number of displayed objects int objectsCount() const { return myResult2AISObjectMap.size(); } - protected: - /// Deactivate local selection - /// \param isUpdateViewer the state wether the viewer should be updated immediatelly - void closeAllContexts(const bool isUpdateViewer); + /// Returns list of displayed objects + QObjectPtrList displayedObjects() const { return myResult2AISObjectMap.keys(); } + + /// Returns list of displayed objects + QList displayedPresentations() const { return myResult2AISObjectMap.values(); } + + /// Returns true if the given object can be shown in shaded mode + /// \param theObject object to check + bool canBeShaded(ObjectPtr theObject) const; + + /// Set color on presentation of an object if it is displayed + /// \param theObject an object + /// \param theColor a color which has to be set + /// \param theUpdateViewer update viewer flag + /// \return previously defined color on the object + QColor setObjectColor(ObjectPtr theObject, const QColor& theColor, bool theUpdateViewer = true); +signals: + /// Signal on object display + /// \param theObject a data object + /// \param theAIS a presentation object + void objectDisplayed(ObjectPtr theObject, AISObjectPtr theAIS); + + /// Signal on before object erase + /// \param theObject a data object + /// \param theAIS a presentation object + void beforeObjectErase(ObjectPtr theObject, AISObjectPtr theAIS); + + protected: /// Returns currently installed AIS_InteractiveContext Handle(AIS_InteractiveContext) AISContext() const; + /// Returns the viewer context top filter. If there is no a filter, it is created and set into + /// The context should have only this filter inside. Other filters should be add to the filter + Handle(SelectMgr_AndFilter) GetFilter(); + /// Display the feature and a shape. This shape would be associated to the given feature - /// \param theFeature a feature instance + /// \param theObject an object instance /// \param theAIS AIS presentation - /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly - /// Returns true if the Feature succesfully displayed + /// \param isShading flag to show in shading mode + /// \param theUpdateViewer the parameter whether the viewer should be update immediatelly + /// \return true if the object is succesfully displayed void display(ObjectPtr theObject, AISObjectPtr theAIS, bool isShading, - bool isUpdateViewer = true); + bool theUpdateViewer = true); + +private: + /// Activates the interactive object in the local context. + /// \param theIO an interactive object + /// \param theModes - modes on which it has to be activated (can be empty) + void activate(const Handle(AIS_InteractiveObject)& theIO, const QIntList& theModes, + const bool theUpdateViewer) const; + + /// Deactivates the given object (not allow selection) + /// \param theObject object to deactivate + void deactivate(ObjectPtr theObject, const bool theUpdateViewer); - /// Display the shape and activate selection of sub-shapes - /// \param theFeature a feature instance - /// \param theAIS an AIS object - /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly - /// \returns true if the presentation is created - //bool redisplay(ObjectPtr theObject, - // AISObjectPtr theAIS, - // const bool isUpdateViewer = true); + /// Find a trihedron in a list of displayed presentations and deactivate it. + void deactivateTrihedron() const; - /** Redisplay the shape if it was displayed - * \param theFeature a feature instance - * \param isUpdateViewer the parameter whether the viewer should be update immediatelly + /// Opens local context. Does nothing if it is already opened. + void openLocalContext(); + + /** Update the object presentable properties such as color, lines width and other + * If the object is result with the color attribute value set, it is used, + * otherwise the customize is applyed to the object's feature if it is a custom prs + * \param theObject an object instance + * \return the true state if there is changes and the presentation is customized */ - void redisplay(ObjectPtr theObject, bool isUpdateViewer = true); + bool customizeObject(ObjectPtr theObject); + + /// Append the objects in the internal map. Checks whether the map already contains the object + /// \param theObject an object to display + /// \param theAIS AIOS object to display + void appendResultObject(ObjectPtr theObject, AISObjectPtr theAIS); + + /// Returns an information about alredy displayed objects + /// \return a string representation + std::string getResult2AISObjectMapInfo() const; protected: + /// Reference to workshop XGUI_Workshop* myWorkshop; - typedef std::map ResultToAISMap; + /// A container for selection filters + Handle(SelectMgr_AndFilter) myAndFilter; + + /// A default custom presentation, which is used if the displayed feature is not a custom presentation + GeomCustomPrsPtr myCustomPrs; + + /// Definition of a type of map which defines correspondance between objects and presentations + typedef QMap ResultToAISMap; + + /// A map of displayed objects ResultToAISMap myResult2AISObjectMap; + + /// Selection modes installed for external objects in local context + QIntList myActiveSelectionModes; + + /// the enable update viewer flag + bool myEnableUpdateViewer; }; #endif