ImFusion SDK 4.3
ProcessUltrasoundController Class Reference

#include <ImFusion/US/ProcessUltrasoundController.h>

Controller for the ProcessUltrasound settings. More...

+ Inheritance diagram for ProcessUltrasoundController:

Detailed Description

Controller for the ProcessUltrasound settings.

Controls the parameter of a ProcessUltrasound. Can be embedded in other controllers, such as ProcessUltrasoundStreamDataController.

It also draws the outline of the FrameGeometry on the view, and allows the user to directly manipulate it.

Public Types

enum class  Visualization { Original , Processed }
 
- Public Types inherited from 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 Slots

void updateGUI ()
 Update GUI from ProcessUltrasound parameters information.
 

Signals

void parametersChanged ()
 

Public Member Functions

 ProcessUltrasoundController (ProcessUltrasound *params)
 
void init () override
 Initializes the widget.
 
void setShowFanGeometry (bool newValue)
 Allow this controller to draw the GlFanGeometry if the checkbox is also checked.
 
void setAllowInteraction (bool newValue)
 Allow the user to interact with the geometry.
 
void showButtonLinkDepth (bool newValue)
 Allow to link the depth and frame size.
 
Visualization visualization () const
 
void setVisualization (const Visualization &visualization)
 
std::string title () const override
 Returns the shown widget title if the controller is shown in a mode that supports this (e.g. when in dock).
 
- Public Member Functions inherited from 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 onVisibleDataChanged (const DataList &)
 Called by MainWindowBase in the case that the currently visible data has changed.
 
virtual std::vector< LocationsupportedLocations () const
 Returns the list of locations in which this controller is allowed to be placed by the parent MainWindowBase.
 
virtual Location preferredLocation () const
 Returns the preferred location in which the parent MainWindowBase should place this controller.
 
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.
 
ControllerDecoratorgetDecorator () 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 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
 
Configurableoperator= (const Configurable &)
 
Configurableoperator= (Configurable &&) noexcept
 
- Public Member Functions inherited from SignalReceiver
 SignalReceiver ()=default
 Default constructor.
 
 SignalReceiver (const SignalReceiver &other)
 Copy constructor, does not copy any existing signal connections from other.
 
SignalReceiveroperator= (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.
 

Additional Inherited Members

- Public Attributes inherited from Controller
Signal signalTitleChanged
 Signal emitted when the title() has changed.
 
- Public Attributes inherited from Configurable
Signal signalParametersChanged
 Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
 
- Protected Member Functions inherited from SignalReceiver
void disconnectAll ()
 Disconnects all existing connections.
 
- Protected Attributes inherited from Controller
MainWindowBasem_main = nullptr
 The parent MainWindowBase instance hosting this Controller.
 
DisplayWidgetMultim_disp = nullptr
 The main DisplayWidget instance, convenience shortcut for m_main->display().
 
- Protected Attributes inherited from Configurable
std::vector< Paramm_params
 List of all registered Parameter and SubProperty instances.
 

Member Function Documentation

◆ init()

void init ( )
overridevirtual

Initializes the widget.

Implements Controller.

◆ title()

std::string title ( ) const
inlineoverridevirtual

Returns the shown widget title if the controller is shown in a mode that supports this (e.g. when in dock).

Implements Controller.


The documentation for this class was generated from the following file:
Search Tab / S to search, Esc to close