Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitk::RestorePlanePositionOperation Class Reference

Operation to restore a plane position defined by width, height, spacing, direction, and transform. More...

#include <mitkRestorePlanePositionOperation.h>

Inheritance diagram for mitk::RestorePlanePositionOperation:
Collaboration diagram for mitk::RestorePlanePositionOperation:

Public Member Functions

 RestorePlanePositionOperation (OperationType operationType, ScalarType width, ScalarType height, Vector3D spacing, unsigned int pos, Vector3D direction, AffineTransform3D::Pointer transform)
 Constructor. More...
 
 ~RestorePlanePositionOperation () override
 Destructor. More...
 
Vector3D GetDirectionVector ()
 Returns the direction vector of the plane. More...
 
ScalarType GetWidth ()
 Returns the width of the plane. More...
 
ScalarType GetHeight ()
 Returns the height of the plane. More...
 
Vector3D GetSpacing ()
 Returns the spacing vector of the plane geometry. More...
 
unsigned int GetPos ()
 Returns the position index of the slice. More...
 
AffineTransform3D::Pointer GetTransform ()
 Returns the affine transform defining the plane orientation. More...
 
- Public Member Functions inherited from mitk::Operation
 mitkClassMacroNoParent (Operation) virtual bool IsValid() const
 Check whether this operation is still valid and can be executed. More...
 
virtual ~Operation ()=default
 Virtual destructor. More...
 
OperationType GetOperationType ()
 Get the type identifier of this operation. More...
 

Additional Inherited Members

- Protected Member Functions inherited from mitk::Operation
 Operation (OperationType operationType)
 Construct an operation with the given type. More...
 
 Operation (const Operation &)=default
 
 Operation (Operation &&)=default
 
Operation & operator= (const Operation &)=default
 
Operation & operator= (Operation &&)=default
 
- Protected Attributes inherited from mitk::Operation
OperationType m_OperationType
 The type identifier for this operation. More...
 

Detailed Description

Operation to restore a plane position defined by width, height, spacing, direction, and transform.

This operation stores all parameters needed to restore a plane's position and orientation in the scene, typically used with undo/redo mechanisms.

See also
Operation

Definition at line 31 of file mitkRestorePlanePositionOperation.h.

Constructor & Destructor Documentation

◆ RestorePlanePositionOperation()

mitk::RestorePlanePositionOperation::RestorePlanePositionOperation ( OperationType  operationType,
ScalarType  width,
ScalarType  height,
Vector3D  spacing,
unsigned int  pos,
Vector3D  direction,
AffineTransform3D::Pointer  transform 
)

Constructor.

Parameters
operationTypethe type of operation.
widththe width of the plane.
heightthe height of the plane.
spacingthe spacing vector of the plane geometry.
posthe position index of the slice.
directionthe direction vector of the plane.
transformthe affine transform defining the plane orientation.

◆ ~RestorePlanePositionOperation()

mitk::RestorePlanePositionOperation::~RestorePlanePositionOperation ( )
override

Destructor.

Member Function Documentation

◆ GetDirectionVector()

Vector3D mitk::RestorePlanePositionOperation::GetDirectionVector ( )

Returns the direction vector of the plane.

Returns
The direction vector.

◆ GetHeight()

ScalarType mitk::RestorePlanePositionOperation::GetHeight ( )

Returns the height of the plane.

Returns
The plane height.

◆ GetPos()

unsigned int mitk::RestorePlanePositionOperation::GetPos ( )

Returns the position index of the slice.

Returns
The slice position index.

◆ GetSpacing()

Vector3D mitk::RestorePlanePositionOperation::GetSpacing ( )

Returns the spacing vector of the plane geometry.

Returns
The spacing vector.

◆ GetTransform()

AffineTransform3D::Pointer mitk::RestorePlanePositionOperation::GetTransform ( )

Returns the affine transform defining the plane orientation.

Returns
The affine transform.

◆ GetWidth()

ScalarType mitk::RestorePlanePositionOperation::GetWidth ( )

Returns the width of the plane.

Returns
The plane width.

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