Implementation of PlanarFigure modeling a cross with two orthogonal lines on a plane. More...

#include <mitkPlanarCross.h>

Inheritance diagram for mitk::PlanarCross:

[legend]

Collaboration diagram for mitk::PlanarCross:

[legend]

Public Member Functions
	mitkClassMacro (PlanarCross, PlanarFigure)

Pointer	Clone () const

void	SetSingleLineMode (bool singleLineMode)
	Sets whether the PlanarFigure represents a single line or an orthogonal cross. More...

bool	GetSingleLineMode () const
	Returns whether the PlanarFigure represents a single line or an orthogonal cross. More...

virtual void	SingleLineModeOn ()
	Boolean macro for single-line mode toggling. More...

virtual void	SingleLineModeOff ()

unsigned int	GetMinimumNumberOfControlPoints () const override
	Returns 2 in single-line mode, 4 in cross mode. More...

unsigned int	GetMaximumNumberOfControlPoints () const override
	Returns 2 in single-line mode, 4 in cross mode. More...

bool	ResetOnPointSelect () override
	Resets the cross to a single line when a control point is selected. More...

bool	ResetOnPointSelectNeeded () const override
	Returns whether a reset is needed when a control point is selected. More...

unsigned int	GetNumberOfFeatures () const override
	Returns 1 in single-line mode, 2 in cross mode (longest + shortest diameter). More...

bool	Equals (const mitk::PlanarFigure &other) const override
	Compares this PlanarCross with another PlanarFigure for equality. More...

Public Member Functions inherited from mitk::PlanarFigure
	mitkClassMacro (PlanarFigure, BaseData)

Pointer	Clone () const

virtual void	SetPlaneGeometry (mitk::PlaneGeometry *geometry)
	Sets the 2D geometry on which this figure will be placed. More...

virtual const PlaneGeometry *	GetPlaneGeometry () const
	Returns (previously set) 2D geometry of this figure. More...

virtual bool	IsClosed () const
	True if the planar figure is closed. More...

virtual bool	IsPlaced () const
	True if the planar figure has been placed (and can be displayed/interacted with). More...

virtual void	PlaceFigure (const Point2D &point)
	Place figure at the given point (in 2D index coordinates) onto the given 2D geometry. More...

virtual bool	AddControlPoint (const Point2D &point, int index=-1)
	Adds / inserts new control-points. More...

virtual bool	SetControlPoint (unsigned int index, const Point2D &point, bool createIfDoesNotExist=false)
	Sets the position of an existing control point, optionally creating it if missing. More...

virtual bool	SetCurrentControlPoint (const Point2D &point)
	Sets the position of the currently selected control point. More...

unsigned int	GetNumberOfControlPoints () const
	Returns the current number of 2D control points defining this figure. More...

virtual bool	SelectControlPoint (unsigned int index)
	Selects currently active control points. More...

virtual bool	DeselectControlPoint ()
	Deselect control point; no control point active. More...

virtual int	GetSelectedControlPoint () const
	Return currently selected control point. More...

Point2D	GetControlPoint (unsigned int index) const
	Returns specified control point in 2D world coordinates. More...

virtual int	GetControlPointForPolylinePoint (int indexOfPolylinePoint, int polyLineIndex) const
	Returns the id of the control-point that corresponds to the given polyline-point. More...

Point3D	GetWorldControlPoint (unsigned int index) const
	Returns specified control point in world coordinates. More...

PolyLineType &	GetPolyLine (unsigned int index)
	Returns the polyline representing the planar figure (mutable version). More...

const PolyLineType &	GetPolyLine (unsigned int index) const
	Returns the polyline representing the planar figure (const version). More...

const PolyLineType &	GetHelperPolyLine (unsigned int index, double mmPerDisplayUnit, unsigned int displayHeight)
	Returns a helper polyline that should be drawn at a fixed size regardless of zoom. More...

void	SetPreviewControlPoint (const Point2D &point)
	Sets the position of the PreviewControlPoint. Automatically sets it visible. More...

void	ResetPreviewContolPoint ()
	Marks the PreviewControlPoint as invisible. More...

bool	IsPreviewControlPointVisible () const
	Returns whether or not the PreviewControlPoint is visible. More...

Point2D	GetPreviewControlPoint () const
	Returns the coordinates of the PreviewControlPoint. More...

const char *	GetFeatureName (unsigned int index) const
	Returns the name (identifier) of the specified feature. More...

const char *	GetFeatureUnit (unsigned int index) const
	Returns the physical unit of the specified feature. More...

double	GetQuantity (unsigned int index) const
	Returns the quantity of the specified feature. More...

bool	IsFeatureActive (unsigned int index) const
	Returns whether the specified feature is active. More...

bool	IsFeatureVisible (unsigned int index) const
	Returns whether the specified feature is set to visible. More...

void	SetFeatureVisible (unsigned int index, bool visible)
	Sets the visibility of the specified feature for annotation display. More...

virtual void	EvaluateFeatures ()
	Calculates quantities of all features of this planar figure. More...

void	UpdateOutputInformation () override
	Inherited from BaseData. Updates geometry information. More...

void	SetRequestedRegionToLargestPossibleRegion () override
	Inherited from BaseData. Sets the requested region to the largest possible. More...

bool	RequestedRegionIsOutsideOfTheBufferedRegion () override
	Inherited from BaseData. Checks if the requested region is outside the buffered region. More...

bool	VerifyRequestedRegion () override
	Inherited from BaseData. Verifies the requested region. More...

void	SetRequestedRegion (const itk::DataObject *data) override
	Inherited from BaseData. Sets the requested region from another data object. More...

virtual unsigned short	GetPolyLinesSize ()
	Returns the current number of polylines More...

virtual unsigned short	GetHelperPolyLinesSize () const
	Returns the current number of helperpolylines More...

virtual bool	IsHelperToBePainted (unsigned int index) const
	Returns whether a helper polyline should be painted or not. More...

virtual void	RemoveControlPoint (unsigned int index)
	Removes the control point at the given index. More...

virtual void	RemoveLastControlPoint ()
	Removes the last control point from the figure. More...

void	ResetNumberOfControlPoints (int numberOfControlPoints)
	Resets the number of control points to the specified count. 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
	PlanarCross ()

	PlanarCross (const Self &other)

	mitkCloneMacro (Self)

Point2D	ApplyControlPointConstraints (unsigned int index, const Point2D &point) override
	Spatially constrain control points of second (orthogonal) line. More...

void	GeneratePolyLine () override
	Generates the poly-line representation of the planar figure. More...

void	GenerateHelperPolyLine (double mmPerDisplayUnit, unsigned int displayHeight) override
	Generates the poly-lines that should be drawn the same size regardless of zoom. More...

void	EvaluateFeaturesInternal () override
	Calculates feature quantities of the planar figure. More...

void	PrintSelf (std::ostream &os, itk::Indent indent) const override

Protected Member Functions inherited from mitk::PlanarFigure
	PlanarFigure ()

	PlanarFigure (const Self &other)

virtual unsigned int	AddFeature (const char featureName, const char unitName)

void	SetFeatureName (unsigned int index, const char *featureName)

void	SetFeatureUnit (unsigned int index, const char *unitName)

void	SetQuantity (unsigned int index, double quantity)

void	ActivateFeature (unsigned int index)

void	DeactivateFeature (unsigned int index)

void	InitializeTimeGeometry (unsigned int timeSteps=1) override
	Initializes the TimeGeometry describing the (time-resolved) geometry of this figure. Note that each time step holds one PlaneGeometry. More...

void	SetNumberOfPolyLines (unsigned int numberOfPolyLines)
	defines the number of PolyLines that will be available More...

void	AppendPointToPolyLine (unsigned int index, PolyLineElement element)
	Append a point to the PolyLine # index. More...

void	ClearPolyLines ()
	clears the list of PolyLines. Call before re-calculating a new Polyline. More...

void	SetNumberOfHelperPolyLines (unsigned int numberOfHelperPolyLines)
	defines the number of HelperPolyLines that will be available More...

void	AppendPointToHelperPolyLine (unsigned int index, PolyLineElement element)
	Append a point to the HelperPolyLine # index. More...

void	ClearHelperPolyLines ()
	clears the list of HelperPolyLines. Call before re-calculating a new HelperPolyline. More...

void	PrintSelf (std::ostream &os, itk::Indent indent) const override

Protected Member Functions inherited from mitk::BaseData
	BaseData ()

	BaseData (const BaseData &other)

	~BaseData () override

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
const unsigned int	FEATURE_ID_LONGESTDIAMETER

const unsigned int	FEATURE_ID_SHORTAXISDIAMETER

Protected Attributes inherited from mitk::PlanarFigure
ControlPointListType	m_ControlPoints

unsigned int	m_NumberOfControlPoints

int	m_SelectedControlPoint

std::vector< PolyLineType >	m_PolyLines

std::vector< PolyLineType >	m_HelperPolyLines

BoolContainerType::Pointer	m_HelperPolyLinesToBePainted

Point2D	m_PreviewControlPoint

bool	m_PreviewControlPointVisible

bool	m_FigurePlaced

Protected Attributes inherited from mitk::BaseData
bool	m_LastRequestedRegionWasOutsideOfTheBufferedRegion

unsigned int	m_SourceOutputIndexDuplicate

bool	m_Initialized

Additional Inherited Members
Public Types inherited from mitk::PlanarFigure
typedef Point2D	PolyLineElement
	Type for individual elements of a polyline (2D points). More...

typedef itk::VectorContainer< unsigned long, bool >	BoolContainerType
	Container type for boolean values, used for helper polyline paint flags. More...

typedef std::deque< Point2D >	ControlPointListType
	Type for the list of control points defining the figure. More...

typedef std::vector< PolyLineElement >	PolyLineType
	Type for a polyline (vector of 2D points). More...

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

Detailed Description

Implementation of PlanarFigure modeling a cross with two orthogonal lines on a plane.

The cross consists of two two orthogonal lines, which are defined by four control points lying on a plane. The two control points of the first line are freely placable within the bounds of the underlying 2D geometry, while the two control points of the second line are ensured to meet the following constraints:

1.) The lines must be orthogonal to each other 2.) The second line must lie within the 2D area defined by the first line 3.) The two lines must intersect (at least with their boundaries)

When placing the second line interactively, a graphical helper polyline is provided to the user to indicate the position and orthogonal orientation of the line if it would be placed at the current mouse position.

When modifying one of the lines by interactively moving its control points, the respective other line is deleted and the user is prompted to draw it again.

The class provide a special mode for drawing single lines (SingleLineModeOn/Off); in this case, interaction stops after the first line has been placed.

The class provides the lengths of both lines via the "feature" interface, ordered by size.

See also: PlanarFigureMapper2D

Definition at line 50 of file mitkPlanarCross.h.

Constructor & Destructor Documentation

◆ PlanarCross() [1/2]

mitk::PlanarCross::PlanarCross ( )

protected

◆ PlanarCross() [2/2]

mitk::PlanarCross::PlanarCross ( const Self & other )

protected

Member Function Documentation

◆ ApplyControlPointConstraints()

Point2D mitk::PlanarCross::ApplyControlPointConstraints	(	unsigned int	index,
		const Point2D &	point
	)

overrideprotectedvirtual

Spatially constrain control points of second (orthogonal) line.

Reimplemented from mitk::PlanarFigure.

◆ Clone()

Pointer mitk::PlanarCross::Clone ( ) const

◆ Equals()

bool mitk::PlanarCross::Equals ( const mitk::PlanarFigure & other ) const

overridevirtual

Compares this PlanarCross with another PlanarFigure for equality.

Parameters

[in] other The PlanarFigure to compare with.

Returns: True if both figures are considered equal.

Reimplemented from mitk::PlanarFigure.

◆ EvaluateFeaturesInternal()

void mitk::PlanarCross::EvaluateFeaturesInternal ( )

overrideprotectedvirtual

Calculates feature quantities of the planar figure.

Implements mitk::PlanarFigure.

◆ GenerateHelperPolyLine()

void mitk::PlanarCross::GenerateHelperPolyLine	(	double	mmPerDisplayUnit,
		unsigned int	displayHeight
	)

overrideprotectedvirtual

Generates the poly-lines that should be drawn the same size regardless of zoom.

Implements mitk::PlanarFigure.

◆ GeneratePolyLine()

void mitk::PlanarCross::GeneratePolyLine ( )

overrideprotectedvirtual

Generates the poly-line representation of the planar figure.

Implements mitk::PlanarFigure.

◆ GetMaximumNumberOfControlPoints()

unsigned int mitk::PlanarCross::GetMaximumNumberOfControlPoints ( ) const

inlineoverridevirtual

Returns 2 in single-line mode, 4 in cross mode.

Implements mitk::PlanarFigure.

Definition at line 81 of file mitkPlanarCross.h.

◆ GetMinimumNumberOfControlPoints()

unsigned int mitk::PlanarCross::GetMinimumNumberOfControlPoints ( ) const

inlineoverridevirtual

Returns 2 in single-line mode, 4 in cross mode.

Implements mitk::PlanarFigure.

Definition at line 79 of file mitkPlanarCross.h.

◆ GetNumberOfFeatures()

unsigned int mitk::PlanarCross::GetNumberOfFeatures ( ) const

overridevirtual

Returns 1 in single-line mode, 2 in cross mode (longest + shortest diameter).

Returns: The number of available features.

Reimplemented from mitk::PlanarFigure.

◆ GetSingleLineMode()

bool mitk::PlanarCross::GetSingleLineMode ( ) const

Returns whether the PlanarFigure represents a single line or an orthogonal cross.

Returns: True if in single-line mode.

◆ mitkClassMacro()

mitk::PlanarCross::mitkClassMacro	(	PlanarCross	,
		PlanarFigure
	)

◆ mitkCloneMacro()

mitk::PlanarCross::mitkCloneMacro ( Self )

protected

◆ New()

static Pointer mitk::PlanarCross::New ( )

static

◆ PrintSelf()

void mitk::PlanarCross::PrintSelf	(	std::ostream &	os,
		itk::Indent	indent
	)		const

overrideprotected

◆ ResetOnPointSelect()

bool mitk::PlanarCross::ResetOnPointSelect ( )

overridevirtual

Resets the cross to a single line when a control point is selected.

When in cross mode, selecting a control point on the second line removes the second line and prompts the user to redraw it.

Returns: True if a reset was performed.

Reimplemented from mitk::PlanarFigure.

◆ ResetOnPointSelectNeeded()

bool mitk::PlanarCross::ResetOnPointSelectNeeded ( ) const

overridevirtual

Returns whether a reset is needed when a control point is selected.

Returns: True if the figure needs to be reset on point selection.

Reimplemented from mitk::PlanarFigure.

◆ SetSingleLineMode()

void mitk::PlanarCross::SetSingleLineMode ( bool singleLineMode )

Sets whether the PlanarFigure represents a single line or an orthogonal cross.

Parameters

[in] singleLineMode If true, only a single line (2 control points) is used.

◆ SingleLineModeOff()

virtual void mitk::PlanarCross::SingleLineModeOff ( )

virtual

◆ SingleLineModeOn()

virtual void mitk::PlanarCross::SingleLineModeOn ( )

virtual

Boolean macro for single-line mode toggling.

Calls SetSingleLineMode().

Member Data Documentation

◆ FEATURE_ID_LONGESTDIAMETER

const unsigned int mitk::PlanarCross::FEATURE_ID_LONGESTDIAMETER

protected

Definition at line 132 of file mitkPlanarCross.h.

◆ FEATURE_ID_SHORTAXISDIAMETER

const unsigned int mitk::PlanarCross::FEATURE_ID_SHORTAXISDIAMETER

protected

Definition at line 133 of file mitkPlanarCross.h.

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

mitkPlanarCross.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PlanarCross() [1/2]

◆ PlanarCross() [2/2]

Member Function Documentation

◆ ApplyControlPointConstraints()

◆ Clone()

◆ Equals()

◆ EvaluateFeaturesInternal()

◆ GenerateHelperPolyLine()

◆ GeneratePolyLine()

◆ GetMaximumNumberOfControlPoints()

◆ GetMinimumNumberOfControlPoints()

◆ GetNumberOfFeatures()

◆ GetSingleLineMode()

◆ mitkClassMacro()

◆ mitkCloneMacro()

◆ New()

◆ PrintSelf()

◆ ResetOnPointSelect()

◆ ResetOnPointSelectNeeded()

◆ SetSingleLineMode()

◆ SingleLineModeOff()

◆ SingleLineModeOn()

Member Data Documentation

◆ FEATURE_ID_LONGESTDIAMETER

◆ FEATURE_ID_SHORTAXISDIAMETER