Package adams.gui.visualization.object.objectannotations.outline

Class PolygonVertices

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.object.objectannotations.outline.AbstractOutlinePlotter

adams.gui.visualization.object.objectannotations.outline.AbstractStrokeOutlinePlotter

adams.gui.visualization.object.objectannotations.outline.PolygonVertices

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, BoundingBoxFallbackSupporter, OptionalBoundingBoxFallbackSupporter, OutlinePlotter, SubsetPlotSupporter, Serializable

public class PolygonVertices
extends AbstractStrokeOutlinePlotter
implements OptionalBoundingBoxFallbackSupporter, SubsetPlotSupporter

Plots the polygon vertices.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double	m_BoundingBoxFallbackRatio	the ratio used for determining whether to fall back from polygon on bbox.
protected int	m_Extent	the maximum width/height of the shape to plot around the vertices.
protected boolean	m_Fallback	whether to fallback on bounding box.
protected Set<LocatedObject>	m_PlotSubset	the objects to limit the plotting to.
protected VertexShape	m_Shape	the marker shape.

Fields inherited from class adams.gui.visualization.object.objectannotations.outline.AbstractStrokeOutlinePlotter

m_StrokeThickness

Fields inherited from class adams.gui.visualization.object.objectannotations.outline.AbstractOutlinePlotter

m_Enabled

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
PolygonVertices()

Method Summary

Modifier and Type	Method	Description
String	boundingBoxFallbackRatioTipText()	Returns the tip text for this property.
void	clearPlotSubset()	Clears the objects to limit plotting to.
void	defineOptions()	Adds options to the internal list of options.
protected void	doPlot(LocatedObject object, Color color, Graphics2D g)	Plots the outline.
String	extentTipText()	Returns the tip text for this property.
String	fallbackTipText()	Returns the tip text for this property.
double	getBoundingBoxFallbackRatio()	Returns the ratio between shape area over bbox area.
int	getExtent()	Returns the size of the vertices.
boolean	getFallback()	Returns whether to fall back on the bounding box if no polygon available.
LocatedObject[]	getPlotSubset()	Returns the current subset to plot.
VertexShape	getShape()	Returns the shape in use for vertices.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
void	setBoundingBoxFallbackRatio(double value)	Sets the ratio between shape area over bbox area.
void	setExtent(int value)	Sets the size of the vertices.
void	setFallback(boolean value)	Sets whether to fall back on the bounding box if no polygon available.
void	setPlotSubset(LocatedObject obj)	Sets the object to limit the plotting to.
void	setPlotSubset(LocatedObject[] objs)	Sets the objects to limit the plotting to.
void	setPlotSubset(List<LocatedObject> objs)	Sets the objects to limit the plotting to.
void	setShape(VertexShape value)	Sets the shape to use for vertices.
String	shapeTipText()	Returns the tip text for this property.

Methods inherited from class adams.gui.visualization.object.objectannotations.outline.AbstractStrokeOutlinePlotter

applyStroke, doPlotOutline, generateQuickInfo, getStrokeThickness, getStrokeWidth, setStrokeThickness, strokeThicknessTipText

Methods inherited from class adams.gui.visualization.object.objectannotations.outline.AbstractOutlinePlotter

enabledTipText, getEnabled, getQuickInfo, plotOutline, setEnabled

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.gui.visualization.object.objectannotations.outline.OutlinePlotter

plotOutline

Methods inherited from interface adams.core.QuickInfoSupporter

getQuickInfo

Field Detail

m_Shape

protected VertexShape m_Shape

the marker shape.

m_Extent

protected int m_Extent

the maximum width/height of the shape to plot around the vertices.

m_Fallback

protected boolean m_Fallback

whether to fallback on bounding box.

m_BoundingBoxFallbackRatio

protected double m_BoundingBoxFallbackRatio

the ratio used for determining whether to fall back from polygon on bbox.

m_PlotSubset

protected Set<LocatedObject> m_PlotSubset

the objects to limit the plotting to.

Constructor Detail

PolygonVertices

public PolygonVertices()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractStrokeOutlinePlotter

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractOptionHandler

setShape

public void setShape(VertexShape value)

Sets the shape to use for vertices.

Parameters:

value - the shape

getShape

public VertexShape getShape()

Returns the shape in use for vertices.

Returns:

the shape

shapeTipText

public String shapeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setExtent

public void setExtent(int value)

Sets the size of the vertices.

Parameters:

value - the extent

getExtent

public int getExtent()

Returns the size of the vertices.

Returns:

the extent

extentTipText

public String extentTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setFallback

public void setFallback(boolean value)

Sets whether to fall back on the bounding box if no polygon available.

Specified by:

setFallback in interface OptionalBoundingBoxFallbackSupporter

Parameters:

value - true if to use

getFallback

public boolean getFallback()

Returns whether to fall back on the bounding box if no polygon available.

Specified by:

getFallback in interface OptionalBoundingBoxFallbackSupporter

Returns:

true if to use

fallbackTipText

public String fallbackTipText()

Returns the tip text for this property.

Specified by:

fallbackTipText in interface OptionalBoundingBoxFallbackSupporter

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setBoundingBoxFallbackRatio

public void setBoundingBoxFallbackRatio(double value)

Sets the ratio between shape area over bbox area. If below the bbox is used instead of the polygon.

Specified by:

setBoundingBoxFallbackRatio in interface BoundingBoxFallbackSupporter

Parameters:

value - the ratio

getBoundingBoxFallbackRatio

public double getBoundingBoxFallbackRatio()

Returns the ratio between shape area over bbox area. If below the bbox is used instead of the polygon.

Specified by:

getBoundingBoxFallbackRatio in interface BoundingBoxFallbackSupporter

Returns:

the ratio

boundingBoxFallbackRatioTipText

public String boundingBoxFallbackRatioTipText()

Returns the tip text for this property.

Specified by:

boundingBoxFallbackRatioTipText in interface BoundingBoxFallbackSupporter

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setPlotSubset

public void setPlotSubset(LocatedObject obj)

Sets the object to limit the plotting to.

Specified by:

setPlotSubset in interface SubsetPlotSupporter

Parameters:

obj - the object

setPlotSubset

public void setPlotSubset(LocatedObject[] objs)

Sets the objects to limit the plotting to.

Specified by:

setPlotSubset in interface SubsetPlotSupporter

Parameters:

objs - the objects

setPlotSubset

public void setPlotSubset(List<LocatedObject> objs)

Sets the objects to limit the plotting to.

Specified by:

setPlotSubset in interface SubsetPlotSupporter

Parameters:

objs - the objects

getPlotSubset

public LocatedObject[] getPlotSubset()

Returns the current subset to plot.

Specified by:

getPlotSubset in interface SubsetPlotSupporter

Returns:

the objects, null if none set

clearPlotSubset

public void clearPlotSubset()

Clears the objects to limit plotting to.

Specified by:

clearPlotSubset in interface SubsetPlotSupporter

doPlot

protected void doPlot(LocatedObject object,
                      Color color,
                      Graphics2D g)

Plots the outline.

Specified by:

doPlot in class AbstractStrokeOutlinePlotter

Parameters:

object - the object to plot

color - the color to use

g - the graphics context