mitk::CrosshairData Class Reference

Data class that stores the 3D position for a crosshair. More...

#include <mitkCrosshairData.h>

Inheritance diagram for mitk::CrosshairData:

Collaboration diagram for mitk::CrosshairData:

Public Member Functions
	mitkClassMacro (CrosshairData, BaseData)
virtual Point3D	GetPosition () const
virtual void	SetPosition (Point3D _arg)
void	SetRequestedRegionToLargestPossibleRegion () override
	Empty implementation; CrosshairData does not support the requested region concept. More...
bool	RequestedRegionIsOutsideOfTheBufferedRegion () override
	Empty implementation; CrosshairData does not support the requested region concept. More...
bool	VerifyRequestedRegion () override
	Empty implementation; CrosshairData does not support the requested region concept. More...
void	SetRequestedRegion (const itk::DataObject *data) override
	Empty implementation; CrosshairData does not support the requested region concept. More...
Public Member Functions inherited from mitk::BaseData
	mitkClassMacroItkParent (BaseData, itk::DataObject)
BaseProperty::ConstPointer	GetConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) const override
	Get a const property by its key. More...
std::vector< std::string >	GetPropertyKeys (const std::string &contextName="", bool includeDefaultContext=false) const override
	Get all property keys stored in the property list. More...
std::vector< std::string >	GetPropertyContextNames () const override
	Get the names of all property contexts. More...
BaseProperty *	GetNonConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) override
	Get a non-const property by its key. More...
void	SetProperty (const std::string &propertyKey, BaseProperty *property, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
	Set a property in the property list. More...
void	RemoveProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
	Remove a property from the property list. More...
const mitk::TimeGeometry *	GetTimeGeometry () const
	Return the TimeGeometry of the data as const pointer. More...
mitk::TimeGeometry *	GetTimeGeometry ()
	Return the TimeGeometry of the data as non-const pointer. More...
const mitk::TimeGeometry *	GetUpdatedTimeGeometry ()
	Return the TimeGeometry of the data after ensuring it is up-to-date. More...
virtual void	Expand (unsigned int timeSteps)
	Expand the TimeGeometry to a number of time steps. More...
const mitk::BaseGeometry *	GetUpdatedGeometry (int t=0)
	Return the BaseGeometry of the data at time step t after ensuring it is up-to-date. More...
mitk::BaseGeometry *	GetGeometry (int t=0) const
	Return the BaseGeometry of the data at time step t as a non-const pointer. More...
void	UpdateOutputInformation () override
	Update the information for this BaseData 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. More...
virtual void	Clear ()
	Reset the data object by calling ClearData() and InitializeEmpty(). More...
virtual bool	IsEmptyTimeStep (unsigned int t) const
	Check whether the object contains data at the specified time step. More...
virtual bool	IsEmpty () const
	Check whether the object contains data at any time step. More...
void	ExecuteOperation (Operation *operation) override
	Execute an operation on this data object. More...
virtual void	SetGeometry (BaseGeometry *aGeometry3D)
	Set the BaseGeometry of the data, which will be referenced (not copied!). 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 the BaseGeometry of the data. More...
virtual void	SetClonedTimeGeometry (const TimeGeometry *geometry)
	Set a clone of the provided TimeGeometry as the TimeGeometry of the data. More...
virtual void	SetClonedGeometry (const BaseGeometry *aGeometry3D, unsigned int time)
	Set a clone of the provided geometry as the 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, replacing the existing one. More...
mitk::BaseProperty::Pointer	GetProperty (const char *propertyKey) const
	Get a property by its key from the PropertyList. More...
void	SetProperty (const char *propertyKey, BaseProperty *property)
	Set a property in the PropertyList. More...
virtual void	SetOrigin (const Point3D &origin)
	Convenience method for setting the origin of the BaseGeometry instances of all time steps. More...
itk::SmartPointer< mitk::BaseDataSource >	GetSource () const
	Get the process object that generated this data object. More...
unsigned int	GetTimeSteps () const
	Get the number of time steps from the TimeGeometry. More...
itk::ModifiedTimeType	GetMTime () const override
	Get the modification time of this data object or its geometry, whichever was modified most recently. More...
void	Graft (const DataObject *) override
	Graft data and information from another data object. More...
Public Member Functions inherited from mitk::OperationActor
	itkTypeMacroNoParent (OperationActor) virtual ~OperationActor()
Public Member Functions inherited from mitk::Identifiable
	Identifiable ()
	Default constructor. Generates a new random UID. More...
	Identifiable (const UIDType &uid)
	Construct with a pre-existing UID. More...
	Identifiable (const Identifiable &)=delete
	Copy construction is deleted to prevent UID duplication. More...
	Identifiable (Identifiable &&) noexcept
	Move constructor. Transfers ownership of the UID. More...
virtual	~Identifiable ()
	Virtual destructor. More...
Identifiable &	operator= (const Identifiable &)=delete
	Copy assignment is deleted to prevent UID duplication. More...
Identifiable &	operator= (Identifiable &&other) noexcept
	Move assignment operator. Transfers ownership of the UID. More...
virtual UIDType	GetUID () const
	Get the unique identifier of this object. More...
UIDType	GetRuntimeUID () const noexcept
	Get a runtime-unique ID for this object instance. More...
Public Member Functions inherited from mitk::IPropertyOwner
	~IPropertyOwner () override
virtual bool	PropertyIsOwned (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) const
	Checks if a certain property exists. More...
Public Member Functions inherited from mitk::IPropertyProvider
virtual	~IPropertyProvider ()
	Virtual destructor. More...

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	CrosshairData ()
	Constructor. More...
	~CrosshairData () override
	Destructor. 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	ClearData ()
	reset to non-initialized state, release memory More...
virtual void	InitializeEmpty ()
	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...
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
Protected Member Functions inherited from mitk::Identifiable
virtual void	SetUID (const UIDType &uid)

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

Additional Inherited Members
Public Types inherited from mitk::Identifiable
using	UIDType = std::string
	Type alias for unique identifiers. More...

Detailed Description

Data class that stores the 3D position for a crosshair.

CrosshairData is a simple BaseData subclass that holds a single 3D point representing the crosshair position. It is used by CrosshairManager and rendered by CrosshairVtkMapper2D.

This class does not support the requested region concept; all region methods are implemented as no-ops.

See also

CrosshairManager

CrosshairVtkMapper2D

Definition at line 34 of file mitkCrosshairData.h.

Constructor & Destructor Documentation

CrosshairData()

mitk::CrosshairData::CrosshairData ( )

protected

Constructor.

~CrosshairData()

mitk::CrosshairData::~CrosshairData ( )

overrideprotected

Destructor.

Member Function Documentation

GetPosition()

virtual Point3D mitk::CrosshairData::GetPosition ( ) const

virtual

mitkClassMacro()

mitk::CrosshairData::mitkClassMacro	(	CrosshairData	,
		BaseData
	)

New()

static Pointer mitk::CrosshairData::New ( )

static

RequestedRegionIsOutsideOfTheBufferedRegion()

bool mitk::CrosshairData::RequestedRegionIsOutsideOfTheBufferedRegion ( )

overridevirtual

Empty implementation; CrosshairData does not support the requested region concept.

Returns

Always false.

Implements mitk::BaseData.

SetPosition()

virtual void mitk::CrosshairData::SetPosition ( Point3D  _arg )

virtual

SetRequestedRegion()

void mitk::CrosshairData::SetRequestedRegion ( const itk::DataObject *  data )

overridevirtual

Empty implementation; CrosshairData does not support the requested region concept.

Implements mitk::BaseData.

SetRequestedRegionToLargestPossibleRegion()

void mitk::CrosshairData::SetRequestedRegionToLargestPossibleRegion ( )

overridevirtual

Empty implementation; CrosshairData does not support the requested region concept.

Implements mitk::BaseData.

VerifyRequestedRegion()

bool mitk::CrosshairData::VerifyRequestedRegion ( )

overridevirtual

Empty implementation; CrosshairData does not support the requested region concept.

Returns

Always true.

Implements mitk::BaseData.

Member Data Documentation

m_Position

Point3D mitk::CrosshairData::m_Position

protected

Definition at line 72 of file mitkCrosshairData.h.

---

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

• mitkCrosshairData.h