Medical Imaging Interaction Toolkit  2018.4.99-b20efe7f
Medical Imaging Interaction Toolkit
mitk::Gizmo Class Reference

#include <mitkGizmo.h>

Inheritance diagram for mitk::Gizmo:
Collaboration diagram for mitk::Gizmo:

Public Types

enum  AxisType { AxisX, AxisY, AxisZ }
 Names for the three axes. More...
 
enum  HandleType {
  MoveFreely, MoveAlongAxisX, MoveAlongAxisY, MoveAlongAxisZ,
  RotateAroundAxisX, RotateAroundAxisY, RotateAroundAxisZ, ScaleX,
  ScaleY, ScaleZ, NoHandle
}
 Names for the different parts of the gizmo. More...
 
- Public Types inherited from mitk::Surface
typedef itk::ImageRegion< 5 > RegionType
 
typedef Surface Self
 
typedef BaseData Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Public Types inherited from mitk::BaseData
typedef BaseData Self
 
typedef itk::DataObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Public Types inherited from mitk::Identifiable
using UIDType = std::string
 

Public Member Functions

 mitkClassMacro (Gizmo, Surface)
 
virtual Point3D GetCenter () const
 
virtual void SetCenter (Point3D _arg)
 
virtual Vector3D GetAxisX () const
 
virtual void SetAxisX (Vector3D _arg)
 
virtual Vector3D GetAxisY () const
 
virtual void SetAxisY (Vector3D _arg)
 
virtual Vector3D GetAxisZ () const
 
virtual void SetAxisZ (Vector3D _arg)
 
virtual Vector3D GetRadius () const
 
virtual void SetRadius (Vector3D _arg)
 
virtual bool GetAllowTranslation () const
 
virtual void SetAllowTranslation (bool _arg)
 
virtual void AllowTranslationOn ()
 
virtual void AllowTranslationOff ()
 
virtual bool GetAllowRotation () const
 
virtual void SetAllowRotation (bool _arg)
 
virtual void AllowRotationOn ()
 
virtual void AllowRotationOff ()
 
virtual bool GetAllowScaling () const
 
virtual void SetAllowScaling (bool _arg)
 
virtual void AllowScalingOn ()
 
virtual void AllowScalingOff ()
 
double GetLongestRadius () const
 Return the longest of the three axes. More...
 
void UpdateRepresentation ()
 Updates the representing surface object after changes to center, axes, or radius. More...
 
void FollowGeometry (BaseGeometry *geom)
 
void OnFollowedGeometryModified ()
 The ITK callback to receive modified events of the followed geometry. More...
 
HandleType GetHandleFromPointID (vtkIdType id)
 
mitk::Gizmo::HandleType GetHandleFromPointDataValue (double value)
 
- Public Member Functions inherited from mitk::Surface
virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
void CalculateBoundingBox ()
 
void CopyInformation (const itk::DataObject *data) override
 
void ExecuteOperation (Operation *operation) override
 overwrite if the Data can be called by an Interactor (StateMachine). More...
 
void Expand (unsigned int timeSteps=1) override
 Expands the TimeGeometry to a number of TimeSteps. More...
 
const RegionTypeGetLargestPossibleRegion () const
 
virtual const RegionTypeGetRequestedRegion () const
 
unsigned int GetSizeOfPolyDataSeries () const
 
virtual vtkPolyData * GetVtkPolyData (unsigned int t=0) const
 
void Graft (const DataObject *data) override
 
bool IsEmptyTimeStep (unsigned int t) const override
 Check whether object contains data (at a specified time), e.g., a set of points may be empty. More...
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 Determine whether the RequestedRegion is outside of the BufferedRegion. More...
 
void SetRequestedRegion (const itk::DataObject *data) override
 Set the requested region from this data object to match the requested region of the data object passed in as a parameter. More...
 
virtual void SetRequestedRegion (Surface::RegionType *region)
 
void SetRequestedRegionToLargestPossibleRegion () override
 Set the RequestedRegion to the LargestPossibleRegion. More...
 
virtual void SetVtkPolyData (vtkPolyData *polydata, unsigned int t=0)
 
virtual void Swap (Surface &other)
 
void Update () override
 
void UpdateOutputInformation () override
 
bool VerifyRequestedRegion () override
 Verify that the RequestedRegion is within the LargestPossibleRegion. More...
 
- Public Member Functions inherited from mitk::BaseData
BaseProperty::ConstPointer GetConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) const override
 Get property by its key. More...
 
std::vector< std::string > GetPropertyKeys (const std::string &contextName="", bool includeDefaultContext=false) const override
 Query keys of existing properties. More...
 
std::vector< std::string > GetPropertyContextNames () const override
 Query names of existing contexts. More...
 
BasePropertyGetNonConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) override
 Get property by its key. More...
 
void SetProperty (const std::string &propertyKey, BaseProperty *property, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
 Add new or change existent property. More...
 
void RemoveProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
 Removes a property. If the property does not exist, nothing will be done. More...
 
const mitk::TimeGeometryGetTimeGeometry () const
 Return the TimeGeometry of the data as const pointer. More...
 
const mitk::TimeGeometryGetTimeSlicedGeometry () const
 Return the TimeGeometry of the data as const pointer. More...
 
mitk::TimeGeometryGetTimeGeometry ()
 Return the TimeGeometry of the data as pointer. More...
 
const mitk::TimeGeometryGetUpdatedTimeGeometry ()
 Return the TimeGeometry of the data. More...
 
const mitk::TimeGeometryGetUpdatedTimeSliceGeometry ()
 Return the TimeGeometry of the data. More...
 
const mitk::BaseGeometryGetUpdatedGeometry (int t=0)
 Return the BaseGeometry of the data at time t. More...
 
mitk::BaseGeometryGetGeometry (int t=0) const
 Return the geometry, which is a TimeGeometry, of the data as non-const pointer. More...
 
void UpdateOutputInformation () override
 Update the information for this BaseData (the geometry in particular) so that it can be used as an output of a BaseProcess. More...
 
void CopyInformation (const itk::DataObject *data) override
 Copy information from the specified data set. More...
 
virtual bool IsInitialized () const
 Check whether the data has been initialized, i.e., at least the Geometry and other header data has been set. More...
 
virtual void Clear ()
 Calls ClearData() and InitializeEmpty();. More...
 
virtual bool IsEmpty () const
 Check whether object contains data (at least at one point in time), e.g., a set of points may be empty. More...
 
virtual void SetGeometry (BaseGeometry *aGeometry3D)
 Set the BaseGeometry of the data, which will be referenced (not copied!). Assumes the data object has only 1 time step ( is a 3D object ) and creates a new TimeGeometry which saves the given BaseGeometry. If an TimeGeometry has already been set for the object, it will be replaced after calling this function. More...
 
virtual void SetTimeGeometry (TimeGeometry *geometry)
 Set the TimeGeometry of the data, which will be referenced (not copied!). More...
 
virtual void SetClonedGeometry (const BaseGeometry *aGeometry3D)
 Set a clone of the provided Geometry as Geometry of the data. Assumes the data object has only 1 time step ( is a 3D object ) and creates a new TimeGeometry. If an TimeGeometry has already been set for the object, it will be replaced after calling this function. More...
 
virtual void SetClonedTimeGeometry (const TimeGeometry *geometry)
 Set a clone of the provided TimeGeometry as TimeGeometry of the data. More...
 
virtual void SetClonedGeometry (const BaseGeometry *aGeometry3D, unsigned int time)
 Set a clone of the provided geometry as BaseGeometry of a given time step. More...
 
mitk::PropertyList::Pointer GetPropertyList () const
 Get the data's property list. More...
 
void SetPropertyList (PropertyList *propertyList)
 Set the data's property list. More...
 
mitk::BaseProperty::Pointer GetProperty (const char *propertyKey) const
 Get the property (instance of BaseProperty) with key propertyKey from the PropertyList, and set it to this, respectively;. More...
 
void SetProperty (const char *propertyKey, BaseProperty *property)
 
virtual void SetOrigin (const Point3D &origin)
 Convenience method for setting the origin of the BaseGeometry instances of all time steps. More...
 
itk::SmartPointer< mitk::BaseDataSourceGetSource () const
 Get the process object that generated this data object. More...
 
unsigned int GetTimeSteps () const
 Get the number of time steps from the TimeGeometry As the base data has not a data vector given by itself, the number of time steps is defined over the time sliced geometry. In sub classes, a better implementation could be over the length of the data vector. More...
 
unsigned long GetMTime () const override
 Get the modified time of the last change of the contents this data object or its geometry. More...
 
void Graft (const DataObject *) override
 
- Public Member Functions inherited from mitk::OperationActor
 itkTypeMacroNoParent (OperationActor) virtual ~OperationActor()
 
- Public Member Functions inherited from mitk::Identifiable
 Identifiable ()
 
 Identifiable (const UIDType &uid)
 
 Identifiable (const Identifiable &)=delete
 
 Identifiable (Identifiable &&) noexcept
 
virtual ~Identifiable ()
 
Identifiableoperator= (const Identifiable &)=delete
 
Identifiableoperator= (Identifiable &&other) noexcept
 
virtual UIDType GetUID () const
 Get unique ID of an object. More...
 
- Public Member Functions inherited from mitk::IPropertyOwner
 ~IPropertyOwner () override
 
- Public Member Functions inherited from mitk::IPropertyProvider
virtual ~IPropertyProvider ()
 

Static Public Member Functions

static std::string HandleTypeToString (HandleType type)
 Conversion for any kind of logging/debug/... purposes. More...
 
static Pointer New ()
 
static DataNode::Pointer AddGizmoToNode (DataNode *node, DataStorage *storage)
 
static bool RemoveGizmoFromNode (DataNode *node, DataStorage *storage)
 
static bool HasGizmoAttached (mitk::DataNode *node, DataStorage *storage)
 
- Static Public Member Functions inherited from mitk::Surface
static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from mitk::BaseData
static const char * GetStaticNameOfClass ()
 

Protected Member Functions

 Gizmo ()
 
 ~Gizmo () override
 
 Gizmo (const Gizmo &)
 
Gizmooperator= (const Gizmo &)
 
vtkSmartPointer< vtkPolyData > BuildGizmo ()
 Creates a vtkPolyData representing the parameters defining the gizmo. More...
 
- Protected Member Functions inherited from mitk::Surface
virtual itk::LightObject::Pointer InternalClone () const override
 
 Surface ()
 
 ~Surface () override
 
 Surface (const Surface &other)
 
Surfaceoperator= (Surface other)
 
void ClearData () override
 reset to non-initialized state, release memory More...
 
void InitializeEmpty () override
 Pure virtual; Must be used in subclasses to get a data object to a valid state. Should at least create one empty object and call Superclass::InitializeTimeGeometry() to ensure an existing valid geometry. More...
 
- Protected Member Functions inherited from mitk::BaseData
 BaseData ()
 
 BaseData (const BaseData &other)
 
 ~BaseData () override
 
virtual void InitializeTimeGeometry (unsigned int timeSteps=1)
 Initialize the TimeGeometry for a number of time steps. The TimeGeometry is initialized empty and evenly timed. In many cases it will be necessary to overwrite this in sub-classes. More...
 
virtual void InitializeTimeSlicedGeometry (unsigned int timeSteps=1)
 Initialize the TimeGeometry for a number of time steps. The TimeGeometry is initialized empty and evenly timed. In many cases it will be necessary to overwrite this in sub-classes. More...
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
- Protected Member Functions inherited from mitk::Identifiable
virtual void SetUID (const UIDType &uid)
 

Additional Inherited Members

- Protected Attributes inherited from mitk::BaseData
bool m_LastRequestedRegionWasOutsideOfTheBufferedRegion
 
unsigned int m_SourceOutputIndexDuplicate
 
bool m_Initialized
 

Detailed Description

A geometry manipulation "gizmo".

This class represents the principal axes of some arbitrary BaseGeometry.

The visualization shows the three axes x, y, and z along with a orthogonal ring around them. In its center, a small sphere is visualized.

The class is intended to be visualized along with another data object that "owns" the followed BaseGeometry. The Gizmo will automatically update itself to all modifications to the followed base geometry. Interactive modifications to the geometry can thus be easily visualized.

The gizmo is definded by

  • a center
  • three axes for x, y, and z
  • a radius

The radius determines the size of the axes and the rings around them.

A nice overview of similar / alternative representations can be found in "Schmidt R, Singh K, and Balakrishnan R. Sketching and Composing Widgets for 3D Manipulation. EUROGRAPHICS 2008"

See also
GizmoInteractor3D

Definition at line 49 of file mitkGizmo.h.

Member Enumeration Documentation

◆ AxisType

Names for the three axes.

Enumerator
AxisX 
AxisY 
AxisZ 

Definition at line 53 of file mitkGizmo.h.

◆ HandleType

Names for the different parts of the gizmo.

Enumerator
MoveFreely 
MoveAlongAxisX 
MoveAlongAxisY 
MoveAlongAxisZ 
RotateAroundAxisX 
RotateAroundAxisY 
RotateAroundAxisZ 
ScaleX 
ScaleY 
ScaleZ 
NoHandle 

Definition at line 61 of file mitkGizmo.h.

Constructor & Destructor Documentation

◆ Gizmo() [1/2]

mitk::Gizmo::Gizmo ( )
protected

Definition at line 216 of file mitkGizmo.cpp.

References UpdateRepresentation().

◆ ~Gizmo()

mitk::Gizmo::~Gizmo ( )
overrideprotected

Definition at line 233 of file mitkGizmo.cpp.

◆ Gizmo() [2/2]

mitk::Gizmo::Gizmo ( const Gizmo )
protected

Member Function Documentation

◆ AddGizmoToNode()

mitk::DataNode::Pointer mitk::Gizmo::AddGizmoToNode ( DataNode node,
DataStorage storage 
)
static

Convenience creation of a gizmo for given node

Parameters
nodeThe node holding the geometry to be visualized
storageThe DataStorage where a node holding the gizmo shall be added to (ignored when nullptr)
Returns
DataNode::Pointer containing the node used for vizualization of our gizmo

Definition at line 165 of file mitkGizmo.cpp.

References mitk::DataStorage::Add(), mitk::DataNode::GetData(), mitk::BaseData::GetGeometry(), us::ModuleRegistry::GetModule(), us::GetModuleContext(), mitk::DataNode::GetOpacity(), mitk::GizmoInteractor::New(), mitk::DataNode::New(), New(), mitk::DataNode::SetFloatProperty(), and mitk::DataNode::SetOpacity().

◆ AllowRotationOff()

virtual void mitk::Gizmo::AllowRotationOff ( )
virtual

◆ AllowRotationOn()

virtual void mitk::Gizmo::AllowRotationOn ( )
virtual

◆ AllowScalingOff()

virtual void mitk::Gizmo::AllowScalingOff ( )
virtual

◆ AllowScalingOn()

virtual void mitk::Gizmo::AllowScalingOn ( )
virtual

◆ AllowTranslationOff()

virtual void mitk::Gizmo::AllowTranslationOff ( )
virtual

◆ AllowTranslationOn()

virtual void mitk::Gizmo::AllowTranslationOn ( )
virtual

◆ BuildGizmo()

vtkSmartPointer< vtkPolyData > mitk::Gizmo::BuildGizmo ( )
protected

Creates a vtkPolyData representing the parameters defining the gizmo.

Definition at line 418 of file mitkGizmo.cpp.

References GetLongestRadius(), MoveAlongAxisX, MoveAlongAxisY, MoveAlongAxisZ, MoveFreely, NoHandle, RotateAroundAxisX, RotateAroundAxisY, RotateAroundAxisZ, ScaleX, ScaleY, and ScaleZ.

Referenced by UpdateRepresentation().

◆ FollowGeometry()

void mitk::Gizmo::FollowGeometry ( BaseGeometry geom)

Setup the gizmo to follow any ModifiedEvents of the given geometry. The object will adapt and update itself in function of the geometry's changes.

Definition at line 457 of file mitkGizmo.cpp.

References OnFollowedGeometryModified().

◆ GetAllowRotation()

virtual bool mitk::Gizmo::GetAllowRotation ( ) const
virtual

◆ GetAllowScaling()

virtual bool mitk::Gizmo::GetAllowScaling ( ) const
virtual

◆ GetAllowTranslation()

virtual bool mitk::Gizmo::GetAllowTranslation ( ) const
virtual

◆ GetAxisX()

virtual Vector3D mitk::Gizmo::GetAxisX ( ) const
virtual

◆ GetAxisY()

virtual Vector3D mitk::Gizmo::GetAxisY ( ) const
virtual

◆ GetAxisZ()

virtual Vector3D mitk::Gizmo::GetAxisZ ( ) const
virtual

◆ GetCenter()

virtual Point3D mitk::Gizmo::GetCenter ( ) const
virtual

◆ GetHandleFromPointDataValue()

mitk::Gizmo::HandleType mitk::Gizmo::GetHandleFromPointDataValue ( double  value)

Determine the nature of the the given vertex data value. Can be used after picking a vertex data value to determine what part of the gizmo has been picked.

Definition at line 494 of file mitkGizmo.cpp.

References CheckHandleType, MoveAlongAxisX, MoveAlongAxisY, MoveAlongAxisZ, MoveFreely, NoHandle, RotateAroundAxisX, RotateAroundAxisY, RotateAroundAxisZ, ScaleX, ScaleY, and ScaleZ.

Referenced by GetHandleFromPointID().

◆ GetHandleFromPointID()

mitk::Gizmo::HandleType mitk::Gizmo::GetHandleFromPointID ( vtkIdType  id)

Determine the nature of the the given vertex id. Can be used after picking a vertex id to determine what part of the gizmo has been picked.

Definition at line 514 of file mitkGizmo.cpp.

References GetHandleFromPointDataValue(), and mitk::Surface::GetVtkPolyData().

◆ GetLongestRadius()

double mitk::Gizmo::GetLongestRadius ( ) const

Return the longest of the three axes.

Definition at line 411 of file mitkGizmo.cpp.

References max().

Referenced by BuildGizmo().

◆ GetRadius()

virtual Vector3D mitk::Gizmo::GetRadius ( ) const
virtual

◆ HandleTypeToString()

std::string mitk::Gizmo::HandleTypeToString ( HandleType  type)
static

Conversion for any kind of logging/debug/... purposes.

Definition at line 523 of file mitkGizmo.cpp.

References CheckHandleType, MoveAlongAxisX, MoveAlongAxisY, MoveAlongAxisZ, MoveFreely, NoHandle, RotateAroundAxisX, RotateAroundAxisY, RotateAroundAxisZ, ScaleX, ScaleY, and ScaleZ.

◆ HasGizmoAttached()

bool mitk::Gizmo::HasGizmoAttached ( mitk::DataNode node,
DataStorage storage 
)
static
Returns
whether given node in given storage has a gizmo attached.

Definition at line 125 of file mitkGizmo.cpp.

References mitk::DataStorage::GetDerivations(), and mitk::TNodePredicateDataType< T >::New().

◆ mitkClassMacro()

mitk::Gizmo::mitkClassMacro ( Gizmo  ,
Surface   
)

◆ New()

static Pointer mitk::Gizmo::New ( )
static

Referenced by AddGizmoToNode().

◆ OnFollowedGeometryModified()

void mitk::Gizmo::OnFollowedGeometryModified ( )

The ITK callback to receive modified events of the followed geometry.

Definition at line 474 of file mitkGizmo.cpp.

References UpdateRepresentation().

Referenced by FollowGeometry().

◆ operator=()

Gizmo& mitk::Gizmo::operator= ( const Gizmo )
protected

◆ RemoveGizmoFromNode()

bool mitk::Gizmo::RemoveGizmoFromNode ( DataNode node,
DataStorage storage 
)
static

Convenience removal of gizmo from given node

Parameters
nodeThe node being currently manipulated
storageThe DataStorage where the gizmo has been added to
Returns
true if the gizmo has been found and removed successfully

Make sure to pass the same parameters here that you provided to a previous call to AddGizmoToNode.

Returns
DataNode::Pointer containing the node used for vizualization of our gizmo

Definition at line 132 of file mitkGizmo.cpp.

References mitk::PropertyList::DeleteProperty(), mitk::DataStorage::GetDerivations(), mitk::DataNode::GetFloatProperty(), mitk::DataNode::GetPropertyList(), mitk::TNodePredicateDataType< T >::New(), mitk::DataStorage::Remove(), and mitk::DataNode::SetOpacity().

◆ SetAllowRotation()

virtual void mitk::Gizmo::SetAllowRotation ( bool  _arg)
virtual

◆ SetAllowScaling()

virtual void mitk::Gizmo::SetAllowScaling ( bool  _arg)
virtual

◆ SetAllowTranslation()

virtual void mitk::Gizmo::SetAllowTranslation ( bool  _arg)
virtual

◆ SetAxisX()

virtual void mitk::Gizmo::SetAxisX ( Vector3D  _arg)
virtual

◆ SetAxisY()

virtual void mitk::Gizmo::SetAxisY ( Vector3D  _arg)
virtual

◆ SetAxisZ()

virtual void mitk::Gizmo::SetAxisZ ( Vector3D  _arg)
virtual

◆ SetCenter()

virtual void mitk::Gizmo::SetCenter ( Point3D  _arg)
virtual

◆ SetRadius()

virtual void mitk::Gizmo::SetRadius ( Vector3D  _arg)
virtual

◆ UpdateRepresentation()

void mitk::Gizmo::UpdateRepresentation ( )

Updates the representing surface object after changes to center, axes, or radius.

Definition at line 241 of file mitkGizmo.cpp.

References BuildGizmo(), mitk::BaseData::GetGeometry(), mitk::BaseData::GetTimeGeometry(), mitk::BaseGeometry::SetBounds(), mitk::Surface::SetVtkPolyData(), and mitk::TimeGeometry::Update().

Referenced by Gizmo(), and OnFollowedGeometryModified().


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