DefaultOverlayService (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.AbstractContextual
- - org.scijava.plugin.AbstractRichPlugin
  - - org.scijava.service.AbstractService
    - - net.imagej.display.DefaultOverlayService

All Implemented Interfaces:

Comparable<Prioritized>, OverlayService, ImageJService, Contextual, Disposable, Identifiable, Initializable, Locatable, Logged, HasPluginInfo, RichPlugin, SciJavaPlugin, Prioritized, Service, Versioned
```
public final class DefaultOverlayService
extends AbstractService
implements OverlayService
```
Default service for working with Overlays.

Author:

Curtis Rueden, Barry DeZonia

Constructor Summary

Constructors
Constructor and Description

DefaultOverlayService()

Constructors
Constructor and Description
`DefaultOverlayService()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addOverlays(ImageDisplay display, List<? extends Overlay> overlays)` Adds the list of `Overlay`s to the given `ImageDisplay`.
`void`	`divideCompositeOverlay(CompositeOverlay overlay)` Divides a CompositeOverlay into its constituent parts and registers each part with the appropriate displays.
`void`	`drawOverlay(Overlay o, Dataset ds, Position position, ChannelCollection channels)` Draws the outline of a given overlay in a dataset using the set of channel information provided.
`void`	`drawOverlay(Overlay o, ImageDisplay display, ChannelCollection channels)` Draws the outline of a given overlay in a display using the set of channel information provided.
`void`	`fillOverlay(Overlay o, Dataset ds, Position position, ChannelCollection channels)` Draws and fills the outline of a given overlay in a dataset using the set of channel information provided.
`void`	`fillOverlay(Overlay o, ImageDisplay display, ChannelCollection channels)` Draws and fills the outline of a given overlay in a display using the set of channel information provided.
`Overlay`	`getActiveOverlay(ImageDisplay disp)` Returns the active overlay associated with a display
`OverlaySettings`	`getDefaultSettings()`
`List<ImageDisplay>`	`getDisplays(Overlay o)` Returns all the displays associated with an overlay
`ImageDisplay`	`getFirstDisplay(Overlay o)` Returns the first display associated with an overlay
`ObjectService`	`getObjectService()`
`OverlayInfoList`	`getOverlayInfo()` Returns the overlay info list associated with this service.
`List<Overlay>`	`getOverlays()` Gets a list of all `Overlay`s.
`List<Overlay>`	`getOverlays(ImageDisplay display)` Gets a list of `Overlay`s linked to the given `ImageDisplay`.
`List<Overlay>`	`getOverlays(ImageDisplay display, boolean selectedOnly)` Gets a list of `Overlay`s linked to the given `ImageDisplay`.
`RealRect`	`getSelectionBounds(ImageDisplay display)` Gets the bounding box for the selected overlays in the given `ImageDisplay`.
`void`	`removeOverlay(ImageDisplay display, Overlay overlay)` Removes an `Overlay` from the given `ImageDisplay`.
`void`	`removeOverlay(Overlay overlay)` Removes an `Overlay` from all `ImageDisplay`s.

Methods inherited from class org.scijava.service.AbstractService
getContext, setContext, toString

Methods inherited from class org.scijava.plugin.AbstractRichPlugin
getInfo, getPriority, setInfo, setPriority

Methods inherited from class org.scijava.AbstractContextual
context

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.scijava.service.Service
initialize, registerEventHandlers

Methods inherited from interface org.scijava.plugin.RichPlugin
getIdentifier, log

Methods inherited from interface org.scijava.Contextual
context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized
compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo
getInfo, setInfo

Methods inherited from interface org.scijava.Locatable
getLocation

Methods inherited from interface org.scijava.Versioned
getVersion

Methods inherited from interface org.scijava.Disposable
dispose

- Constructor Detail
  - DefaultOverlayService
```
public DefaultOverlayService()
```
- Method Detail
  - getObjectService
```
public ObjectService getObjectService()
```
    Specified by:
    
    getObjectService in interface OverlayService
  - getOverlays
```
public List<Overlay> getOverlays()
```
    Description copied from interface: OverlayService
    
    Gets a list of all Overlays. This method is a shortcut that delegates to ObjectService.
    
    Specified by:
    
    getOverlays in interface OverlayService
  - getOverlays
```
public List<Overlay> getOverlays(ImageDisplay display,
                                 boolean selectedOnly)
```
    Description copied from interface: OverlayService
    
    Gets a list of Overlays linked to the given ImageDisplay. If selectedOnly is true then it will gather overlays from the selected views only. Otherwise it will gather overlays from all the views.
    
    Specified by:
    
    getOverlays in interface OverlayService
  - getOverlays
```
public List<Overlay> getOverlays(ImageDisplay display)
```
    Description copied from interface: OverlayService
    
    Gets a list of Overlays linked to the given ImageDisplay. A shortcut for getOverlays(display, false).
    
    Specified by:
    
    getOverlays in interface OverlayService
  - addOverlays
```
public void addOverlays(ImageDisplay display,
                        List<? extends Overlay> overlays)
```
    Description copied from interface: OverlayService
    
    Adds the list of Overlays to the given ImageDisplay.
    
    Specified by:
    
    addOverlays in interface OverlayService
  - removeOverlay
```
public void removeOverlay(ImageDisplay display,
                          Overlay overlay)
```
    Description copied from interface: OverlayService
    
    Removes an Overlay from the given ImageDisplay.
    
    Specified by:
    
    removeOverlay in interface OverlayService
    
    Parameters:
    
    display - the ImageDisplay from which the overlay should be removed
    
    overlay - the Overlay to remove
  - removeOverlay
```
public void removeOverlay(Overlay overlay)
```
    Description copied from interface: OverlayService
    
    Removes an Overlay from all ImageDisplays.
    
    Specified by:
    
    removeOverlay in interface OverlayService
    
    Parameters:
    
    overlay - the Overlay to remove
  - getSelectionBounds
```
public RealRect getSelectionBounds(ImageDisplay display)
```
    Description copied from interface: OverlayService
    
    Gets the bounding box for the selected overlays in the given ImageDisplay.
    
    Specified by:
    
    getSelectionBounds in interface OverlayService
    
    Parameters:
    
    display - the ImageDisplay from which the bounding box should be computed
    
    Returns:
    
    the smallest bounding box encompassing all selected overlays
  - getDefaultSettings
```
public OverlaySettings getDefaultSettings()
```
    Specified by:
    
    getDefaultSettings in interface OverlayService
  - drawOverlay
```
public void drawOverlay(Overlay o,
                        ImageDisplay display,
                        ChannelCollection channels)
```
    Description copied from interface: OverlayService
    
    Draws the outline of a given overlay in a display using the set of channel information provided.
    
    Specified by:
    
    drawOverlay in interface OverlayService
  - drawOverlay
```
public void drawOverlay(Overlay o,
                        Dataset ds,
                        Position position,
                        ChannelCollection channels)
```
    Description copied from interface: OverlayService
    
    Draws the outline of a given overlay in a dataset using the set of channel information provided.
    
    Specified by:
    
    drawOverlay in interface OverlayService
  - fillOverlay
```
public void fillOverlay(Overlay o,
                        ImageDisplay display,
                        ChannelCollection channels)
```
    Description copied from interface: OverlayService
    
    Draws and fills the outline of a given overlay in a display using the set of channel information provided.
    
    Specified by:
    
    fillOverlay in interface OverlayService
  - fillOverlay
```
public void fillOverlay(Overlay o,
                        Dataset ds,
                        Position position,
                        ChannelCollection channels)
```
    Description copied from interface: OverlayService
    
    Draws and fills the outline of a given overlay in a dataset using the set of channel information provided.
    
    Specified by:
    
    fillOverlay in interface OverlayService
  - getFirstDisplay
```
public ImageDisplay getFirstDisplay(Overlay o)
```
    Description copied from interface: OverlayService
    
    Returns the first display associated with an overlay
    
    Specified by:
    
    getFirstDisplay in interface OverlayService
  - getDisplays
```
public List<ImageDisplay> getDisplays(Overlay o)
```
    Description copied from interface: OverlayService
    
    Returns all the displays associated with an overlay
    
    Specified by:
    
    getDisplays in interface OverlayService
  - getActiveOverlay
```
public Overlay getActiveOverlay(ImageDisplay disp)
```
    Description copied from interface: OverlayService
    
    Returns the active overlay associated with a display
    
    Specified by:
    
    getActiveOverlay in interface OverlayService
  - getOverlayInfo
```
public OverlayInfoList getOverlayInfo()
```
    Description copied from interface: OverlayService
    
    Returns the overlay info list associated with this service. There is one list per ImageJ context. It tracks overlay selection info and is used by any defined overlay managers.
    
    Specified by:
    
    getOverlayInfo in interface OverlayService
  - divideCompositeOverlay
```
public void divideCompositeOverlay(CompositeOverlay overlay)
```
    Description copied from interface: OverlayService
    
    Divides a CompositeOverlay into its constituent parts and registers each part with the appropriate displays. Deletes the CompositeOverlay.
    
    Specified by:
    
    divideCompositeOverlay in interface OverlayService

Class DefaultOverlayService

Constructor Summary

Method Summary

Methods inherited from class org.scijava.service.AbstractService

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

Methods inherited from class org.scijava.AbstractContextual

Methods inherited from class java.lang.Object

Methods inherited from interface org.scijava.service.Service

Methods inherited from interface org.scijava.plugin.RichPlugin

Methods inherited from interface org.scijava.Contextual

Methods inherited from interface org.scijava.Prioritized

Methods inherited from interface org.scijava.plugin.HasPluginInfo

Methods inherited from interface org.scijava.Locatable

Methods inherited from interface org.scijava.Versioned

Methods inherited from interface org.scijava.Disposable

Constructor Detail

DefaultOverlayService

Method Detail

getObjectService

getOverlays

getOverlays

getOverlays

addOverlays

removeOverlay

removeOverlay

getSelectionBounds

getDefaultSettings

drawOverlay

drawOverlay

fillOverlay

fillOverlay

getFirstDisplay

getDisplays

getActiveOverlay

getOverlayInfo

divideCompositeOverlay