Abstract base class for 2D, 3D, text and plot visualization views (namely Visualization2DView and Visualization3DView...). More...
#include <views/VisualizationView.h>
Signals | |
| void | editorClosed (EditorPart *editor) |
| void | editorDestroyed (EditorPart *editor) |
| void | windowTitleChanged (EditorPartWindow *editor) |
Public Member Functions | |
| VisualizationView () | |
| virtual | ~VisualizationView () |
| template<typename Reflector > | |
| void | reflect (Reflector &r) |
| void | reflect (XMLDeserializer &r) |
| Specialization of reflect method for XML. More... | |
| void | reflect (XMLSerializer &r) |
| Specialization of reflect method for XML. More... | |
| virtual void | addVisualization (Visualization *vis) |
| Adds an existing visualization to this view. More... | |
| virtual void | removeVisualization (Visualization *vis) |
| Remove the specified visualization from this view. More... | |
| virtual void | moveUpVisualization (Visualization *vis) |
| Change order of visualizations in the view, move the specified visualization up. More... | |
| virtual void | moveDownVisualization (Visualization *vis) |
| Change order of visualizations in the view, move the specified visualization down. More... | |
| const std::list< Visualization * > & | getVisualizations () const |
| virtual void | addTool (VisualizationTool *tool) |
| Adds an existing tool to this view. More... | |
| const std::vector< VisualizationTool * > & | getTools () const |
| VisualizationControlPage * | getControl () |
| Returns pointer to VisualizationControlPage (or NULL, if no such page was created yet. More... | |
| virtual Object * | getAdapter (const Class &adapter) |
| Returns an object which is an instance of the given class associated with this object. More... | |
| virtual const Class & | supportedVisualizationClass () const =0 |
| Derived visualization views must return the base class of their supported visualizations. More... | |
| virtual const Class & | defaultVisualizationClass () const |
| If a default visualization class is provided, this class is used to instantiate a default visualization for data objects, no other specialized visualization is found for. More... | |
| virtual const Class & | supportedVisualizationToolClass () const |
| Derived visualization views may return the base class of their supported tools. More... | |
| void | setUpdateInterval (int interval) |
| int | getUpdateInterval () |
| VisualizationTool * | getActiveTool () |
| Returns the current active tool, or NULL of no tool is active. More... | |
| void | activateTool (VisualizationTool *tool) |
| void | setOfferAuxiliaryVisualizations (bool on) |
| virtual void | init (IWorkbenchPartSite *site) |
| Is called by the workbench. More... | |
| IWorkbenchPartSite * | getSite () |
| virtual QImage | captureContent () |
| Returns the content of the editor part as QImage. More... | |
| void | setWidget (QWidget *widget) |
| QWidget * | widget () const |
| EditorPartTitleBar * | getTitleBar () |
| void | undock () |
| Undocks the window from the EditorPartArea and makes it floating. More... | |
| void | dock () |
| Docks the window back to the EditorPartArea. More... | |
| bool | isDocked () const |
| Returns true, if the window is docked in the EditorPartArea. More... | |
| void | setOnTop (bool onTop) |
| Makes the window stay on top of other windows. More... | |
| bool | isOnTop () const |
| Returns true, if the window stays on top of other windows. More... | |
| void | showDecorations (bool show) |
| void | setAutoHideDecorations (bool on) |
| virtual void | activate () |
| Is called by the Workbench to inform the Part that is being activated by the user. More... | |
| virtual void | deactivate () |
| Is called by the Workbench to inform the Part that is being deactivated since another Part got the focus. More... | |
| bool | isActivated () const |
| Returns true if this ViewPart currently has the focus and hence the users attention. More... | |
| Class const & | getClass () const |
| call the virtual internalGetClass(). More... | |
Static Public Member Functions | |
| static PseudoClass const & | CLASS () |
Protected Slots | |
| void | onMinimized () |
| void | onMaximized () |
| void | onRestored () |
| void | onUndock () |
| void | onDock () |
| void | onOnTop (bool onTop) |
Protected Member Functions | |
| virtual QWidget * | createPartControl () |
| Must be overloaded in subclasses to create the actual widget for this EditorPart. More... | |
| virtual QWidget * | createVisualizationPart ()=0 |
| virtual void | resetView () |
| virtual void | saveContentToFile () |
| virtual void | update (Duration dt)=0 |
| Is called by this class within the update timer event to update the view. More... | |
| void | startUpdateTimer () |
| virtual void | timerEvent (QTimerEvent *) |
| bool | eventFilter (QObject *obj, QEvent *event) |
| void | keyPressEvent (QKeyEvent *event) |
| void | keyReleaseEvent (QKeyEvent *event) |
| void | focusOutEvent (QFocusEvent *event) |
| std::string | getChannelIDFromMimeData (const QMimeData *mimeData) |
| std::list< ClassProxy > | getVisualizationsFor (const std::string &channelID) |
| void | dragEnterEventImpl (QDragEnterEvent *event) |
| void | dropEventImpl (QDropEvent *event, QWidget *widget) |
| void | destroyVisualizations () |
| void | destroyTools () |
| QMenu * | getViewMenu () |
| Returns the optional editor menu that is shown when the user clicks the editor menu tool button. More... | |
| virtual void | closeEvent (QCloseEvent *) |
| virtual void | paintEvent (QPaintEvent *paintEvent) |
| virtual void | changeEvent (QEvent *event) |
| void | setActive (bool activate) |
| virtual void | windowStateChanged (Qt::WindowStates oldState, Qt::WindowStates newState) |
| void | updateDecorations () |
| void | updateStateButtons () |
| virtual Class const & | internalGetClass () const =0 |
Detailed Description
Abstract base class for 2D, 3D, text and plot visualization views (namely Visualization2DView and Visualization3DView...).
Constructor & Destructor Documentation
◆ VisualizationView()
◆ ~VisualizationView()
|
virtual |
Member Function Documentation
◆ reflect() [1/3]
|
inline |
◆ reflect() [2/3]
| void reflect | ( | XMLDeserializer & | r | ) |
Specialization of reflect method for XML.
◆ reflect() [3/3]
| void reflect | ( | XMLSerializer & | r | ) |
Specialization of reflect method for XML.
◆ addVisualization()
|
virtual |
Adds an existing visualization to this view.
The view will take ownership of the visualization and will destroy it upon its own deletion.
Reimplemented in Visualization3DView, and Visualization2DView.
◆ removeVisualization()
|
virtual |
Remove the specified visualization from this view.
The view will give up its ownership of the visualization and the Visualization must be destroyed outside of this view.
◆ moveUpVisualization()
|
virtual |
Change order of visualizations in the view, move the specified visualization up.
The base VisualizationView just changes the order in the stored list of visualizations. Subclasses should overwrite this method to adapt their respective GUI accordingly.
Reimplemented in Visualization3DView, and Visualization2DView.
◆ moveDownVisualization()
|
virtual |
Change order of visualizations in the view, move the specified visualization down.
The base VisualizationView just changes the order in the stored list of visualizations. Subclasses should overwrite this method to adapt their respective GUI accordingly.
Reimplemented in Visualization3DView, and Visualization2DView.
◆ getVisualizations()
| const std::list<Visualization*>& getVisualizations | ( | ) | const |
◆ addTool()
|
virtual |
Adds an existing tool to this view.
The view will take ownership of the tool and will destroy it upon its own deletion.
Reimplemented in Visualization3DView, and Visualization2DView.
◆ getTools()
| const std::vector<VisualizationTool*>& getTools | ( | ) | const |
◆ getControl()
| VisualizationControlPage* getControl | ( | ) |
Returns pointer to VisualizationControlPage (or NULL, if no such page was created yet.
◆ getAdapter()
Returns an object which is an instance of the given class associated with this object.
Returns nullptr if no such object can be found. The implementation if IAdaptable is responsible for destroying the instance of the created object.
Reimplemented from WorkbenchPart.
◆ supportedVisualizationClass()
|
pure virtual |
Derived visualization views must return the base class of their supported visualizations.
Implemented in Visualization3DView, and Visualization2DView.
◆ defaultVisualizationClass()
|
inlinevirtual |
If a default visualization class is provided, this class is used to instantiate a default visualization for data objects, no other specialized visualization is found for.
If no default visualization class exists, such data objects can not be visualized (the default behavior).
◆ supportedVisualizationToolClass()
|
inlinevirtual |
Derived visualization views may return the base class of their supported tools.
The default implementation returns a null-class to indicate that no tools are supported.
Reimplemented in Visualization3DView, and Visualization2DView.
◆ createPartControl()
|
protectedvirtual |
Must be overloaded in subclasses to create the actual widget for this EditorPart.
This EditorPart should be set as parent for the created widget.
Implements EditorPart.
◆ createVisualizationPart()
|
protectedpure virtual |
Implemented in Visualization3DView, and Visualization2DView.
◆ resetView()
|
protectedvirtual |
Reimplemented in Visualization3DView, and Visualization2DView.
◆ saveContentToFile()
|
protectedvirtual |
Reimplemented in Visualization3DView, and Visualization2DView.
◆ update()
|
protectedpure virtual |
Is called by this class within the update timer event to update the view.
The visualizations of the view have been updated before this method is called. The update cycle must be enabled by calling startUpdateTimer() after the derived class and its GUI components have been enabled
Implemented in Visualization3DView, and Visualization2DView.
◆ setUpdateInterval()
| void setUpdateInterval | ( | int | interval | ) |
◆ getUpdateInterval()
| int getUpdateInterval | ( | ) |
◆ getActiveTool()
|
inline |
Returns the current active tool, or NULL of no tool is active.
◆ activateTool()
| void activateTool | ( | VisualizationTool * | tool | ) |
◆ setOfferAuxiliaryVisualizations()
|
inline |
◆ startUpdateTimer()
|
protected |
◆ timerEvent()
|
protectedvirtual |
◆ eventFilter()
|
protected |
◆ keyPressEvent()
|
protected |
◆ keyReleaseEvent()
|
protected |
◆ focusOutEvent()
|
protected |
◆ getChannelIDFromMimeData()
|
protected |
◆ getVisualizationsFor()
|
protected |
◆ dragEnterEventImpl()
|
protected |
◆ dropEventImpl()
|
protected |
◆ destroyVisualizations()
|
protected |
◆ destroyTools()
|
protected |
◆ init()
|
virtualinherited |
Is called by the workbench.
The WorkbenchPart should initialize itself and my store the pointer tothe IWorkbenchPartSite interface for later use.
Implements WorkbenchPart.
◆ getSite()
|
inherited |
◆ captureContent()
|
virtualinherited |
Returns the content of the editor part as QImage.
Can be reimplemented by subclasses to provide special capturing techniques that are e.g. required by OpenQL widgets.
Reimplemented in Visualization3DView.
◆ getViewMenu()
|
protectedinherited |
Returns the optional editor menu that is shown when the user clicks the editor menu tool button.
An EditorPart can add items to this menu within it's createPartControl() method, by calling this method and populating items to the menu.
◆ closeEvent()
|
protectedvirtualinherited |
◆ editorClosed
|
signalinherited |
◆ editorDestroyed
|
signalinherited |
◆ setWidget()
|
inherited |
◆ widget()
|
inherited |
◆ getTitleBar()
|
inherited |
◆ undock()
|
inlineinherited |
Undocks the window from the EditorPartArea and makes it floating.
◆ dock()
|
inlineinherited |
Docks the window back to the EditorPartArea.
◆ isDocked()
|
inlineinherited |
Returns true, if the window is docked in the EditorPartArea.
◆ setOnTop()
|
inlineinherited |
Makes the window stay on top of other windows.
◆ isOnTop()
|
inlineinherited |
Returns true, if the window stays on top of other windows.
◆ showDecorations()
|
inherited |
◆ setAutoHideDecorations()
|
inherited |
◆ paintEvent()
|
protectedvirtualinherited |
◆ changeEvent()
|
protectedvirtualinherited |
◆ setActive()
|
protectedinherited |
◆ windowStateChanged()
|
protectedvirtualinherited |
◆ updateDecorations()
|
protectedinherited |
◆ updateStateButtons()
|
protectedinherited |
◆ onMinimized
|
protectedslotinherited |
◆ onMaximized
|
protectedslotinherited |
◆ onRestored
|
protectedslotinherited |
◆ onUndock
|
protectedslotinherited |
◆ onDock
|
protectedslotinherited |
◆ onOnTop
|
protectedslotinherited |
◆ windowTitleChanged
|
signalinherited |
◆ activate()
|
virtualinherited |
Is called by the Workbench to inform the Part that is being activated by the user.
Implements IWorkbenchPart.
Reimplemented in ViewPart.
◆ deactivate()
|
virtualinherited |
Is called by the Workbench to inform the Part that is being deactivated since another Part got the focus.
Implements IWorkbenchPart.
Reimplemented in ViewPart.
◆ isActivated()
|
inlineinherited |
Returns true if this ViewPart currently has the focus and hence the users attention.
◆ getClass()
|
inlineinherited |
call the virtual internalGetClass().
◆ CLASS()
|
inlinestaticinherited |
◆ internalGetClass()
|
protectedpure virtualinherited |
The documentation for this class was generated from the following file:
- gui/include/views/VisualizationView.h
