Medical Imaging Interaction Toolkit  2023.04.00
Medical Imaging Interaction Toolkit
mitkNavigationDataPlayerBase.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 mitkNavigationDataPlayerBase_h
14 #define mitkNavigationDataPlayerBase_h
15 
17 #include "mitkNavigationDataSet.h"
18 
19 namespace mitk{
29  class MITKIGT_EXPORT NavigationDataPlayerBase
30  : public NavigationDataSource
31  {
32  public:
34 
38  itkSetMacro(Repeat, bool);
39 
43  itkGetMacro(Repeat, bool);
44 
48  void UpdateOutputInformation() override;
49 
51 
60  void SetNavigationDataSet(NavigationDataSet::Pointer navigationDataSet);
61 
67  unsigned int GetNumberOfSnapshots();
68 
69  unsigned int GetCurrentSnapshotNumber();
70 
76  bool IsAtEnd();
77 
78  protected:
80  ~NavigationDataPlayerBase() override;
81 
85  void GenerateData() override = 0;
86 
91  void InitPlayer();
92 
98  void GraftEmptyOutput();
99 
103  bool m_Repeat;
104 
106 
111  };
112 } // namespace mitk
113 
114 #endif
mitk::NavigationDataPlayerBase::m_NavigationDataSetIterator
mitk::NavigationDataSet::NavigationDataSetConstIterator m_NavigationDataSetIterator
Iterator always points to the NavigationData object which is in the outputs at the moment.
Definition: mitkNavigationDataPlayerBase.h:110
mitkNavigationDataSource.h
itk::SmartPointer< Self >
mitk::NavigationDataSource
Navigation Data source.
Definition: mitkNavigationDataSource.h:40
mitk
DataCollection - Class to facilitate loading/accessing structured data.
Definition: RenderingTests.dox:1
mitk::NavigationDataSet
Data structure which stores streams of mitk::NavigationData for multiple tools.
Definition: mitkNavigationDataSet.h:29
mitk::NavigationDataPlayerBase::m_Repeat
bool m_Repeat
If the player should repeat outputs. Default is false.
Definition: mitkNavigationDataPlayerBase.h:103
mitkNavigationDataSet.h
mitk::NavigationDataSet::NavigationDataSetConstIterator
std::vector< std::vector< mitk::NavigationData::Pointer > >::const_iterator NavigationDataSetConstIterator
This iterator iterates over the distinct time steps in this set. And is const.
Definition: mitkNavigationDataSet.h:47
mitk::NavigationDataPlayerBase::m_NavigationDataSet
NavigationDataSet::Pointer m_NavigationDataSet
Definition: mitkNavigationDataPlayerBase.h:105
mitkClassMacro
#define mitkClassMacro(className, SuperClassName)
Definition: mitkCommon.h:36
mitk::NavigationDataPlayerBase
Base class for using mitk::NavigationData as a filter source. Subclasses can play objects of mitk::Na...
Definition: mitkNavigationDataPlayerBase.h:29