Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
mitk::PlanarCross Class Reference

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

#include <mitkPlanarCross.h>

Inheritance diagram for mitk::PlanarCross:
Collaboration diagram for mitk::PlanarCross:

Public Member Functions

 mitkClassMacro (PlanarCross, PlanarFigure)
 
Pointer Clone () const
 
void SetSingleLineMode (bool singleLineMode)
 Indicates whether the PlanarFigure shall represent only a single line instead of an orthogonal cross. More...
 
bool GetSingleLineMode () const
 Indicates whether the PlanarFigure shall represent only a single line instead of an orthogonal cross. More...
 
virtual void SingleLineModeOn ()
 Indicates whether the PlanarFigure shall represent only a single line instead of an orthogonal cross. More...
 
virtual void SingleLineModeOff ()
 
unsigned int GetMinimumNumberOfControlPoints () const override
 PlanarCross has either two or four control points, depending on the operation mode. More...
 
unsigned int GetMaximumNumberOfControlPoints () const override
 PlanarCross has either two or four control points, depending on the operation mode. More...
 
virtual bool ResetOnPointSelect () override
 The cross shall be reset to a single line when a control point is selected. More...
 
virtual bool ResetOnPointSelectNeeded () const override
 
virtual unsigned int GetNumberOfFeatures () const override
 Returns the number of features available for this PlanarCross (1 or 2). More...
 
virtual bool Equals (const mitk::PlanarFigure &other) const override
 Compare two PlanarFigure objects Note: all subclasses have to implement the method on their own. 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 PlaneGeometryGetPlaneGeometry () 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 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, measurments, 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...
 
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 overlay in the RenderWindow. More...
 
virtual void EvaluateFeatures ()
 Calculates quantities of all features of this planar figure. More...
 
virtual void UpdateOutputInformation () override
 Intherited from parent. More...
 
virtual void SetRequestedRegionToLargestPossibleRegion () override
 Intherited from parent. More...
 
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 Intherited from parent. More...
 
virtual bool VerifyRequestedRegion () override
 Intherited from parent. More...
 
virtual 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 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...
 
- Public Member Functions inherited from mitk::BaseData
virtual std::vector< std::string > GetClassHierarchy () const
 
virtual const char * GetClassName () const
 
const mitk::TimeGeometryGetTimeGeometry () const
 Return the TimeGeometry of the data as const pointer. More...
 
const mitk::TimeGeometryGetTimeSlicedGeometry () const
 Return the TimeGeometry of the data as const pointer. More...
 
mitk::TimeGeometryGetTimeGeometry ()
 Return the TimeGeometry of the data as pointer. More...
 
const mitk::TimeGeometryGetUpdatedTimeGeometry ()
 Return the TimeGeometry of the data. More...
 
const mitk::TimeGeometryGetUpdatedTimeSliceGeometry ()
 Return the TimeGeometry of the data. More...
 
virtual void Expand (unsigned int timeSteps)
 Expands the TimeGeometry to a number of TimeSteps. More...
 
const mitk::BaseGeometryGetUpdatedGeometry (int t=0)
 Return the BaseGeometry of the data at time t. More...
 
mitk::BaseGeometryGetGeometry (int t=0) const
 Return the geometry, which is a TimeGeometry, of the data as non-const pointer. More...
 
void UpdateOutputInformation () override
 Update the information for this BaseData (the geometry in particular) so that it can be used as an output of a BaseProcess. More...
 
void CopyInformation (const itk::DataObject *data) override
 Copy information from the specified data set. More...
 
virtual bool IsInitialized () const
 Check whether the data has been initialized, i.e., at least the Geometry and other header data has been set. More...
 
virtual void Clear ()
 Calls ClearData() and InitializeEmpty();. More...
 
virtual bool 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 TimeGeometry as TimeGeometry of the data. Assumes the data object has only 1 time step ( is a 3D object ) and creates a new TimeGeometry. If an TimeGeometry has already been set for the object, it will be replaced after calling this function. More...
 
virtual void SetClonedTimeGeometry (const TimeGeometry *geometry)
 Set a clone of the provided TimeGeometry as TimeGeometry of the data. More...
 
virtual void SetClonedGeometry (const BaseGeometry *aGeometry3D, unsigned int time)
 Set a clone of the provided geometry as BaseGeometry of a given time step. More...
 
mitk::PropertyList::Pointer GetPropertyList () const
 Get the data's property list. More...
 
void SetPropertyList (PropertyList *propertyList)
 Set the data's property list. More...
 
mitk::BaseProperty::Pointer GetProperty (const char *propertyKey) const
 Get the property (instance of BaseProperty) with key propertyKey from the PropertyList, and set it to this, respectively;. More...
 
void SetProperty (const char *propertyKey, BaseProperty *property)
 
virtual void SetOrigin (const Point3D &origin)
 Convenience method for setting the origin of the BaseGeometry instances of all time steps. More...
 
itk::SmartPointer< mitk::BaseDataSourceGetSource () const
 Get the process object that generated this data object. More...
 
unsigned int GetTimeSteps () const
 Get the number of time steps from the TimeGeometry As the base data has not a data vector given by itself, the number of time steps is defined over the time sliced geometry. In sub classes, a better implementation could be over the length of the data vector. More...
 
virtual unsigned long GetMTime () const override
 Get the modified time of the last change of the contents this data object or its geometry. More...
 
virtual void Graft (const DataObject *) override
 
- Public Member Functions inherited from mitk::OperationActor
 itkTypeMacroNoParent (OperationActor) virtual ~OperationActor()
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from mitk::BaseData
static const char * GetStaticNameOfClass ()
 

Protected Member Functions

 PlanarCross ()
 
 mitkCloneMacro (Self)
 
virtual Point2D ApplyControlPointConstraints (unsigned int index, const Point2D &point) override
 Spatially constrain control points of second (orthogonal) line. More...
 
virtual void GeneratePolyLine () override
 Generates the poly-line representation of the planar figure. More...
 
virtual void GenerateHelperPolyLine (double mmPerDisplayUnit, unsigned int displayHeight) override
 Generates the poly-lines that should be drawn the same size regardless of zoom. More...
 
virtual void EvaluateFeaturesInternal () override
 Calculates feature quantities of the planar figure. More...
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
- Protected Member Functions inherited from mitk::PlanarFigure
 PlanarFigure ()
 
 PlanarFigure (const Self &other)
 
void ResetNumberOfControlPoints (int numberOfControlPoints)
 Set the initial number of control points of the planar figure. More...
 
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 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...
 
- Protected Member Functions inherited from mitk::BaseData
 BaseData ()
 
 BaseData (const BaseData &other)
 
 ~BaseData ()
 
virtual void InitializeTimeSlicedGeometry (unsigned int timeSteps=1)
 Initialize the TimeGeometry for a number of time steps. The TimeGeometry is initialized empty and evenly timed. In many cases it will be necessary to overwrite this in sub-classes. More...
 
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...
 

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< PolyLineTypem_PolyLines
 
std::vector< PolyLineTypem_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
 
typedef itk::VectorContainer< unsigned long, bool > BoolContainerType
 
typedef std::deque< Point2DControlPointListType
 
typedef std::vector< PolyLineElementPolyLineType
 
- Public Types inherited from mitk::BaseData
typedef BaseData Self
 
typedef itk::DataObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

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 54 of file mitkPlanarCross.h.

Constructor & Destructor Documentation

Member Function Documentation

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

Spatially constrain control points of second (orthogonal) line.

Reimplemented from mitk::PlanarFigure.

Definition at line 129 of file mitkPlanarCross.cpp.

References mitk::eps.

Pointer mitk::PlanarCross::Clone ( ) const
bool mitk::PlanarCross::Equals ( const mitk::PlanarFigure other) const
overridevirtual

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

Reimplemented from mitk::PlanarFigure.

Definition at line 334 of file mitkPlanarCross.cpp.

void mitk::PlanarCross::EvaluateFeaturesInternal ( )
overrideprotectedvirtual

Calculates feature quantities of the planar figure.

Implements mitk::PlanarFigure.

Definition at line 296 of file mitkPlanarCross.cpp.

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.

Definition at line 250 of file mitkPlanarCross.cpp.

void mitk::PlanarCross::GeneratePolyLine ( )
overrideprotectedvirtual

Generates the poly-line representation of the planar figure.

Implements mitk::PlanarFigure.

Definition at line 232 of file mitkPlanarCross.cpp.

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

PlanarCross has either two or four control points, depending on the operation mode.

Implements mitk::PlanarFigure.

Definition at line 76 of file mitkPlanarCross.h.

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

PlanarCross has either two or four control points, depending on the operation mode.

Implements mitk::PlanarFigure.

Definition at line 74 of file mitkPlanarCross.h.

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

Returns the number of features available for this PlanarCross (1 or 2).

Reimplemented from mitk::PlanarFigure.

Definition at line 117 of file mitkPlanarCross.cpp.

bool mitk::PlanarCross::GetSingleLineMode ( ) const

Indicates whether the PlanarFigure shall represent only a single line instead of an orthogonal cross.

Definition at line 42 of file mitkPlanarCross.cpp.

References mitk::GenericProperty< T >::GetValue().

mitk::PlanarCross::mitkClassMacro ( PlanarCross  ,
PlanarFigure   
)
mitk::PlanarCross::mitkCloneMacro ( Self  )
protected
static Pointer mitk::PlanarCross::New ( )
static
void mitk::PlanarCross::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual

Reimplemented from mitk::PlanarFigure.

Definition at line 329 of file mitkPlanarCross.cpp.

bool mitk::PlanarCross::ResetOnPointSelect ( )
overridevirtual

The cross shall be reset to a single line when a control point is selected.

Reimplemented from mitk::PlanarFigure.

Definition at line 59 of file mitkPlanarCross.cpp.

bool mitk::PlanarCross::ResetOnPointSelectNeeded ( ) const
overridevirtual

Reimplemented from mitk::PlanarFigure.

Definition at line 54 of file mitkPlanarCross.cpp.

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

Indicates whether the PlanarFigure shall represent only a single line instead of an orthogonal cross.

Definition at line 36 of file mitkPlanarCross.cpp.

References mitk::BoolProperty::New().

virtual void mitk::PlanarCross::SingleLineModeOff ( )
virtual
virtual void mitk::PlanarCross::SingleLineModeOn ( )
virtual

Indicates whether the PlanarFigure shall represent only a single line instead of an orthogonal cross.

Member Data Documentation

const unsigned int mitk::PlanarCross::FEATURE_ID_LONGESTDIAMETER
protected

Definition at line 106 of file mitkPlanarCross.h.

const unsigned int mitk::PlanarCross::FEATURE_ID_SHORTAXISDIAMETER
protected

Definition at line 107 of file mitkPlanarCross.h.


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