mitk::BaseRendererHelper Namespace Reference

Helper functions related to BaseRenderer geometry alignment. More...

Functions
MITKCORE_EXPORT bool	IsRendererGeometryAlignedWithGeometry (BaseRenderer *renderer, const TimeGeometry *timeGeometry)
	Test if the given time geometry aligns with the current world geometry of the given base renderer. More...

Detailed Description

Helper functions related to BaseRenderer geometry alignment.

Function Documentation

IsRendererGeometryAlignedWithGeometry()

MITKCORE_EXPORT bool mitk::BaseRendererHelper::IsRendererGeometryAlignedWithGeometry	(	BaseRenderer *	renderer,
		const TimeGeometry *	timeGeometry
	)

Test if the given time geometry aligns with the current world geometry of the given base renderer.

To compare the two geometries, the given time geometry is first converted into an oriented time geometry depending on the current view direction of the base renderer. A time-extracted 3D geometry is created using the current time point of the global time navigation controller. If the bounding boxes of these two geometries are equal (within a small epsilon), the function returns true; otherwise false.

If the given time geometry is nullptr, the function returns true, since nullptr implies that no requirements on the geometry exist.

Parameters

[in]	renderer	The base renderer whose world geometry is compared.
[in]	timeGeometry	The time geometry to compare against. May be nullptr.

Returns

True if the geometries are aligned or if timeGeometry is nullptr, false otherwise.

Exceptions

mitk::Exception

If the selected time point is not covered by the time geometry.