Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitk::Handle Class Referencefinal

Helper Class for realizing the handles of bounding object encapsulated by a geometry data. More...

#include <mitkBoundingShapeUtil.h>

Public Member Functions

 Handle ()
 Default constructor. Creates an inactive handle at the origin. More...
 
 Handle (mitk::Point3D pos, int index, std::vector< int > faceIndices, bool active=false)
 Construct a handle with a given position, index, and associated face indices. More...
 
 ~Handle ()
 
bool IsActive ()
 Return true if the handle is currently active (selected). More...
 
bool IsNotActive ()
 Return true if the handle is not active. More...
 
void SetActive (bool status)
 Set the active (selected) state of the handle. More...
 
void SetIndex (int index)
 Set the index identifying this handle. More...
 
int GetIndex ()
 Return the index identifying this handle. More...
 
std::vector< int > GetFaceIndices ()
 Return the corner-point indices of the face associated with this handle. More...
 
void SetPosition (mitk::Point3D pos)
 Set the 3D world position of the handle. More...
 
mitk::Point3D GetPosition ()
 Return the 3D world position of the handle. More...
 

Detailed Description

Helper Class for realizing the handles of bounding object encapsulated by a geometry data.

Definition at line 77 of file mitkBoundingShapeUtil.h.

Constructor & Destructor Documentation

◆ Handle() [1/2]

mitk::Handle::Handle ( )

Default constructor. Creates an inactive handle at the origin.

◆ Handle() [2/2]

mitk::Handle::Handle ( mitk::Point3D  pos,
int  index,
std::vector< int >  faceIndices,
bool  active = false 
)

Construct a handle with a given position, index, and associated face indices.

Parameters
posThe 3D position of the handle.
indexThe handle index (0-5).
faceIndicesIndices of the four corner points forming the associated face.
activeWhether the handle is initially active.

◆ ~Handle()

mitk::Handle::~Handle ( )

Member Function Documentation

◆ GetFaceIndices()

std::vector<int> mitk::Handle::GetFaceIndices ( )

Return the corner-point indices of the face associated with this handle.

◆ GetIndex()

int mitk::Handle::GetIndex ( )

Return the index identifying this handle.

◆ GetPosition()

mitk::Point3D mitk::Handle::GetPosition ( )

Return the 3D world position of the handle.

◆ IsActive()

bool mitk::Handle::IsActive ( )

Return true if the handle is currently active (selected).

◆ IsNotActive()

bool mitk::Handle::IsNotActive ( )

Return true if the handle is not active.

◆ SetActive()

void mitk::Handle::SetActive ( bool  status)

Set the active (selected) state of the handle.

◆ SetIndex()

void mitk::Handle::SetIndex ( int  index)

Set the index identifying this handle.

◆ SetPosition()

void mitk::Handle::SetPosition ( mitk::Point3D  pos)

Set the 3D world position of the handle.


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