ASCDisplayOptions Class Reference

#include <AnatomyPlugin/include/ImFusion/AnatomyPlugin/ASCDisplayOptions.h>

DataComponent to store AnatomicalStructureCollection-specific rendering options for 3D views. More...

Inheritance diagram for ASCDisplayOptions:

Detailed Description

DataComponent to store AnatomicalStructureCollection-specific rendering options for 3D views.

Classes
struct	DefaultSystemStyleSheets
	These style sheets are created automatically in the constructor. More...

Public Types
enum class	GraphRenderMode { None , CurveEdges , DiameterEdges , Other }
enum class	ImageDisplayMode { None = 0 , Focus = 1 , All , Other }
using	StyleSheet = AnatomyPlugin::StyleSheet

Public Member Functions
	ASCDisplayOptions (const ASCDisplayOptions &rhs)
ASCDisplayOptions &	operator= (const ASCDisplayOptions &rhs)
bool	operator== (const ASCDisplayOptions &rhs) const
std::string	id () const override
	Returns a unique string identifier for this type of data component.
void	configuration (Properties *prop) const override
	Serialize the current object configuration into the given Properties object.
void	configure (const Properties *prop) override
	Configure this object instance by de-serializing the given Properties.
void	addStyleSheet (StyleSheet st)
	Appends a style sheet to the list of styles.
StyleSheet &	getOrAppendStyleSheet (const std::string &name)
void	removeStyleSheetsByName (const std::string &name)
std::vector< const StyleSheet::StyleRule * >	allStyles () const
	Convenience function to return a list of all style rules contained in enabled style sheets contained in this object.
Properties	combinedStyles (const AnatomicalStructureCollection &asc, const std::string &identifier, AnatomyPlugin::ContentType ct, const std::string &objectKey, const std::optional< std::set< std::string > > &pseudoClasses=std::nullopt) const
	Convenience function to return a mapping of StylePropertyName to values that apply to a given object of an AnatomicalStructureCollection.
Properties	combinedStyles (const AnatomicalStructure &as, AnatomyPlugin::ContentType ct, const std::string &objectKey, const std::optional< std::set< std::string > > &pseudoClasses=std::nullopt) const
Public Member Functions inherited from DataComponent< ASCDisplayOptions >
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 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 Attributes
SubPropertyList< StyleSheet >	p_styleSheets = {"StyleSheets", {}, this}
Parameter< GlMesh::RenderMode3d >	p_meshRenderMode = {"meshRenderMode", GlMesh::RenderMode3d::Surface, this}
Parameter< GlMesh::MaterialMode >	p_meshMaterialMode = {"meshMaterialMode", GlMesh::MaterialMode::Uniform, this}
Parameter< bool >	p_drawMeshCrossSections = {"drawMeshCrossSections", false, this}
Parameter< double >	p_meshAlpha
	For legacy reasons this parameter is called meshAlpha, but affects alpha of all contained objects.
Parameter< bool >	p_showLabels = {"showLabels", false, this}
Parameter< bool >	p_showDebugLabels = {"showDebugLabels", false, this}
Parameter< ImageDisplayMode >	p_showImages = {"showImages", ImageDisplayMode::None, this}
Parameter< bool >	p_showSplines = {"showSplines", true, this}
Parameter< bool >	p_showPointclouds = {"showPointclouds", true, this}
Parameter< GlPointCloud::MaterialMode >	p_pointcloudMaterialMode = {"pointcloudMaterialMode", GlPointCloud::MaterialMode::Uniform, this}
Parameter< bool >	p_showPlanes = {"showPlanes", false, this}
Parameter< GraphRenderMode >	p_graphRenderMode = {"graphRenderMode", GraphRenderMode::CurveEdges, this}
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Additional Inherited Members
Protected Member Functions inherited from DataComponentBase
	DataComponentBase (const DataComponentBase &)=default
DataComponentBase &	operator= (const DataComponentBase &other)=default
Protected Member Functions inherited from SignalReceiver
void	disconnectAll ()
	Disconnects all existing connections.
Protected Member Functions inherited from NotCopyable
	NotCopyable (NotCopyable &&) noexcept=default
NotCopyable &	operator= (NotCopyable &&) noexcept=default
	NotCopyable (const NotCopyable &)=delete
NotCopyable &	operator= (const NotCopyable &)=delete
Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Function Documentation

id()

std::string 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 DataComponentBase.

configuration()

void configuration ( Properties * p ) const

overridevirtual

Serialize the current object configuration into the given Properties object.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configure() for the inverse functionality

Reimplemented from Configurable.

configure()

void configure ( const Properties * p )

overridevirtual

Configure this object instance by de-serializing the given Properties.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configuration() for the inverse functionality

Reimplemented from Configurable.

Member Data Documentation

p_meshAlpha

Parameter<double> p_meshAlpha

Initial value:

= {
            "meshAlpha",
            1.,
            this}

For legacy reasons this parameter is called meshAlpha, but affects alpha of all contained objects.

---

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

• AnatomyPlugin/include/ImFusion/AnatomyPlugin/ASCDisplayOptions.h