ASCDataDisplayHandlerBase Class Reference

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

Display handler that configures the visual representation of an AnatomicalStructureCollection element. More...

Inheritance diagram for ASCDataDisplayHandlerBase:

Detailed Description

Display handler that configures the visual representation of an AnatomicalStructureCollection element.

Public Member Functions
	ASCDataDisplayHandlerBase (std::function< std::unique_ptr< ASCVisualiser >(AnatomicalStructureCollection &arg)> construct)
	Constructor with a callback function that constructs an ASCVisualiser from an AnatomicalStructureCollection.
void	setDisplayOptionsWidgetDisabled (bool disabled)
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.

Protected Member Functions
virtual DataComponentBase &	getOrCreateDisplayOptions (Data &data)
Protected Member Functions inherited from SignalReceiver
void	disconnectAll ()
	Disconnects all existing connections.

Protected Attributes
bool	m_displayOptionsWidgetDisabled = false
	If set to true, the display options widget will not be created. This is useful for the case that another class (like ASCSet) handles the display.
std::unordered_map< const Data *, std::unique_ptr< ASCVisualiser > >	m_ascVisualisers

DataDisplayHandler interface
bool	handlesType (const Data *data) const override
	Check whether this specialization handles the given Data type.
bool	canBeShownInView (const Data *data, const GUI::View &view) const override
	Check whether a particular Data can be shown in the given view.
void	show (Data *data, GUI::View &view) override
	Visualize the given data in the given view.
void	hide (Data *data, GUI::View &view) override
	Remove the given data from the given view.
void	onViewDeleted (GUI::View &view) override
	Called if a view associated with this DataDisplayHandler is destroyed.
std::unique_ptr< QWidget >	createDisplayOptionsWidget (Data *data, GUI::DisplayBase &display, GUI::View &view) const override
	Provides an optional QtWidgets-based GUI to configure display options for the given data shown in view.

Member Function Documentation

handlesType()

bool handlesType ( const Data * data ) const

overridevirtual

Check whether this specialization handles the given Data type.

Checks should be as narrow as possible to avoid potential overlap with other handlers.

Implements DataDisplayHandler.

canBeShownInView()

bool canBeShownInView ( const Data * data, const GUI::View & view ) const

overridevirtual

Check whether a particular Data can be shown in the given view.

Used by DataDisplayHandler during view dispatch when calling show(). Should only be called if handlesType(data) == true.

Implements DataDisplayHandler.

show()

void show ( Data * data, GUI::View & view )

overridevirtual

Visualize the given data in the given view.

Should only be called if (handlesType(data) == true) && (canBeShownInView(data, view) == true).

Implements DataDisplayHandler.

hide()

void hide ( Data * data, GUI::View & view )

overridevirtual

Remove the given data from the given view.

Warning

Implementations must not access data beyond pointer comparison because the instance may already in the process of deletion when calling this function.

Implements DataDisplayHandler.

onViewDeleted()

void onViewDeleted ( GUI::View & view )

overridevirtual

Called if a view associated with this DataDisplayHandler is destroyed.

Reimplemented from DataDisplayHandler.

createDisplayOptionsWidget()

std::unique_ptr< QWidget > createDisplayOptionsWidget ( Data * data, GUI::DisplayBase & display, GUI::View & view ) const

overridevirtual

Provides an optional QtWidgets-based GUI to configure display options for the given data shown in view.

This function is used to enable InteractiveViewOptionsOverlay showing a suitable GUI for all data shown in its corresponding view. The default implementation returns nullptr.

Note

This function is still considered experimental and may be moved/changed in the future.

Reimplemented from DataDisplayHandler.

---

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

• AnatomyPlugin/include/ImFusion/AnatomyPlugin/ASCDataDisplayHandler.h