org.anchoranalysis.overlay

Class Overlay

Object

Overlay

All Implemented Interfaces:

Identifiable

Direct Known Subclasses:

OverlayMark, OverlayObjectMask

public abstract class Overlay
extends Object
implements Identifiable

An entity that will eventually be drawn on top of an image.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor and Description
Overlay()

Method Summary

Modifier and Type	Method and Description
abstract BoundingBox	box(DrawOverlay overlayWriter, Dimensions dimensions) A bounding-box around the overlay
abstract ObjectWithProperties	createObject(DrawOverlay overlayWriter, Dimensions dimEntireImage, BinaryValuesByte bvOut)
abstract ObjectWithProperties	createScaleObject(DrawOverlay overlayWriter, double zoomFactorNew, ObjectWithProperties om, Overlay ol, Dimensions dimensionsUnscaled, Dimensions dimensionsScaled, BinaryValuesByte bvOut)
abstract boolean	equals(Object obj)
abstract OverlayProperties	generateProperties(Optional<Resolution> resolution)
abstract int	hashCode()
abstract boolean	isPointInside(DrawOverlay overlayWriter, Point3i point) Is a point inside an overlay? (for a particular OverlayWriter).

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Identifiable

getIdentifier

Constructor Detail

Overlay

public Overlay()

Method Detail

box

public abstract BoundingBox box(DrawOverlay overlayWriter,
                                Dimensions dimensions)

A bounding-box around the overlay

Parameters:

overlayWriter -

dimensions - The dimensions of the containing-scene

Returns:

the bounding-box

createScaleObject

public abstract ObjectWithProperties createScaleObject(DrawOverlay overlayWriter,
                                                       double zoomFactorNew,
                                                       ObjectWithProperties om,
                                                       Overlay ol,
                                                       Dimensions dimensionsUnscaled,
                                                       Dimensions dimensionsScaled,
                                                       BinaryValuesByte bvOut)
                                                throws CreateException

Throws:

CreateException

createObject

public abstract ObjectWithProperties createObject(DrawOverlay overlayWriter,
                                                  Dimensions dimEntireImage,
                                                  BinaryValuesByte bvOut)
                                           throws CreateException

Throws:

CreateException

isPointInside

public abstract boolean isPointInside(DrawOverlay overlayWriter,
                                      Point3i point)

Is a point inside an overlay? (for a particular OverlayWriter).

Parameters:

overlayWriter -

point -

Returns:

equals

public abstract boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public abstract int hashCode()

Overrides:

hashCode in class Object

generateProperties

public abstract OverlayProperties generateProperties(Optional<Resolution> resolution)