Base-class for geometric planar (2D) figures, such as lines, circles, rectangles, polygons, etc. More...

#include <mitkPlanarFigure.h>

Inheritance diagram for mitk::PlanarFigure:

[legend]

Collaboration diagram for mitk::PlanarFigure:

[legend]

Public Types
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...

Public Member Functions
	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 unsigned int	GetMinimumNumberOfControlPoints () const =0
	Returns the minimum number of control points needed to represent this figure. More...

virtual unsigned int	GetMaximumNumberOfControlPoints () const =0
	Returns the maximum number of control points allowed for this figure (e.g. 3 for triangles). 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...

virtual unsigned int	GetNumberOfFeatures () const
	Returns the number of features available for this PlanarFigure. 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 bool	ResetOnPointSelect ()
	Returns true if the planar figure is reset to "add points" mode when a point is selected. More...

virtual bool	ResetOnPointSelectNeeded () const

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...

virtual Point2D	ApplyControlPointConstraints (unsigned int index, const Point2D &point)
	Applies spatial constraints to a control point position. More...

virtual bool	Equals (const mitk::PlanarFigure &other) const
	Compares this PlanarFigure with another for equality. 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...

Protected Member Functions
	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)

virtual void	GeneratePolyLine ()=0
	Generates the poly-line representation of the planar figure. Must be implemented in sub-classes. More...

virtual void	GenerateHelperPolyLine (double mmPerDisplayUnit, unsigned int displayHeight)=0
	Generates the poly-lines that should be drawn the same size regardless of zoom. Must be implemented in sub-classes. More...

virtual void	EvaluateFeaturesInternal ()=0
	Calculates quantities of all features of this planar figure. Must be implemented in sub-classes. More...

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
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

Detailed Description

Base-class for geometric planar (2D) figures, such as lines, circles, rectangles, polygons, etc.

Warning: Currently does not support time-resolved data handling

Behavior and appearance of PlanarFigures are controlled by various properties; for a detailed list of appearance properties see mitk::PlanarFigureMapper2D

The following properties control general PlanarFigure behavior:

"selected": true if the planar figure is selected
"planarfigure.ishovering": true if the mouse "hovers" over the planar figure
"planarfigure.iseditable": true if the planar figure can be edited (otherwise, it can only be picked/selected, but its control points cannot be edited); default is true
"planarfigure.isextendable": true if new control points can be inserted into the list of control points; default is false

TODO: Implement local 2D transform (including center of rotation...)

Definition at line 50 of file mitkPlanarFigure.h.

Member Typedef Documentation

◆ BoolContainerType

typedef itk::VectorContainer<unsigned long, bool> mitk::PlanarFigure::BoolContainerType

Container type for boolean values, used for helper polyline paint flags.

Definition at line 60 of file mitkPlanarFigure.h.

◆ ControlPointListType

typedef std::deque<Point2D> mitk::PlanarFigure::ControlPointListType

Type for the list of control points defining the figure.

Definition at line 63 of file mitkPlanarFigure.h.

◆ PolyLineElement

typedef Point2D mitk::PlanarFigure::PolyLineElement

Type for individual elements of a polyline (2D points).

Definition at line 57 of file mitkPlanarFigure.h.

◆ PolyLineType

typedef std::vector<PolyLineElement> mitk::PlanarFigure::PolyLineType

Type for a polyline (vector of 2D points).

Definition at line 65 of file mitkPlanarFigure.h.

Constructor & Destructor Documentation

◆ PlanarFigure() [1/2]

mitk::PlanarFigure::PlanarFigure ( )

protected

◆ PlanarFigure() [2/2]

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

protected

Member Function Documentation

◆ ActivateFeature()

void mitk::PlanarFigure::ActivateFeature ( unsigned int index )

protected

Sets the specified feature as active. INTERAL METHOD.

◆ AddControlPoint()

virtual bool mitk::PlanarFigure::AddControlPoint	(	const Point2D &	point,
		int	index = `-1`
	)

virtual

Adds / inserts new control-points.

This method adds a new control-point with the coordinates defined by point at the given index. If 'index' == -1 or index is greater than the number of control-points the new point is appended to the back of the list of control points. If a control-point already exists for 'index', an additional point is inserted at that position. It is not possible to add more points if the maximum number of control-points (GetMaximumNumberOfControlPoints()) has been reached.

◆ AddFeature()

virtual unsigned int mitk::PlanarFigure::AddFeature	(	const char *	featureName,
		const char *	unitName
	)

protectedvirtual

Adds feature (e.g., circumference, radius, angle, ...) to feature vector of a planar figure object and returns integer ID for the feature element. Should be called in sub-class constructors.

◆ AppendPointToHelperPolyLine()

void mitk::PlanarFigure::AppendPointToHelperPolyLine	(	unsigned int	index,
		PolyLineElement	element
	)

protected

Append a point to the HelperPolyLine # index.

◆ AppendPointToPolyLine()

void mitk::PlanarFigure::AppendPointToPolyLine	(	unsigned int	index,
		PolyLineElement	element
	)

protected

Append a point to the PolyLine # index.

◆ ApplyControlPointConstraints()

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

virtual

Applies spatial constraints to a control point position.

Sub-classes can override this method to enforce spatial constraints on specific control points (e.g., keeping them within image bounds or enforcing orthogonality). The default implementation constrains points to the image bounds.

Parameters

[in]	index	The zero-based index of the control point.
[in]	point	The proposed 2D coordinates for the control point.

Returns: The constrained 2D coordinates.

Reimplemented in mitk::PlanarEllipse, mitk::PlanarDoubleEllipse, mitk::PlanarCross, and mitk::PlanarCircle.

◆ ClearHelperPolyLines()

void mitk::PlanarFigure::ClearHelperPolyLines ( )

protected

clears the list of HelperPolyLines. Call before re-calculating a new HelperPolyline.

◆ ClearPolyLines()

void mitk::PlanarFigure::ClearPolyLines ( )

protected

clears the list of PolyLines. Call before re-calculating a new Polyline.

◆ Clone()

Pointer mitk::PlanarFigure::Clone ( ) const

◆ DeactivateFeature()

void mitk::PlanarFigure::DeactivateFeature ( unsigned int index )

protected

Sets the specified feature as active. INTERAL METHOD.

◆ DeselectControlPoint()

virtual bool mitk::PlanarFigure::DeselectControlPoint ( )

virtual

Deselect control point; no control point active.

◆ Equals()

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

virtual

Compares this PlanarFigure with another for equality.

Checks whether control points, features, and figure properties match. All subclasses should implement this method for their specific comparison logic.

Parameters

[in] other The PlanarFigure to compare with.

Returns: True if both figures are considered equal.

Reimplemented in mitk::PlanarSubdivisionPolygon, mitk::PlanarRectangle, mitk::PlanarPolygon, mitk::PlanarLine, mitk::PlanarFourPointAngle, mitk::PlanarEllipse, mitk::PlanarDoubleEllipse, mitk::PlanarCross, mitk::PlanarCircle, mitk::PlanarBezierCurve, mitk::PlanarArrow, and mitk::PlanarAngle.

◆ EvaluateFeatures()

virtual void mitk::PlanarFigure::EvaluateFeatures ( )

virtual

Calculates quantities of all features of this planar figure.

◆ EvaluateFeaturesInternal()

virtual void mitk::PlanarFigure::EvaluateFeaturesInternal ( )

protectedpure virtual

Calculates quantities of all features of this planar figure. Must be implemented in sub-classes.

Implemented in mitk::PlanarRectangle, mitk::PlanarPolygon, mitk::PlanarLine, mitk::PlanarFourPointAngle, mitk::PlanarEllipse, mitk::PlanarDoubleEllipse, mitk::PlanarCross, mitk::PlanarCircle, mitk::PlanarBezierCurve, mitk::PlanarArrow, and mitk::PlanarAngle.

◆ GenerateHelperPolyLine()

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

protectedpure virtual

Generates the poly-lines that should be drawn the same size regardless of zoom. Must be implemented in sub-classes.

Implemented in mitk::PlanarDoubleEllipse, mitk::PlanarBezierCurve, mitk::PlanarRectangle, mitk::PlanarPolygon, mitk::PlanarLine, mitk::PlanarFourPointAngle, mitk::PlanarEllipse, mitk::PlanarCross, mitk::PlanarCircle, mitk::PlanarArrow, and mitk::PlanarAngle.

◆ GeneratePolyLine()

virtual void mitk::PlanarFigure::GeneratePolyLine ( )

protectedpure virtual

Generates the poly-line representation of the planar figure. Must be implemented in sub-classes.

Implemented in mitk::PlanarSubdivisionPolygon, mitk::PlanarRectangle, mitk::PlanarPolygon, mitk::PlanarLine, mitk::PlanarFourPointAngle, mitk::PlanarEllipse, mitk::PlanarDoubleEllipse, mitk::PlanarCross, mitk::PlanarCircle, mitk::PlanarBezierCurve, mitk::PlanarArrow, and mitk::PlanarAngle.

◆ GetControlPoint()

Point2D mitk::PlanarFigure::GetControlPoint ( unsigned int index ) const

Returns specified control point in 2D world coordinates.

◆ GetControlPointForPolylinePoint()

virtual int mitk::PlanarFigure::GetControlPointForPolylinePoint	(	int	indexOfPolylinePoint,
		int	polyLineIndex
	)		const

virtual

Returns the id of the control-point that corresponds to the given polyline-point.

Reimplemented in mitk::PlanarSubdivisionPolygon, and mitk::PlanarBezierCurve.

◆ GetFeatureName()

const char* mitk::PlanarFigure::GetFeatureName ( unsigned int index ) const

Returns the name (identifier) of the specified feature.

Parameters

[in] index Zero-based index of the feature.

Returns: The feature name string (e.g., "Radius", "Length", "Area").

◆ GetFeatureUnit()

const char* mitk::PlanarFigure::GetFeatureUnit ( unsigned int index ) const

Returns the physical unit of the specified feature.

Parameters

[in] index Zero-based index of the feature.

Returns: The unit string (e.g., "mm", "mm2", "deg").

◆ GetHelperPolyLine()

const PolyLineType& mitk::PlanarFigure::GetHelperPolyLine	(	unsigned int	index,
		double	mmPerDisplayUnit,
		unsigned int	displayHeight
	)

Returns a helper polyline that should be drawn at a fixed size regardless of zoom.

Helper polylines are used for annotations such as angle arcs, arrow tips, or other decorations that should maintain a constant display size.

Parameters

[in]	index	Zero-based index of the helper polyline.
[in]	mmPerDisplayUnit	Scale factor (mm per display pixel).
[in]	displayHeight	Height of the display in pixels.

Returns: Const reference to the helper polyline.

◆ GetHelperPolyLinesSize()

virtual unsigned short mitk::PlanarFigure::GetHelperPolyLinesSize ( ) const

virtual

Returns the current number of helperpolylines

◆ GetMaximumNumberOfControlPoints()

virtual unsigned int mitk::PlanarFigure::GetMaximumNumberOfControlPoints ( ) const

pure virtual

Returns the maximum number of control points allowed for this figure (e.g. 3 for triangles).

Must be implemented in sub-classes.

Implemented in mitk::PlanarSubdivisionPolygon, mitk::PlanarRectangle, mitk::PlanarPolygon, mitk::PlanarLine, mitk::PlanarFourPointAngle, mitk::PlanarEllipse, mitk::PlanarDoubleEllipse, mitk::PlanarCross, mitk::PlanarCircle, mitk::PlanarBezierCurve, mitk::PlanarArrow, and mitk::PlanarAngle.

◆ GetMinimumNumberOfControlPoints()

virtual unsigned int mitk::PlanarFigure::GetMinimumNumberOfControlPoints ( ) const

pure virtual

Returns the minimum number of control points needed to represent this figure.

Must be implemented in sub-classes.

Implemented in mitk::PlanarSubdivisionPolygon, mitk::PlanarRectangle, mitk::PlanarPolygon, mitk::PlanarLine, mitk::PlanarFourPointAngle, mitk::PlanarEllipse, mitk::PlanarDoubleEllipse, mitk::PlanarCross, mitk::PlanarCircle, mitk::PlanarBezierCurve, mitk::PlanarArrow, and mitk::PlanarAngle.

◆ GetNumberOfControlPoints()

unsigned int mitk::PlanarFigure::GetNumberOfControlPoints ( ) const

Returns the current number of 2D control points defining this figure.

◆ GetNumberOfFeatures()

virtual unsigned int mitk::PlanarFigure::GetNumberOfFeatures ( ) const

virtual

Returns the number of features available for this PlanarFigure.

Features are measurable quantities such as radius, length, area, angle, etc.

Returns: The number of available features.

Reimplemented in mitk::PlanarCross.

◆ GetPlaneGeometry()

virtual const PlaneGeometry* mitk::PlanarFigure::GetPlaneGeometry ( ) const

virtual

Returns (previously set) 2D geometry of this figure.

◆ GetPolyLine() [1/2]

PolyLineType& mitk::PlanarFigure::GetPolyLine ( unsigned int index )

Returns the polyline representing the planar figure (mutable version).

The polyline is regenerated if it is out of date.

Parameters

[in] index Zero-based index of the polyline to retrieve.

Returns: Reference to the polyline at the given index.

◆ GetPolyLine() [2/2]

const PolyLineType& mitk::PlanarFigure::GetPolyLine ( unsigned int index ) const

Returns the polyline representing the planar figure (const version).

Parameters

[in] index Zero-based index of the polyline to retrieve.

Returns: Const reference to the polyline at the given index.

◆ GetPolyLinesSize()

virtual unsigned short mitk::PlanarFigure::GetPolyLinesSize ( )

virtual

Returns the current number of polylines

◆ GetPreviewControlPoint()

Point2D mitk::PlanarFigure::GetPreviewControlPoint ( ) const

Returns the coordinates of the PreviewControlPoint.

◆ GetQuantity()

double mitk::PlanarFigure::GetQuantity ( unsigned int index ) const

Returns the quantity of the specified feature.

Parameters

[in] index Zero-based index of the feature.

Returns: The computed quantity (e.g., length in mm, area in mm2).

◆ GetSelectedControlPoint()

virtual int mitk::PlanarFigure::GetSelectedControlPoint ( ) const

inlinevirtual

Return currently selected control point.

Definition at line 153 of file mitkPlanarFigure.h.

◆ GetWorldControlPoint()

Point3D mitk::PlanarFigure::GetWorldControlPoint ( unsigned int index ) const

Returns specified control point in world coordinates.

◆ InitializeTimeGeometry()

void mitk::PlanarFigure::InitializeTimeGeometry ( unsigned int timeSteps = 1 )

overrideprotectedvirtual

Initializes the TimeGeometry describing the (time-resolved) geometry of this figure. Note that each time step holds one PlaneGeometry.

Reimplemented from mitk::BaseData.

◆ IsClosed()

virtual bool mitk::PlanarFigure::IsClosed ( ) const

virtual

True if the planar figure is closed.

Default is false. The "closed" boolean property must be set in sub-classes.

◆ IsFeatureActive()

bool mitk::PlanarFigure::IsFeatureActive ( unsigned int index ) const

Returns whether the specified feature is active.

An inactive feature is one that is currently not applicable, for example the area of a non-closed polygon.

Parameters

[in] index Zero-based index of the feature.

Returns: True if the feature exists and is active.

◆ IsFeatureVisible()

bool mitk::PlanarFigure::IsFeatureVisible ( unsigned int index ) const

Returns whether the specified feature is set to visible.

Parameters

[in] index Zero-based index of the feature.

Returns: True if the feature exists and is visible.

◆ IsHelperToBePainted()

virtual bool mitk::PlanarFigure::IsHelperToBePainted ( unsigned int index ) const

virtual

Returns whether a helper polyline should be painted or not.

Reimplemented in mitk::PlanarBezierCurve.

◆ IsPlaced()

virtual bool mitk::PlanarFigure::IsPlaced ( ) const

inlinevirtual

True if the planar figure has been placed (and can be displayed/interacted with).

Definition at line 85 of file mitkPlanarFigure.h.

◆ IsPreviewControlPointVisible()

bool mitk::PlanarFigure::IsPreviewControlPointVisible ( ) const

Returns whether or not the PreviewControlPoint is visible.

◆ mitkClassMacro()

mitk::PlanarFigure::mitkClassMacro	(	PlanarFigure	,
		BaseData
	)

◆ PlaceFigure()

virtual void mitk::PlanarFigure::PlaceFigure ( const Point2D & point )

virtual

Place figure at the given point (in 2D index coordinates) onto the given 2D geometry.

By default, the first two control points of the figure are set to the passed point. Further points can be set via AddControlPoint(), if the current number of control points is below the maximum number of control points.

Can be re-implemented in sub-classes as needed.

Reimplemented in mitk::PlanarRectangle, and mitk::PlanarEllipse.

◆ PrintSelf()

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

overrideprotected

◆ RemoveControlPoint()

virtual void mitk::PlanarFigure::RemoveControlPoint ( unsigned int index )

virtual

Removes the control point at the given index.

Parameters

[in] index Zero-based index of the control point to remove.

◆ RemoveLastControlPoint()

virtual void mitk::PlanarFigure::RemoveLastControlPoint ( )

virtual

Removes the last control point from the figure.

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

bool mitk::PlanarFigure::RequestedRegionIsOutsideOfTheBufferedRegion ( )

overridevirtual

Inherited from BaseData. Checks if the requested region is outside the buffered region.

Implements mitk::BaseData.

◆ ResetNumberOfControlPoints()

void mitk::PlanarFigure::ResetNumberOfControlPoints ( int numberOfControlPoints )

Resets the number of control points to the specified count.

Parameters

[in] numberOfControlPoints The new number of control points.

◆ ResetOnPointSelect()

virtual bool mitk::PlanarFigure::ResetOnPointSelect ( )

virtual

Returns true if the planar figure is reset to "add points" mode when a point is selected.

Default return value is false. Subclasses can overwrite this method and execute any reset / initialization statements required.

Reimplemented in mitk::PlanarCross.

◆ ResetOnPointSelectNeeded()

virtual bool mitk::PlanarFigure::ResetOnPointSelectNeeded ( ) const

virtual

Reimplemented in mitk::PlanarCross.

◆ ResetPreviewContolPoint()

void mitk::PlanarFigure::ResetPreviewContolPoint ( )

Marks the PreviewControlPoint as invisible.

◆ SelectControlPoint()

virtual bool mitk::PlanarFigure::SelectControlPoint ( unsigned int index )

virtual

Selects currently active control points.

◆ SetControlPoint()

virtual bool mitk::PlanarFigure::SetControlPoint	(	unsigned int	index,
		const Point2D &	point,
		bool	createIfDoesNotExist = `false`
	)

virtual

Sets the position of an existing control point, optionally creating it if missing.

Parameters

[in]	index	Zero-based index of the control point.
[in]	point	New 2D coordinates for the control point.
[in]	createIfDoesNotExist	If true, creates the control point at the given index if it does not already exist.

Returns: True if the control point was set successfully.

Reimplemented in mitk::PlanarEllipse, mitk::PlanarDoubleEllipse, mitk::PlanarRectangle, and mitk::PlanarCircle.

◆ SetCurrentControlPoint()

virtual bool mitk::PlanarFigure::SetCurrentControlPoint ( const Point2D & point )

virtual

Sets the position of the currently selected control point.

Parameters

[in] point New 2D coordinates for the currently selected control point.

Returns: True if a control point is selected and was updated successfully.

Reimplemented in mitk::PlanarCircle.

◆ SetFeatureName()

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

protected

Sets the name of the specified feature. INTERNAL METHOD.

◆ SetFeatureUnit()

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

protected

Sets the physical unit of the specified feature. INTERNAL METHOD.

◆ SetFeatureVisible()

void mitk::PlanarFigure::SetFeatureVisible	(	unsigned int	index,
		bool	visible
	)

Sets the visibility of the specified feature for annotation display.

Parameters

[in]	index	Zero-based index of the feature.
[in]	visible	If true, the feature will be displayed as an annotation in the RenderWindow.

◆ SetNumberOfHelperPolyLines()

void mitk::PlanarFigure::SetNumberOfHelperPolyLines ( unsigned int numberOfHelperPolyLines )

protected

defines the number of HelperPolyLines that will be available

◆ SetNumberOfPolyLines()

void mitk::PlanarFigure::SetNumberOfPolyLines ( unsigned int numberOfPolyLines )

protected

defines the number of PolyLines that will be available

◆ SetPlaneGeometry()

virtual void mitk::PlanarFigure::SetPlaneGeometry ( mitk::PlaneGeometry * geometry )

virtual

Sets the 2D geometry on which this figure will be placed.

In most cases, this is a Geometry already owned by another object, e.g. describing the slice of the image on which measurements will be performed.

◆ SetPreviewControlPoint()

void mitk::PlanarFigure::SetPreviewControlPoint ( const Point2D & point )

Sets the position of the PreviewControlPoint. Automatically sets it visible.

◆ SetQuantity()

void mitk::PlanarFigure::SetQuantity	(	unsigned int	index,
		double	quantity
	)

protected

Sets quantity of the specified feature. INTERNAL METHOD.

◆ SetRequestedRegion()

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

overridevirtual

Inherited from BaseData. Sets the requested region from another data object.

Parameters

[in] data The data object from which to copy the requested region.

Implements mitk::BaseData.

◆ SetRequestedRegionToLargestPossibleRegion()

void mitk::PlanarFigure::SetRequestedRegionToLargestPossibleRegion ( )

overridevirtual

Inherited from BaseData. Sets the requested region to the largest possible.

Implements mitk::BaseData.

◆ UpdateOutputInformation()

void mitk::PlanarFigure::UpdateOutputInformation ( )

override

Inherited from BaseData. Updates geometry information.

◆ VerifyRequestedRegion()

bool mitk::PlanarFigure::VerifyRequestedRegion ( )

overridevirtual

Inherited from BaseData. Verifies the requested region.

Implements mitk::BaseData.

Member Data Documentation

◆ m_ControlPoints

ControlPointListType mitk::PlanarFigure::m_ControlPoints

protected

Definition at line 412 of file mitkPlanarFigure.h.

◆ m_FigurePlaced

bool mitk::PlanarFigure::m_FigurePlaced

protected

Definition at line 428 of file mitkPlanarFigure.h.

◆ m_HelperPolyLines

std::vector<PolyLineType> mitk::PlanarFigure::m_HelperPolyLines

protected

Definition at line 419 of file mitkPlanarFigure.h.

◆ m_HelperPolyLinesToBePainted

BoolContainerType::Pointer mitk::PlanarFigure::m_HelperPolyLinesToBePainted

protected

Definition at line 420 of file mitkPlanarFigure.h.

◆ m_NumberOfControlPoints

unsigned int mitk::PlanarFigure::m_NumberOfControlPoints

protected

Definition at line 413 of file mitkPlanarFigure.h.

◆ m_PolyLines

std::vector<PolyLineType> mitk::PlanarFigure::m_PolyLines

protected

Definition at line 418 of file mitkPlanarFigure.h.

◆ m_PreviewControlPoint

Point2D mitk::PlanarFigure::m_PreviewControlPoint

protected

Definition at line 425 of file mitkPlanarFigure.h.

◆ m_PreviewControlPointVisible

bool mitk::PlanarFigure::m_PreviewControlPointVisible

protected

Definition at line 426 of file mitkPlanarFigure.h.

◆ m_SelectedControlPoint

int mitk::PlanarFigure::m_SelectedControlPoint

protected

Definition at line 416 of file mitkPlanarFigure.h.

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

mitkPlanarFigure.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ BoolContainerType

◆ ControlPointListType

◆ PolyLineElement

◆ PolyLineType

Constructor & Destructor Documentation

◆ PlanarFigure() [1/2]

◆ PlanarFigure() [2/2]

Member Function Documentation

◆ ActivateFeature()

◆ AddControlPoint()

◆ AddFeature()

◆ AppendPointToHelperPolyLine()

◆ AppendPointToPolyLine()

◆ ApplyControlPointConstraints()

◆ ClearHelperPolyLines()

◆ ClearPolyLines()

◆ Clone()

◆ DeactivateFeature()

◆ DeselectControlPoint()

◆ Equals()

◆ EvaluateFeatures()

◆ EvaluateFeaturesInternal()

◆ GenerateHelperPolyLine()

◆ GeneratePolyLine()

◆ GetControlPoint()

◆ GetControlPointForPolylinePoint()

◆ GetFeatureName()

◆ GetFeatureUnit()

◆ GetHelperPolyLine()

◆ GetHelperPolyLinesSize()

◆ GetMaximumNumberOfControlPoints()

◆ GetMinimumNumberOfControlPoints()

◆ GetNumberOfControlPoints()

◆ GetNumberOfFeatures()

◆ GetPlaneGeometry()

◆ GetPolyLine() [1/2]

◆ GetPolyLine() [2/2]

◆ GetPolyLinesSize()

◆ GetPreviewControlPoint()

◆ GetQuantity()

◆ GetSelectedControlPoint()

◆ GetWorldControlPoint()

◆ InitializeTimeGeometry()

◆ IsClosed()

◆ IsFeatureActive()

◆ IsFeatureVisible()

◆ IsHelperToBePainted()

◆ IsPlaced()

◆ IsPreviewControlPointVisible()

◆ mitkClassMacro()

◆ PlaceFigure()

◆ PrintSelf()

◆ RemoveControlPoint()

◆ RemoveLastControlPoint()

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

◆ ResetNumberOfControlPoints()

◆ ResetOnPointSelect()

◆ ResetOnPointSelectNeeded()

◆ ResetPreviewContolPoint()

◆ SelectControlPoint()

◆ SetControlPoint()

◆ SetCurrentControlPoint()

◆ SetFeatureName()

◆ SetFeatureUnit()

◆ SetFeatureVisible()

◆ SetNumberOfHelperPolyLines()

◆ SetNumberOfPolyLines()

◆ SetPlaneGeometry()

◆ SetPreviewControlPoint()

◆ SetQuantity()

◆ SetRequestedRegion()

◆ SetRequestedRegionToLargestPossibleRegion()

◆ UpdateOutputInformation()

◆ VerifyRequestedRegion()