Overlay (adams-pom 24.5.0-SNAPSHOT API)

All Superinterfaces:

CleanUpHandler, Destroyable, OptionHandler

All Known Subinterfaces:

OverlayWithCustomAlphaSupport

All Known Implementing Classes:

AbstractObjectOverlayFromReport, AbstractOverlay, AbstractPointOverlayFromReport, ClassificationLabelTextOverlay, MultiOverlay, NullOverlay, ObjectAnnotations, ObjectCentersOverlayFromReport, ObjectLocationsOverlayFromReport, SimplePointOverlayFromReport
```
public interface Overlay
extends OptionHandler, CleanUpHandler
```
Interface for overlays.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`annotationsChanged()`	Hook method for when annotations change.
`void`	`cleanUp()`	Cleans up data structures, frees up memory.
`String`	`enabledTipText()`	Returns the tip text for this property.
`boolean`	`getEnabled()`	Returns whether the overlay is enabled.
`void`	`paint(ObjectAnnotationPanel panel, Graphics g)`	Paints the overlay.
`void`	`setEnabled(boolean value)`	Sets whether the overlay is enabled.

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager, toCommandLine

- Method Detail
  - setEnabled
```
void setEnabled(boolean value)
```
    Sets whether the overlay is enabled.
    
    Parameters:
    
    value - true if enabled
  - getEnabled
```
boolean getEnabled()
```
    Returns whether the overlay is enabled.
    
    Returns:
    
    true if enabled
  - enabledTipText
```
String enabledTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - paint
```
void paint(ObjectAnnotationPanel panel,
           Graphics g)
```
    Paints the overlay.
    
    Parameters:
    
    panel - the owning panel
    
    g - the graphics context
  - annotationsChanged
```
void annotationsChanged()
```
    Hook method for when annotations change.
  - cleanUp
```
void cleanUp()
```
    Cleans up data structures, frees up memory.
    
    Specified by:
    
    cleanUp in interface CleanUpHandler