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

Class PolygonOutline

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

All Implemented Interfaces:

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

public class PolygonOutline
extends AbstractStrokeOutlinePlotter
implements OptionalBoundingBoxFallbackSupporter

Plots the polygon.

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 boolean	m_Fallback	whether to fallback on bounding box.

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

Method Summary

Modifier and Type	Method	Description
String	boundingBoxFallbackRatioTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected void	doPlot(LocatedObject object, Color color, Graphics2D g)	Plots the outline.
String	fallbackTipText()	Returns the tip text for this property.
double	getBoundingBoxFallbackRatio()	Returns the ratio between shape area over bbox area.
boolean	getFallback()	Returns whether to fall back on the bounding box if no polygon available.
String	globalInfo()	Returns a string describing the object.
void	setBoundingBoxFallbackRatio(double value)	Sets the ratio between shape area over bbox area.
void	setFallback(boolean value)	Sets whether to fall back on the bounding box if no polygon available.

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

Field Detail

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.

Constructor Detail

PolygonOutline

public PolygonOutline()

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

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.

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