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

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

typedef std::deque< Point2D >	ControlPointListType

typedef std::vector< PolyLineElement >	PolyLineType

Public Types inherited from mitk::BaseData
typedef BaseData	Self

typedef itk::DataObject	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Public Types inherited from mitk::Identifiable
using	UIDType = std::string

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)

virtual bool	SetCurrentControlPoint (const Point2D &point)

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

const PolyLineType	GetPolyLine (unsigned int index)
	Returns the polyline representing the planar figure (for rendering, measurements, etc.). More...

const PolyLineType	GetPolyLine (unsigned int index) const
	Returns the polyline representing the planar figure (for rendering, measurements, etc.). More...

const PolyLineType	GetHelperPolyLine (unsigned int index, double mmPerDisplayUnit, unsigned int displayHeight)
	Returns the polyline that should be drawn the same size at every scale (for text, angles, etc.). 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 (such as, radius, area, ...). More...

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

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

double	GetQuantity (unsigned int index) const

bool	IsFeatureActive (unsigned int index) const
	Returns true if the feature with the specified index exists and is active (an inactive feature may e.g. be the area of a non-closed polygon. More...

bool	IsFeatureVisible (unsigned int index) const
	Returns true if the feature with the specified index exists and is set visible. More...

void	SetFeatureVisible (unsigned int index, bool visible)
	Defines if the feature with the specified index will be shown as an Annotation in the RenderWindow. More...

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

void	UpdateOutputInformation () override
	Intherited from parent. More...

void	SetRequestedRegionToLargestPossibleRegion () override
	Intherited from parent. More...

bool	RequestedRegionIsOutsideOfTheBufferedRegion () override
	Intherited from parent. More...

bool	VerifyRequestedRegion () override
	Intherited from parent. More...

void	SetRequestedRegion (const itk::DataObject *data) override
	Intherited from parent. 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 point with the given index from the list of controlpoints. More...

virtual void	RemoveLastControlPoint ()
	Removes last control point. More...

virtual Point2D	ApplyControlPointConstraints (unsigned int, const Point2D &point)
	Allow sub-classes to apply constraints on control points. More...

virtual bool	Equals (const mitk::PlanarFigure &other) const
	Compare two PlanarFigure objects Note: all subclasses have to implement the method on their own. More...

void	ResetNumberOfControlPoints (int numberOfControlPoints)
	Set the initial number of control points of the planar figure. More...

Public Member Functions inherited from mitk::BaseData
virtual std::vector< std::string >	GetClassHierarchy () const

virtual const char *	GetClassName () const

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

BaseProperty *	GetNonConstProperty (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::TimeGeometry *	GetTimeGeometry () const
	Return the TimeGeometry of the data as const pointer. More...

mitk::TimeGeometry *	GetTimeGeometry ()
	Return the TimeGeometry of the data as pointer. More...

const mitk::TimeGeometry *	GetUpdatedTimeGeometry ()
	Return the TimeGeometry of the data. More...

virtual void	Expand (unsigned int timeSteps)
	Expands the TimeGeometry to a number of TimeSteps. More...

const mitk::BaseGeometry *	GetUpdatedGeometry (int t=0)
	Return the BaseGeometry of the data at time t. More...

mitk::BaseGeometry *	GetGeometry (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	IsEmptyTimeStep (unsigned int t) const
	Check whether object contains data (at a specified time), e.g., a set of points may be empty. 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...

void	ExecuteOperation (Operation *operation) override
	overwrite if the Data can be called by an Interactor (StateMachine). 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::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 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...

itk::ModifiedTimeType	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 ()

Identifiable &	operator= (const Identifiable &)=delete

Identifiable &	operator= (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 ()

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

Additional Inherited Members
Static Public Member Functions inherited from mitk::BaseData
static const char *	GetStaticNameOfClass ()

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

Definition at line 58 of file mitkPlanarFigure.h.

◆ ControlPointListType

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

Definition at line 60 of file mitkPlanarFigure.h.

◆ PolyLineElement

typedef Point2D mitk::PlanarFigure::PolyLineElement

Definition at line 54 of file mitkPlanarFigure.h.

◆ PolyLineType

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

Definition at line 61 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	,
		const Point2D &	point
	)

virtual

Allow sub-classes to apply constraints on control points.

Sub-classes can define spatial constraints to certain control points by overwriting this method and returning a constrained point. By default, the points are constrained by the image bounds.

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

◆ 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

Compare two PlanarFigure objects Note: all subclasses have to implement the method on their own.

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

◆ 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::PlanarCross, mitk::PlanarCircle, mitk::PlanarEllipse, mitk::PlanarPolygon, mitk::PlanarArrow, mitk::PlanarLine, mitk::PlanarFourPointAngle, mitk::PlanarAngle, mitk::PlanarRectangle, mitk::PlanarDoubleEllipse, and mitk::PlanarBezierCurve.

◆ 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::PlanarCross, mitk::PlanarCircle, mitk::PlanarEllipse, mitk::PlanarPolygon, mitk::PlanarArrow, mitk::PlanarLine, mitk::PlanarFourPointAngle, mitk::PlanarAngle, and mitk::PlanarRectangle.

◆ 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::PlanarCross, mitk::PlanarCircle, mitk::PlanarEllipse, mitk::PlanarSubdivisionPolygon, mitk::PlanarDoubleEllipse, mitk::PlanarPolygon, mitk::PlanarArrow, mitk::PlanarLine, mitk::PlanarFourPointAngle, mitk::PlanarAngle, mitk::PlanarRectangle, and mitk::PlanarBezierCurve.

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

◆ GetFeatureUnit()

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

Returns the physical unit of the specified features.

◆ GetHelperPolyLine()

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

Returns the polyline that should be drawn the same size at every scale (for text, angles, etc.).

◆ 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::PlanarCross, mitk::PlanarPolygon, mitk::PlanarArrow, mitk::PlanarLine, mitk::PlanarCircle, mitk::PlanarFourPointAngle, mitk::PlanarAngle, mitk::PlanarRectangle, mitk::PlanarEllipse, mitk::PlanarSubdivisionPolygon, mitk::PlanarBezierCurve, and mitk::PlanarDoubleEllipse.

◆ 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::PlanarCross, mitk::PlanarPolygon, mitk::PlanarCircle, mitk::PlanarFourPointAngle, mitk::PlanarAngle, mitk::PlanarRectangle, mitk::PlanarArrow, mitk::PlanarEllipse, mitk::PlanarLine, mitk::PlanarBezierCurve, mitk::PlanarDoubleEllipse, and mitk::PlanarSubdivisionPolygon.

◆ 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 (such as, radius, area, ...).

Reimplemented in mitk::PlanarCross.

◆ GetPlaneGeometry()

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

virtual

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

◆ GetPolyLine() [1/2]

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

Returns the polyline representing the planar figure (for rendering, measurements, etc.).

◆ GetPolyLine() [2/2]

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

Returns the polyline representing the planar figure (for rendering, measurements, etc.).

◆ 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 quantity of the specified feature (e.g., length, radius, area, ... )

◆ GetSelectedControlPoint()

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

inlinevirtual

Return currently selected control point.

Definition at line 134 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 true if the feature with the specified index exists and is active (an inactive feature may e.g. be the area of a non-closed polygon.

◆ IsFeatureVisible()

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

Returns true if the feature with the specified index exists and is set 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 81 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 point with the given index from the list of controlpoints.

◆ RemoveLastControlPoint()

virtual void mitk::PlanarFigure::RemoveLastControlPoint ( )

virtual

Removes last control point.

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

bool mitk::PlanarFigure::RequestedRegionIsOutsideOfTheBufferedRegion ( )

overridevirtual

Intherited from parent.

Implements mitk::BaseData.

◆ ResetNumberOfControlPoints()

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

Set the initial number of control points of the planar figure.

◆ 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

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

◆ SetCurrentControlPoint()

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

virtual

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
	)

Defines if the feature with the specified index will be shown 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

Intherited from parent.

Implements mitk::BaseData.

◆ SetRequestedRegionToLargestPossibleRegion()

void mitk::PlanarFigure::SetRequestedRegionToLargestPossibleRegion ( )

overridevirtual

Intherited from parent.

Implements mitk::BaseData.

◆ UpdateOutputInformation()

void mitk::PlanarFigure::UpdateOutputInformation ( )

override

Intherited from parent.

◆ VerifyRequestedRegion()

bool mitk::PlanarFigure::VerifyRequestedRegion ( )

overridevirtual

Intherited from parent.

Implements mitk::BaseData.

Member Data Documentation

◆ m_ControlPoints

ControlPointListType mitk::PlanarFigure::m_ControlPoints

protected

Definition at line 316 of file mitkPlanarFigure.h.

◆ m_FigurePlaced

bool mitk::PlanarFigure::m_FigurePlaced

protected

Definition at line 332 of file mitkPlanarFigure.h.

◆ m_HelperPolyLines

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

protected

Definition at line 323 of file mitkPlanarFigure.h.

◆ m_HelperPolyLinesToBePainted

BoolContainerType::Pointer mitk::PlanarFigure::m_HelperPolyLinesToBePainted

protected

Definition at line 324 of file mitkPlanarFigure.h.

◆ m_NumberOfControlPoints

unsigned int mitk::PlanarFigure::m_NumberOfControlPoints

protected

Definition at line 317 of file mitkPlanarFigure.h.

◆ m_PolyLines

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

protected

Definition at line 322 of file mitkPlanarFigure.h.

◆ m_PreviewControlPoint

Point2D mitk::PlanarFigure::m_PreviewControlPoint

protected

Definition at line 329 of file mitkPlanarFigure.h.

◆ m_PreviewControlPointVisible

bool mitk::PlanarFigure::m_PreviewControlPointVisible

protected

Definition at line 330 of file mitkPlanarFigure.h.

◆ m_SelectedControlPoint

int mitk::PlanarFigure::m_SelectedControlPoint

protected

Definition at line 320 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

Additional Inherited Members

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