#include <ModuleBase_Definitions.h>
#include <ModuleBase_ViewerPrs.h>
+#include <GeomAPI_ICustomPrs.h>
+
#include <SelectMgr_AndFilter.hxx>
#include <QString>
#include <QMap>
+#include <QObject>
+#include <QColor>
class ModelAPI_Feature;
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 display mode
enum DisplayMode {
/// Display the feature. Obtain the visualized object from the feature.
/// \param theObject an object to display
- /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
+ /// \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. To hide this object use corresponde erase method
+ /// 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 isUpdate the parameter whether the viewer should be update immediatelly
- void displayAIS(AISObjectPtr theAIS, bool isUpdate = true);
+ /// \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);
+
+ /** 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);
/**
- * Add presentations which corresponds to the given features to current selection
- * \param theFeatures a list of features to be selected
- * \param isUpdateViewer the parameter whether the viewer should be update immediatelly
+ * Sends and flushes a signal to redisplay all visualized objects.
*/
- void setSelected(const QObjectPtrList& theFeatures, bool isUpdateViewer = true);
+ void redisplayObjects();
+
+ /**
+ * 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<ModuleBase_ViewerPrs>& theValues, bool theUpdateViewer = true);
/// Unselect all objects
/// Erase the feature and a shape.
/// \param theObject an object instance
- /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
- void erase(ObjectPtr theObject, const bool isUpdateViewer = true);
+ /// \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
/// \param theAIS instance of AIS object
- /// \param isUpdate the parameter whether the viewer should be update immediatelly
- void eraseAIS(AISObjectPtr theAIS, const bool isUpdate = true);
+ /// \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);
+ /// \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);
+
+ // Remove default selection filters of the module from the current viewer
+ void deactivateSelectionFilters();
/// \brief Add selection filter
/// \param theFilter a filter instance
/// \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();
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 theObject the object or presentable feature
/// \return corresponded object or NULL if it not found
ObjectPtr getObject(const Handle(AIS_InteractiveObject)& theIO) const;
- /// Deactivates the given object (not allow selection)
- /// \param theObject object to deactivate
- void deactivate(ObjectPtr theObject);
+ /// 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 theObject, 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
/// Activates the given object with default modes
/// \param theObject object to activate
- void activate(ObjectPtr theObject);
+ //void activate(ObjectPtr theObject);
/// Returns true if the given object can be selected
/// \param theObject object to check
/// Activates in local context displayed outside of the context.
/// \param theModes - modes on which it has to be activated (can be empty)
- void activateObjects(const QIntList& theModes);
-
- /// Activates in local context displayed outside of the context.
- void deactivateObjects();
+ /// \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 dis played then returns NoMode.
/// Returns list of displayed objects
QObjectPtrList displayedObjects() const { return myResult2AISObjectMap.keys(); }
+ /// Returns list of displayed objects
+ QList<AISObjectPtr> 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;
/// \param theObject an object instance
/// \param theAIS AIS presentation
/// \param isShading flag to show in shading mode
- /// \param isUpdateViewer the parameter whether the viewer should be update immediatelly
+ /// \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);
- /** Redisplay the shape if it was displayed
- * \param theObject an object instance
- * \param isUpdateViewer the parameter whether the viewer should be update immediatelly
- */
- void redisplay(ObjectPtr theObject, bool isUpdateViewer = 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);
+
+ /// Find a trihedron in a list of displayed presentations and deactivate it.
+ void deactivateTrihedron() const;
/// 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
+ */
+ 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;
/// 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<ObjectPtr, AISObjectPtr> ResultToAISMap;
