ImFusion::US::SweepDisplayOptions Class Reference

#include <ImFusion/US/SweepDisplayOptions.h>

DataComponent to store UltrasoundSweep-specific rendering options. More...

Inheritance diagram for ImFusion::US::SweepDisplayOptions:

Detailed Description

DataComponent to store UltrasoundSweep-specific rendering options.

Public Types
enum class	RenderMode3d { Original , MaskZeroPixels , TransferFunction }
	Available options how the UltrasoundSweep should be rendered in an ImageView3D. More...

Public Member Functions
	SweepDisplayOptions (const UltrasoundSweep &sweep)
	SweepDisplayOptions (const SweepDisplayOptions &rhs)
SweepDisplayOptions &	operator= (const SweepDisplayOptions &rhs)
bool	operator== (const SweepDisplayOptions &rhs) const
std::string	id () const override
	Returns a unique string identifier for this type of data component.
Public Member Functions inherited from ImFusion::DataComponent< SweepDisplayOptions >
std::unique_ptr< DataComponentBase >	clone () const override
	Creates a clone of this data component.
std::unique_ptr< Subclass >	cloneDerived () const
bool	assign (const DataComponentBase &other) override
	Assigns the content of other to this data component.
bool	equals (const DataComponentBase &other) const override
	Compares this data component to other for equality.
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 Attributes
Parameter< bool >	p_linkMPR = {"linkMPR", false, this}
	Flag whether MPR views should automatically align with the currently selected frame (requires SweepDisplayDataController).
Parameter< bool >	p_showInMPR = {"showInMPR", true, this}
	Flag whether the sweep should be visible in MPR views.
Parameter< bool >	p_showIn3d = {"showIn3d", true, this}
	Flag whether the sweep should be visible in 3D views.
Parameter< RenderMode3d >	p_renderMode3d = {"renderMode3d", RenderMode3d::Original, this}
	Render mode to be used in 3D views.
Parameter< bool >	p_rulerVisible = {"rulerVisible", true, this}
	Flag whether the ruler should be visible in 2D views.
Public Attributes inherited from ImFusion::Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Additional Inherited Members
Protected Member Functions inherited from ImFusion::DataComponentBase
	DataComponentBase (const DataComponentBase &)=default
DataComponentBase &	operator= (const DataComponentBase &other)=default
Protected Attributes inherited from ImFusion::Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Enumeration Documentation

RenderMode3d

enum class ImFusion::US::SweepDisplayOptions::RenderMode3d

strong

Available options how the UltrasoundSweep should be rendered in an ImageView3D.

Enumerator
Original	Render with the original image intensities.
MaskZeroPixels	Render with the original image intensities but mask zero pixels.
TransferFunction	Apply window/level and the optional transfer function as specified in the corresponding DisplayOptions3d.

Member Function Documentation

id()

std::string ImFusion::US::SweepDisplayOptions::id ( ) const

overridevirtual

Returns a unique string identifier for this type of data component.

Note

To avoid conflicts make sure to include potential plugin names into this ID. Due to the modular architecture of the ImFusion library, uniqueness of IDs cannot be checked at compile time. However, DataComponentFactory will check the uniqueness of the ID during registration.

Implements ImFusion::DataComponentBase.

---

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

• ImFusion/US/SweepDisplayOptions.h