Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
mitkBaseRendererHelper.h
Go to the documentation of this file.
1 /*============================================================================
2 
3 The Medical Imaging Interaction Toolkit (MITK)
4 
5 Copyright (c) German Cancer Research Center (DKFZ)
6 All rights reserved.
7 
8 Use of this source code is governed by a 3-clause BSD license that can be
9 found in the LICENSE file.
10 
11 ============================================================================*/
12 
13 #ifndef mitkBaseRendererHelper_h
14 #define mitkBaseRendererHelper_h
15 
16 #include <mitkBaseRenderer.h>
17 #include <mitkTimeGeometry.h>
18 
19 namespace mitk
20 {
21  namespace BaseRendererHelper
22  {
23  /*
24  * \brief Test if the given time geometry aligns with the current world geometry of the given base renderer.
25  * To compare the two geometries the given time geometry is first converted into a oriented time geometry,
26  * depending on the current view direction of the base renderer.
27  * A time-extracted 3D geometry is created by using the current timepoint of the global time navigation
28  * controller.
29  * If the bounding boxes of these two geometries are equal (within a small epsilon), the function returns true,
30  * otherwise false.
31  * If the given time geometry is a nullptr, the function returns true as well, since a nullptr implies that
32  * no requirements on the geometry exist.
33  */
35 
36  } // namespace BaseRendererHelper
37 } // namespace mitk
38 
39 #endif
mitk::TimeGeometry
Definition: mitkTimeGeometry.h:45
mitkTimeGeometry.h
mitk
Find image slices visible on a given plane.
Definition: RenderingTests.dox:1
mitk::BaseRenderer
Definition: mitkBaseRenderer.h:56
mitk::BaseRendererHelper::IsRendererGeometryAlignedWithGeometry
MITKCORE_EXPORT bool IsRendererGeometryAlignedWithGeometry(BaseRenderer *renderer, const TimeGeometry *timeGeometry)
mitkBaseRenderer.h
MITKCORE_EXPORT
#define MITKCORE_EXPORT
Definition: MitkCoreExports.h:15