#include <ImFusion/GUI/BasicImageProcessingController.h>

Controller for basic image processing tasks. More...

Inheritance diagram for BasicImageProcessingController:

Detailed Description

Controller for basic image processing tasks.

Public Slots
void	onApply ()
	Apply the chosen processing.

void	onSetProcessing (int val)
	Change of selected processing.

void	onUpdateCropping ()
	Called to update the visualization of the cropping.

void	onCroppingSize (bool flag)
	Called when the way of specifying cropping changes.

void	onGradationModeChanged (int idx)

void	onUpdateThreshold ()
	Called to update the visualization of thresholding.

Public Member Functions
	BasicImageProcessingController (BasicImageProcessing *algorithm)
	Constructor with the algorithm instance.

	~BasicImageProcessingController () override
	Destructor.

void	onAlgorithmParametersChanged () override
	Callback called when the Algorithm's signalParametersChanged signal was emitted.

void	init () override
	Initializes the widget.

Public Member Functions inherited from AlgorithmController
	AlgorithmController (Algorithm *algorithm)
	Creates a new AlgorithmController wrapping the given algorithm, which must not be null.

const Algorithm *	algorithm () const
	Returns the underlying Algorithm instance.

Algorithm *	algorithm ()

void	showInputData ()
	Shows the input data in the DisplayWidget.

InputDataVisibility	showsInputData ()
	Checks if the input data is currently visible in the DisplayWidget.

void	showHelp ()
	Attempts to open the user documentation page for the underlying algorithm.

std::optional< Filesystem::Path >	helpPath () const
	Returns the path to the user documentation page if it is available, std::nullopt otherwise.

std::string	title () const override
	Returns the original factory name of the underlying Algorithm.

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	onVisibleDataChanged (const DataList &)
	Called by MainWindowBase in the case that the currently visible data has changed.

virtual std::vector< Location >	supportedLocations () 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.

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 Configurable
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 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.

Public Member Functions inherited from GlObject
virtual Geometry::AlignedBox	boundsSpherical () const
	Get the spherical bounds of this GlObject in world space.

virtual void	setMatrix (const mat4 &m)
	Set the modelview matrix of this object.

virtual const mat4 &	matrix () const
	Return the modelview matrix.

virtual void	setVisible (bool visible)
	Set object visibility.

virtual bool	visible () const
	Return object visibility.

virtual void	setAlwaysVisible (bool alwaysVisible)
	Set if object is always visible.

virtual bool	alwaysVisible () const
	Return if object is always visible.

RenderingOrderGroup	renderingOrder () const
	Return current rendering order value for this GlObject.

void	setRenderingOrder (RenderingOrderGroup group)
	Set rendering order value for this GlObject.

void	setDraw3DIn2DView (bool draw3DIn2DView)

void	configure (const Properties *p) override
	Configure this object instance by de-serializing the given Properties.

void	configuration (Properties *p) const override
	Serialize the current object configuration into the given Properties object.

Protected Member Functions
void	draw (const GlView &view) override
	Draw the object in 3D space.

Geometry::AlignedBox	bounds () const override
	Get the axis-aligned bounding box of this GlObject in world space.

std::string	typeName () const override
	Return unique identifier for this object class used for serialization.

void	onManipulatorEvent (Manipulator src, void eventData) override
	Called when an event occurs.

void	onSelectedDataChanged (const DataList &data) override
	Called by MainWindowBase in the case that the selection in the data model has changed.

void	updateGradationMap ()

void	updateCroppingBoxVisibility ()

void	removeCroppingBox ()

Protected Member Functions inherited from AlgorithmController
virtual void	closeAlgorithm (bool executed=false)
	Removes the algorithm from the ApplicationController and closes the controller.

virtual void	onAlgorithmOutputChanged ()
	Callback called when the Algorithm's signalOutputChanged signal was emitted.

virtual void	duplicateAlgorithmOnSelectedData () const
	Instantiates a new copy of underlying Algorithm on the currently selected Data in the DataModel and adds it to the ApplicationController.

void	addToDataAndAnnotationModels (OwningDataList data)
	Adds the contents of data to the DataModel of the parent MainWindowBase.

Protected Member Functions inherited from SignalReceiver
void	disconnectAll ()
	Disconnects all existing connections.

Additional Inherited Members
Public Types inherited from AlgorithmController
enum class	InputDataVisibility { None = 0 , All = 1 , Some = 2 }
	Enumeration of possible return values for showsInputData(). More...

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 Types inherited from GlObject
enum	RenderingOrderGroup { RenderingGroupRest , RenderingGroupMesh , RenderingGroupManipulator }
	Enumeration to determine rendering order of GlObjects in GlSliceView and GlVolumeView. More...

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 Attributes inherited from AlgorithmController
Algorithm *	m_algorithm = nullptr
	The underlying algorithm.

Protected Attributes inherited from 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 Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Protected Attributes inherited from GlObject
mat4	m_matrix = mat4::Identity()
	Modelview transformation matrix of this object.

bool	m_visible = true
	Object visibility.

bool	m_alwaysVisible = false
	Object always visible.

bool	m_draw3DIn2DView
	Draw 3D objects in 2D views. This is to render 3D objects in projective 2D views. Property is not serialized.

RenderingOrderGroup	m_renderingOrder = RenderingGroupRest

Member Function Documentation

◆ onAlgorithmParametersChanged()

void onAlgorithmParametersChanged ( )

overridevirtual

Callback called when the Algorithm's signalParametersChanged signal was emitted.

Reimplemented from AlgorithmController.

◆ init()

void init ( )

overridevirtual

Initializes the widget.

Implements Controller.

◆ draw()

void draw ( const GlView & view )

overrideprotectedvirtual

Draw the object in 3D space.

Implements GlObject.

◆ bounds()

Geometry::AlignedBox bounds ( ) const

overrideprotectedvirtual

Get the axis-aligned bounding box of this GlObject in world space.

Return an empty (default-constructed) AlignedBox object if the GlObject does not reside in world space.

Implements GlObject.

◆ typeName()

std::string typeName ( ) const

overrideprotectedvirtual

Return unique identifier for this object class used for serialization.

Implements GlObject.

◆ onManipulatorEvent()

void onManipulatorEvent	(	Manipulator *	src,
		void *	eventData )

overrideprotectedvirtual

Called when an event occurs.

Parameters

src	source of the event
eventData	pointer to event data. Zero if no event data is provided.

Implements ManipulatorListener.

◆ onSelectedDataChanged()

void onSelectedDataChanged ( const DataList & )

overrideprotectedvirtual

Called by MainWindowBase in the case that the selection in the data model has changed.

Reimplemented from Controller.

The documentation for this class was generated from the following file:

ImFusion/GUI/BasicImageProcessingController.h

Detailed Description

Public Slots

Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Function Documentation

◆ onAlgorithmParametersChanged()

◆ init()

◆ draw()

◆ bounds()

◆ typeName()

◆ onManipulatorEvent()

◆ onSelectedDataChanged()