Medical Imaging Interaction Toolkit  2018.4.99-0d336d68
Medical Imaging Interaction Toolkit
mitkPointOperation.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 MITKPOINTOPERATION_H
14 #define MITKPOINTOPERATION_H
15 
16 #include "mitkNumericTypes.h"
17 #include "mitkOperation.h"
18 #include <MitkCoreExports.h>
19 
20 namespace mitk
21 {
22  //##Documentation
23  //## @brief Operation that handles all actions on one Point.
24  //##
25  //## Stores everything for Adding, Moving and Deleting a Point.
26  //## @ingroup Undo
28  {
29  public:
30  //##Documentation
31  //##@brief Operation that handles all actions on one Point.
32  //##
33  //## @param operationType is the type of the operation (see mitkOperation.h; e.g. move or add; Information for
34  // StateMachine::ExecuteOperation());
35  //## @param point is the information of the point to add or is the information to change a point into
36  //## @param index is e.g. the position in a list which describes the element to change
37  PointOperation(OperationType operationType,
38  Point3D point,
39  int index = -1,
40  bool selected = true,
42 
43  //##Documentation
44  //##@brief Operation that handles all actions on one Point.
45  //##
46  //## @param operationType is the type of the operation (see mitkOperation.h; e.g. move or add; Information for
47  // StateMachine::ExecuteOperation());
48  //## @param point is the information of the point to add or is the information to change a point into
49  //## @param index is e.g. the position in a list which describes the element to change
50  PointOperation(OperationType operationType,
51  ScalarType timeInMS,
52  Point3D point,
53  int index = -1,
54  bool selected = true,
56 
57  ~PointOperation() override;
58 
59  Point3D GetPoint();
60 
61  int GetIndex();
62 
63  bool GetSelected();
64 
65  PointSpecificationType GetPointType();
66 
67  ScalarType GetTimeInMS() const;
68 
69  private:
70  Point3D m_Point;
71 
72  //##Documentation
73  //##@brief to declare an index where to store the point in data
74  int m_Index;
75 
76  // to declare weather the point is selected or deselected
77  bool m_Selected;
78 
79  //##Documentation
80  //##@brief to describe the type of the point. See enum PointSpecification for different types
82 
83  ScalarType m_TimeInMS;
84  };
85 } // namespace mitk
86 #endif /* MITKPOINTOPERATION_H*/
#define MITKCORE_EXPORT
Base class of all Operation-classes.
Definition: mitkOperation.h:29
double ScalarType
DataCollection - Class to facilitate loading/accessing structured data.
Operation that handles all actions on one Point.
int OperationType
Definition: mitkOperation.h:23
PointSpecificationType
enumeration of the type a point can be
Definition: mitkPoint.h:26