A visualization class for the structure of a MultiFileVolume; work in progress. More...

#include <mlMultiFileVolumeListDraftView.h>

Inheritance diagram for ml::MultiFileVolumeListDraftView:

Classes
struct	FrameInfo
	Collects all information about a frame to be displayed . More...

Public Member Functions
	MultiFileVolumeListDraftView ()
	Constructor. More...

virtual	~MultiFileVolumeListDraftView () override
	Destructor. More...

Protected Member Functions
virtual void	activateAttachments () override
	Called after changes of module fields which were done without handleNotification calls. More...

virtual void	handleNotification (Field *field) override
	Called when a parameter field is changed. More...

void	_setGeometricDefaults ()
	Sets fields to values such that volumes are displayed at their geometric correct position even if they overlap. More...

void	_setConvenienceDefaults ()
	Sets fields to values such that volumes are layouted in a way such that they can be overviewed well. More...

void	_updateVis ()
	Removes all currently displayed frames and adds those from the currently loaded or connected volume list. More...

void	_setUpTreeRoot ()
	Sets up the parent node under which all subtrees are appended. More...

void	_calculateVolumeShift (const FrameInfo &frameInfo, size_t timePoint, bool &appendDots, bool &allowDrawing, double &dotShiftX, double &dotShiftY, double &dotShiftZ) const
	Calculates whether the current volume or frame given by frameInfo shall (and where to) be drawn or whether it shall be skipped. More...

void	_appendTextStyle ()
	Appends the Open Inventor text style setting for the entire scene graph. More...

void	_appendVolumeList (FrameInfo &volumeListInfo)
	Appends all frames of all MultiFileVolumes of the given MultiFileVolumeList volList. More...

void	_appendVolume (FrameInfo &volumeInfo)
	Appends all frames of the MultiFileVolume volume with number volumeIndex from a number of numVolumes in a VolumeList. More...

void	_appendVolumeTreeAsFrames (FrameInfo &volumeInfo)
	Appends a tree to the root which displays one volume as heap of frames. More...

void	_appendFileNameSet (FrameInfo &fileNameSetInfo)
	Appends all frames of the file name set fileNameSet of volume with number volumeIndex from a number of numVolumes in a VolumeList. More...

void	_appendFileHandle (FrameInfo &handleInfo)
	Appends the frames corresponding to the given fileHandle. More...

void	_appendDCMTree (FrameInfo &dcmTreeInfo)
	Appends the frame defined by the given DCMTree if it is valid, otherwise it does nothing. More...

void	_appendPagedImage (FrameInfo &frameInfo, const PagedImage &imgProps)
	Appends the frame or volume defined by the given PagedImage if it is valid, otherwise it does nothing. More...

void	_appendFrameInventorScene (FrameInfo &frameInfo)
	Appends the Open Inventor scene graph for a frame. More...

void	_appendLocalRoot (FrameInfo &frameInfo)
	Appends the Open Inventor root for the local scene or the frame. More...

void	_appendColorSettings (FrameInfo &frameInfo)
	Appends the Open Inventor color settings for the frame. More...

void	_appendTransformation (FrameInfo &frameInfo)
	Appends the Open Inventor transformation of the frame. More...

void	_appendHandMadeTransformation (FrameInfo &frameInfo)
	Appends the Open Inventor frame transformations built manually from DCMTree tags. More...

void	_appendVolumeShift (FrameInfo &frameInfo, size_t overrideTimePoint=0u)
	Appends the Open Inventor transformations for frameInfo.tFrameIndex and possibly drawn abbreviation dots between time points; if overrideTimePoint != 0u then shift is calculated for overrideTimePoint instead of tFrameIndex. More...

void	_appendDotsAtVolumeLocation2 (FrameInfo &frameInfo)
	Append text which draws "..." at center of volume at position 2. More...

void	_appendTextAnnotationsToFrame (FrameInfo &frameInfo)
	Appends the string annotations to the frame. More...

void	_appendShapeGeometry (FrameInfo &frameInfo)
	Appends the Open Inventor line geometry of the frame for a single time point. More...

void	_appendVolumeCoordinateSystem (FrameInfo frameInfo)
	Appends the volume coordinate system if enabled. More...

Detailed Description

A visualization class for the structure of a MultiFileVolume; work in progress.

Definition at line 37 of file mlMultiFileVolumeListDraftView.h.

Constructor & Destructor Documentation

◆ MultiFileVolumeListDraftView()

ml::MultiFileVolumeListDraftView::MultiFileVolumeListDraftView ( )

Constructor.

Initializes the fields, the members and the field connections with the field container.

◆ ~MultiFileVolumeListDraftView()

virtual ml::MultiFileVolumeListDraftView::~MultiFileVolumeListDraftView ( )

overridevirtual

Destructor.

Member Function Documentation

◆ _appendColorSettings()

void ml::MultiFileVolumeListDraftView::_appendColorSettings ( FrameInfo & frameInfo )

protected

Appends the Open Inventor color settings for the frame.

◆ _appendDCMTree()

void ml::MultiFileVolumeListDraftView::_appendDCMTree ( FrameInfo & dcmTreeInfo )

protected

Appends the frame defined by the given DCMTree if it is valid, otherwise it does nothing.

The file handle if provided only for error messaging.

◆ _appendDotsAtVolumeLocation2()

void ml::MultiFileVolumeListDraftView::_appendDotsAtVolumeLocation2 ( FrameInfo & frameInfo )

protected

Append text which draws "..." at center of volume at position 2.

◆ _appendFileHandle()

void ml::MultiFileVolumeListDraftView::_appendFileHandle ( FrameInfo & handleInfo )

protected

Appends the frames corresponding to the given fileHandle.

◆ _appendFileNameSet()

void ml::MultiFileVolumeListDraftView::_appendFileNameSet ( FrameInfo & fileNameSetInfo )

protected

Appends all frames of the file name set fileNameSet of volume with number volumeIndex from a number of numVolumes in a VolumeList.

◆ _appendFrameInventorScene()

void ml::MultiFileVolumeListDraftView::_appendFrameInventorScene ( FrameInfo & frameInfo )

protected

Appends the Open Inventor scene graph for a frame.

◆ _appendHandMadeTransformation()

void ml::MultiFileVolumeListDraftView::_appendHandMadeTransformation ( FrameInfo & frameInfo )

protected

Appends the Open Inventor frame transformations built manually from DCMTree tags.

◆ _appendLocalRoot()

void ml::MultiFileVolumeListDraftView::_appendLocalRoot ( FrameInfo & frameInfo )

protected

Appends the Open Inventor root for the local scene or the frame.

◆ _appendPagedImage()

void ml::MultiFileVolumeListDraftView::_appendPagedImage	(	FrameInfo &	frameInfo,
		const PagedImage &	imgProps
	)

protected

Appends the frame or volume defined by the given PagedImage if it is valid, otherwise it does nothing.

The file handle if provided (only for error messaging).

◆ _appendShapeGeometry()

void ml::MultiFileVolumeListDraftView::_appendShapeGeometry ( FrameInfo & frameInfo )

protected

Appends the Open Inventor line geometry of the frame for a single time point.

◆ _appendTextAnnotationsToFrame()

void ml::MultiFileVolumeListDraftView::_appendTextAnnotationsToFrame ( FrameInfo & frameInfo )

protected

Appends the string annotations to the frame.

◆ _appendTextStyle()

void ml::MultiFileVolumeListDraftView::_appendTextStyle ( )

protected

Appends the Open Inventor text style setting for the entire scene graph.

◆ _appendTransformation()

void ml::MultiFileVolumeListDraftView::_appendTransformation ( FrameInfo & frameInfo )

protected

Appends the Open Inventor transformation of the frame.

◆ _appendVolume()

void ml::MultiFileVolumeListDraftView::_appendVolume ( FrameInfo & volumeInfo )

protected

Appends all frames of the MultiFileVolume volume with number volumeIndex from a number of numVolumes in a VolumeList.

◆ _appendVolumeCoordinateSystem()

void ml::MultiFileVolumeListDraftView::_appendVolumeCoordinateSystem ( FrameInfo frameInfo )

protected

Appends the volume coordinate system if enabled.

◆ _appendVolumeList()

void ml::MultiFileVolumeListDraftView::_appendVolumeList ( FrameInfo & volumeListInfo )

protected

Appends all frames of all MultiFileVolumes of the given MultiFileVolumeList volList.

◆ _appendVolumeShift()

void ml::MultiFileVolumeListDraftView::_appendVolumeShift	(	FrameInfo &	frameInfo,
		size_t	overrideTimePoint = `0u`
	)

protected

Appends the Open Inventor transformations for frameInfo.tFrameIndex and possibly drawn abbreviation dots between time points; if overrideTimePoint != 0u then shift is calculated for overrideTimePoint instead of tFrameIndex.

◆ _appendVolumeTreeAsFrames()

void ml::MultiFileVolumeListDraftView::_appendVolumeTreeAsFrames ( FrameInfo & volumeInfo )

protected

Appends a tree to the root which displays one volume as heap of frames.

◆ _calculateVolumeShift()

void ml::MultiFileVolumeListDraftView::_calculateVolumeShift	(	const FrameInfo &	frameInfo,
		size_t	timePoint,
		bool &	appendDots,
		bool &	allowDrawing,
		double &	dotShiftX,
		double &	dotShiftY,
		double &	dotShiftZ
	)		const

protected

Calculates whether the current volume or frame given by frameInfo shall (and where to) be drawn or whether it shall be skipped.

Parameters

frameInfo	The frame description.
timePoint	The time point for which the calculation shall be performed.
appendDots	Will be set to true/false whether frame dots shall be drawn or not at shift[X\|Y\|Z].
allowDrawing	Must input current drawing state flag and will be set to true/false whether the frame shall be drawn or not.
dotShiftX	Returns x draw position for dots if appendDots is true.
dotShiftY	Returns y draw position for dots if appendDots is true.
dotShiftZ	Returns z draw position for dots if appendDots is true.

◆ _setConvenienceDefaults()

void ml::MultiFileVolumeListDraftView::_setConvenienceDefaults ( )

protected

Sets fields to values such that volumes are layouted in a way such that they can be overviewed well.

◆ _setGeometricDefaults()

void ml::MultiFileVolumeListDraftView::_setGeometricDefaults ( )

protected

Sets fields to values such that volumes are displayed at their geometric correct position even if they overlap.

◆ _setUpTreeRoot()

void ml::MultiFileVolumeListDraftView::_setUpTreeRoot ( )

protected

Sets up the parent node under which all subtrees are appended.

◆ _updateVis()

void ml::MultiFileVolumeListDraftView::_updateVis ( )

protected

Removes all currently displayed frames and adds those from the currently loaded or connected volume list.

◆ activateAttachments()

virtual void ml::MultiFileVolumeListDraftView::activateAttachments ( )

overrideprotectedvirtual

Called after changes of module fields which were done without handleNotification calls.

Reimplemented from ml::MultiFileVolumeListBaseOutput.

◆ handleNotification()

virtual void ml::MultiFileVolumeListDraftView::handleNotification ( Field * field )

overrideprotectedvirtual

Called when a parameter field is changed.

Reimplemented from ml::MultiFileVolumeListBaseOutput.

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

FMEwork/ReleaseMeVis/Sources/ML/MLMultiFileVolumeListInventorOutputs/mlMultiFileVolumeListDraftView.h

Classes

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ MultiFileVolumeListDraftView()

◆ ~MultiFileVolumeListDraftView()

Member Function Documentation

◆ _appendColorSettings()

◆ _appendDCMTree()

◆ _appendDotsAtVolumeLocation2()

◆ _appendFileHandle()

◆ _appendFileNameSet()

◆ _appendFrameInventorScene()

◆ _appendHandMadeTransformation()

◆ _appendLocalRoot()

◆ _appendPagedImage()

◆ _appendShapeGeometry()

◆ _appendTextAnnotationsToFrame()

◆ _appendTextStyle()

◆ _appendTransformation()

◆ _appendVolume()

◆ _appendVolumeCoordinateSystem()

◆ _appendVolumeList()

◆ _appendVolumeShift()

◆ _appendVolumeTreeAsFrames()

◆ _calculateVolumeShift()

◆ _setConvenienceDefaults()

◆ _setGeometricDefaults()

◆ _setUpTreeRoot()

◆ _updateVis()

◆ activateAttachments()

◆ handleNotification()