 |
ImFusion C++ SDK 4.4.0
|
|
ImFusion C++ SDK 4.4.0
|
#include <ImFusion/LiveUS/StreamDisplayDataController.h>
GUI DataController for adjusting ultrasound stream visualizations in the display views. More...
GUI DataController for adjusting ultrasound stream visualizations in the display views.
It is visible when a stream with the ultrasound modality is in the data model. It is enabled when the stream is visible in the views.
This controller is responsible for the visualization of a GlUltrasoundRuler measuring the depth of the image. This ruler is only visible with the ultrasound modality and its stream of Ultrasound images is visible on the views. It is updated every time a new image arrives through this stream and can be disabled by a button.
Public Slots | |
| void | onRuler (bool flag) |
| The visibility of the ruler is toggled. | |
Public Member Functions | |
| StreamDisplayDataController (ImageStream *stream) | |
| void | init () override |
| Two-step initialization function to be implemented by subclasses. | |
| std::string | title () const override |
| Returns the shown widget title if the controller is shown in a mode that supports this (e.g. | |
| void | onVisibleDataChanged (const DataList &data) override |
| React when a different stream is selected. | |
| void | updateRuler () |
| Without changing selection or visible data, only updates the US ruler scale, for instance after the image size was changed. | |
| Public Member Functions inherited from ImFusion::DataController | |
| std::string | factoryName () const |
| Returns the name used to identify this DataController in the factory. | |
| void | setFactoryName (const std::string &factoryName) |
| Sets the name used to identify this DataController in the factory. | |
| std::vector< Location > | supportedLocations () const override |
| Returns the list of locations in which this controller is allowed to be placed by the parent MainWindowBase. | |
| Location | preferredLocation () const override |
| Returns the preferred location in which the parent MainWindowBase should place this controller. | |
| Public Member Functions inherited from ImFusion::Controller | |
| void | setMainWindowBase (MainWindowBase *mw) |
| Complete the initialization by providing the parent MainWindowBase instance hosting the controller by setting m_main and m_disp and eventually call init(). | |
| virtual void | onSelectedDataChanged (const DataList &) |
| Called by MainWindowBase in the case that the selection in the data model has changed. | |
| virtual void | onLocationChanged (Location newLocation) |
| Callback function called by the parent MainWindowBase/ControllerDecorator whenever the place was changed. | |
| Location | location () const |
| Convenience function to query the current controller Location from the parent ControllerDecorator. | |
| ControllerDecorator * | getDecorator () const |
| Convenience function to return m_main->getControllerDecorator(this) if m_main is set or nullptr otherwise. | |
| template<typename T> | |
| T * | getDecorator () const |
| Convenience function to dynamic_cast the return value of getDecorator() to a derived type. | |
| Public Member Functions inherited from ImFusion::Configurable | |
| virtual void | configure (const Properties *p) |
| Configure this object instance by de-serializing the given Properties. | |
| virtual void | configuration (Properties *p) const |
| Serialize the current object configuration into the given Properties object. | |
| virtual void | configureDefaults () |
| Retrieve the properties of this object, replaces values with their defaults and sets it again. | |
| void | registerParameter (ParameterBase *param) |
| Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration(). | |
| void | unregisterParameter (const ParameterBase *param) |
| Remove the given Parameter or SubProperty from the list of registered parameters. | |
| Configurable (const Configurable &rhs) | |
| Configurable (Configurable &&rhs) noexcept | |
| Configurable & | operator= (const Configurable &) |
| Configurable & | operator= (Configurable &&) noexcept |
| Public Member Functions inherited from ImFusion::SignalReceiver | |
| SignalReceiver ()=default | |
| Default constructor. | |
| SignalReceiver (const SignalReceiver &other) | |
| Copy constructor, does not copy any existing signal connections from other. | |
| SignalReceiver & | operator= (SignalReceiver rhs) |
| Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs. | |
| virtual | ~SignalReceiver () |
| Virtual destructor disconnects from all connected signals. | |
Static Public Member Functions | |
| static bool | createCompatible (const DataList &data, DataController **a=nullptr) |
| Static Public Member Functions inherited from ImFusion::DataController | |
| static bool | createCompatible (const DataList &, DataController **=0) |
| Factory interface for DataControllers: If data is compatible with data controller return true. | |
Protected Member Functions | |
| void | onNewStreamData (std::shared_ptr< const StreamData > streamData) |
| The function executed upon a new image. | |
| bool | supportsToolBar () const override |
| Subclasses can return true if they support showing their GUI in Location::ToolBar. | |
| Protected Member Functions inherited from ImFusion::SignalReceiver | |
| void | disconnectAll () |
| Disconnects all existing connections. | |
Additional Inherited Members | |
| Public Types inherited from ImFusion::Controller | |
| enum class | Location : int { Unknown = -1 , Naked = 0 , PrimaryDock = 1 , SecondaryDock = 2 , Detached = 3 , ToolBar = 4 , UserLocation = 100 } |
| Enumeration of possible placement/decoration options of a Controller. More... | |
| Public Attributes inherited from ImFusion::Controller | |
| Signal | signalTitleChanged |
| Signal emitted when the title() has changed. | |
| Public Attributes inherited from ImFusion::Configurable | |
| Signal | signalParametersChanged |
| Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted. | |
| Protected Attributes inherited from ImFusion::DataController | |
| std::string | m_factoryName |
| Protected Attributes inherited from ImFusion::Controller | |
| MainWindowBase * | m_main = nullptr |
| The parent MainWindowBase instance hosting this Controller. | |
| DisplayWidgetMulti * | m_disp = nullptr |
| The main DisplayWidget instance, convenience shortcut for m_main->display(). | |
| Protected Attributes inherited from ImFusion::Configurable | |
| std::vector< Param > | m_params |
| List of all registered Parameter and SubProperty instances. | |
|
overridevirtual |
Two-step initialization function to be implemented by subclasses.
This function is called by setMainWindowBase() after the m_disp and m_main attributes have been set and hence a complete initialization of the controller is possible at this point.
Reimplemented from ImFusion::DataController.
|
overridevirtual |
Returns the shown widget title if the controller is shown in a mode that supports this (e.g.
when in dock). Unless overridden, it returns the factory name.
Reimplemented from ImFusion::DataController.
|
overridevirtual |
React when a different stream is selected.
Reimplemented from ImFusion::Controller.
|
inlineoverrideprotectedvirtual |
Subclasses can return true if they support showing their GUI in Location::ToolBar.
This interface is used by the default implementation of supportedLocations() and preferredLocation() to decide whether to use Location::ToolBar.
Reimplemented from ImFusion::DataController.