iAVolumeViewer Class Reference

Class for managing all viewing aspects of volume datasets (3D renderer, slicers, histogram, line profile). More...

#include <iAVolumeViewer.h>

Inheritance diagram for iAVolumeViewer:

Collaboration diagram for iAVolumeViewer:

Public Member Functions
	iAVolumeViewer (iADataSet *dataSet)
	~iAVolumeViewer ()
void	createGUI (iAMdiChild *child, size_t dataSetIdx) override
	Should contain all things that need to be done in the GUI thread for viewing this dataset The default implementation creates a 3D renderer (via createRenderer method) and adds an entry to the dataset list.
std::shared_ptr< iADataSetRenderer >	createRenderer (vtkRenderer *ren, QVariantMap const &overrideValues) override
	Called to create a 3D renderer for the dataset.
iAChartWithFunctionsWidget *	histogram ()
	Access to the chart widget used for displaying the histogram.
std::shared_ptr< iAHistogramData >	histogramData (int component) const
	Access to the histogram data.
QString	information () const override
	Get information to display about the dataset.
void	prepare (iAProgress *p) override
	called directly after the dataset is loaded, should do anything that needs to be computed in the background
void	setPickable (bool pickable) override
void	showInSlicers (bool show)
	convenience function for showing/hiding dataset in slicer:
uint	slicerChannelID () const override
void	slicerRegionSelected (double minVal, double maxVal, uint channelID) override
	TODO NEWIO: improve!
iATransferFunction *	transfer ()
	Access to the transfer function used in renderer and slicer view.
void	unitDistanceChanged (std::array< double, 3 > oldUnitDist, iAMdiChild *child) override
	called when unit distance has changed due to dataset edit
iAImageData const *	volume () const
	Access to the displayed dataset.
Public Member Functions inherited from iADataSetViewer
QAction *	addViewAction (QString const &name, QString const &iconName, bool checked)
	helper function for creating and adding a toggling action for switching some aspect of this viewer needs to be called before calling createGUI of this base class (which passes the view actions created so far to the dataset list.
iAAttributes	attributesWithValues () const
	Retrieves the list of all attributes for this viewer, merged with their current values as default values:
QVariantMap	attributeValues () const
	Retrieve only the current attribute values.
bool	renderFlagSet (QChar const &flag) const
void	setAttributes (QVariantMap const &values)
	Call to change the attributes of this viewer.
void	setPickActionVisible (bool visible)
void	setRenderFlag (QChar const &flag, bool enable)
void	storeState ()
	called before a dataset is stored; stores the current viewer state into the metadata of the linked dataset (via attributeValues)
iADataSetRenderer *	renderer ()
iADataSetRenderer const *	renderer () const

Additional Inherited Members
Signals inherited from iADataSetViewer
void	dataSetChanged (size_t dataSetIdx)
void	removeDataSet (size_t dataSetIdx)
Static Public Attributes inherited from iADataSetViewer
static const QChar	Render3DFlag
static const QChar	RenderCutPlane
static const QString	RenderFlags
	key that specifies which views or renderers the viewer currently has visible
static const QChar	RenderMagicLensFlag
static const QChar	RenderOutlineFlag
Protected Member Functions inherited from iADataSetViewer
	iADataSetViewer (iADataSet *dataSet)
virtual	~iADataSetViewer ()
void	addAttribute (QString const &name, iAValueType valueType, QVariant defaultValue=0.0, double min=std::numeric_limits< double >::lowest(), double max=std::numeric_limits< double >::max())
	adds an attribute that can be modified by the user to change the appearance of some aspect of the viewer
Protected Attributes inherited from iADataSetViewer
QVariantMap	m_attribValues
iADataSet *	m_dataSet
	the dataset for which this viewer is responsible

Detailed Description

Class for managing all viewing aspects of volume datasets (3D renderer, slicers, histogram, line profile).

Constructor & Destructor Documentation

iAVolumeViewer()

iAVolumeViewer::iAVolumeViewer

(

iADataSet *

dataSet

)

~iAVolumeViewer()

iAVolumeViewer::~iAVolumeViewer

(

)

Member Function Documentation

createGUI()

void iAVolumeViewer::createGUI ( iAMdiChild * child, size_t dataSetIdx )

overridevirtual

Should contain all things that need to be done in the GUI thread for viewing this dataset The default implementation creates a 3D renderer (via createRenderer method) and adds an entry to the dataset list.

If you want these things to happen, but additionally some other things, call this function from the derived method (i.e. iADataSetViewer::createGUI). Sometimes, you might not want these things to happen (as e.g. the iAProjectViewer does, since it does not need a 3D viewer nor a dataset list entry),

Reimplemented from iADataSetViewer.

createRenderer()

std::shared_ptr< iADataSetRenderer > iAVolumeViewer::createRenderer ( vtkRenderer * ren, QVariantMap const & overrideValues )

overridevirtual

Called to create a 3D renderer for the dataset.

Override in derived class; used for both the "normal" 3D renderer and the magic lens renderer.

Parameters

ren	the vtk renderer to attach the created renderer to
overrideValues	(optional) parameter values for creating the renderer, overriding the default values that can be configured via Edit menu / iASettingsMananger

Reimplemented from iADataSetViewer.

histogram()

iAChartWithFunctionsWidget * iAVolumeViewer::histogram

(

)

Access to the chart widget used for displaying the histogram.

histogramData()

std::shared_ptr< iAHistogramData > iAVolumeViewer::histogramData

(

int

component

)

const

Access to the histogram data.

information()

QString iAVolumeViewer::information ( ) const

overridevirtual

Get information to display about the dataset.

Reimplemented from iADataSetViewer.

prepare()

void iAVolumeViewer::prepare ( iAProgress * p )

overridevirtual

called directly after the dataset is loaded, should do anything that needs to be computed in the background

Reimplemented from iADataSetViewer.

setPickable()

void iAVolumeViewer::setPickable ( bool pickable )

overridevirtual

Reimplemented from iADataSetViewer.

showInSlicers()

void iAVolumeViewer::showInSlicers

(

bool

show

)

convenience function for showing/hiding dataset in slicer:

slicerChannelID()

uint iAVolumeViewer::slicerChannelID ( ) const

overridevirtual

Reimplemented from iADataSetViewer.

slicerRegionSelected()

void iAVolumeViewer::slicerRegionSelected ( double minVal, double maxVal, uint channelID )

overridevirtual

TODO NEWIO: improve!

Reimplemented from iADataSetViewer.

transfer()

iATransferFunction * iAVolumeViewer::transfer

(

)

Access to the transfer function used in renderer and slicer view.

unitDistanceChanged()

void iAVolumeViewer::unitDistanceChanged ( std::array< double, 3 > oldUnitDist, iAMdiChild * child )

overridevirtual

called when unit distance has changed due to dataset edit

Reimplemented from iADataSetViewer.

volume()

iAImageData const * iAVolumeViewer::volume

(

)

const

Access to the displayed dataset.

---

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

• libs/guibase/iAVolumeViewer.h
• libs/guibase/iAVolumeViewer.cpp