Class OverlayMark

Object
Overlay
OverlayMark

public class OverlayMark extends Overlay
An implementation of Overlay that draws a Mark on an image.
Author:
Owen Feehan
  • Constructor Details

    • OverlayMark

      public OverlayMark(Mark mark, RegionMembershipWithFlags regionMembership)
      Creates a new OverlayMark instance.
      Parameters:
      mark - The Mark to overlay.
      regionMembership - The region-membership associated with mark.
  • Method Details

    • box

      public BoundingBox box(DrawOverlay overlayWriter, Dimensions dim)
      Description copied from class: Overlay
      A bounding-box around the overlay.
      Specified by:
      box in class Overlay
      Parameters:
      overlayWriter - writes the overlay on the image.
      dim - the dimensions of the containing-image or scene.
      Returns:
      the bounding-box.
    • createObject

      public ObjectWithProperties createObject(Dimensions dimensionsEntireImage, BinaryValuesByte binaryValuesOut) throws CreateException
      Description copied from class: Overlay
      Derives an object-mask representation of the overlay to be drawn with overlayWriter.
      Specified by:
      createObject in class Overlay
      Parameters:
      dimensionsEntireImage - how large the image is onto which the overlay will be drawn.
      binaryValuesOut - what constitutes on and off pixels in the produced object-mask.
      Returns:
      the created object-mask with associated properties.
      Throws:
      CreateException - if the object cannot be created successfully.
    • getIdentifier

      public int getIdentifier()
      Gets the identifier of the mark.
      Returns:
      the identifier of the Mark
    • equals

      public boolean equals(Object o)
      Specified by:
      equals in class Overlay
    • canEqual

      protected boolean canEqual(Object other)
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in class Overlay
    • getMark

      public Mark getMark()
      The Mark to overlay.