Operation for setting a plane defined by its origin and normal or axis vectors. More...

#include <mitkPlaneOperation.h>

Inheritance diagram for mitk::PlaneOperation:

Collaboration diagram for mitk::PlaneOperation:

Public Member Functions
	PlaneOperation (OperationType operationType, Point3D point, Vector3D normal)
	Construct a plane operation from a point and a normal vector. More...

	PlaneOperation (OperationType operationType, Point3D point, Vector3D axisVec0, Vector3D axisVec1)
	Construct a plane operation from a point and two axis vectors. More...

	~PlaneOperation () override

Vector3D	GetNormal ()
	Get the normal vector of the plane. Only valid if constructed with a normal. More...

Vector3D	GetAxisVec0 ()
	Get the first in-plane axis vector. Only valid if AreAxisDefined() returns true. More...

Vector3D	GetAxisVec1 ()
	Get the second in-plane axis vector. Only valid if AreAxisDefined() returns true. More...

bool	AreAxisDefined ()
	Check whether the axis vectors were defined in the constructor. More...

Public Member Functions inherited from mitk::PointOperation
	PointOperation (OperationType operationType, Point3D point, int index=-1, bool selected=true, PointSpecificationType type=PTUNDEFINED)
	Construct a PointOperation without a time stamp. More...

	PointOperation (OperationType operationType, ScalarType timeInMS, Point3D point, int index=-1, bool selected=true, PointSpecificationType type=PTUNDEFINED)
	Construct a PointOperation with a time stamp. More...

	~PointOperation () override

Point3D	GetPoint ()
	Get the 3D point coordinates stored in this operation. More...

int	GetIndex ()
	Get the index position of the point in the point set. More...

bool	GetSelected ()
	Get whether the point is selected. More...

PointSpecificationType	GetPointType ()
	Get the point specification type. More...

ScalarType	GetTimeInMS () const
	Get the time stamp of this operation in milliseconds. 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 for setting a plane defined by its origin and normal or axis vectors.

A PlaneOperation can be constructed in two ways:

With a point (origin) and a normal vector.
With a point (origin) and two in-plane axis vectors.

See also: PointOperation; PlaneGeometry

Definition at line 33 of file mitkPlaneOperation.h.

Constructor & Destructor Documentation

◆ PlaneOperation() [1/2]

mitk::PlaneOperation::PlaneOperation	(	OperationType	operationType,
		Point3D	point,
		Vector3D	normal
	)

Construct a plane operation from a point and a normal vector.

Parameters

operationType	The type of operation.
point	The origin of the plane.
normal	The normal vector of the plane.

◆ PlaneOperation() [2/2]

mitk::PlaneOperation::PlaneOperation	(	OperationType	operationType,
		Point3D	point,
		Vector3D	axisVec0,
		Vector3D	axisVec1
	)

Construct a plane operation from a point and two axis vectors.

Parameters

operationType	The type of operation.
point	The origin of the plane.
axisVec0	The first in-plane axis vector.
axisVec1	The second in-plane axis vector.

◆ ~PlaneOperation()

mitk::PlaneOperation::~PlaneOperation ( )

override

Member Function Documentation

◆ AreAxisDefined()

bool mitk::PlaneOperation::AreAxisDefined ( )

Check whether the axis vectors were defined in the constructor.

Returns: true if this operation was constructed with two axis vectors, false if constructed with a normal.

◆ GetAxisVec0()

Vector3D mitk::PlaneOperation::GetAxisVec0 ( )

Get the first in-plane axis vector. Only valid if AreAxisDefined() returns true.

◆ GetAxisVec1()

Vector3D mitk::PlaneOperation::GetAxisVec1 ( )

Get the second in-plane axis vector. Only valid if AreAxisDefined() returns true.

◆ GetNormal()

Vector3D mitk::PlaneOperation::GetNormal ( )

Get the normal vector of the plane. Only valid if constructed with a normal.

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

mitkPlaneOperation.h

Public Member Functions

Additional Inherited Members