org.jorigin.gui.JImageFeature Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jcommon Show documentation
A java common package that enable to deal with various functionalities
There is a newer version: 1.0.14
package org.jorigin.gui;

import java.awt.Graphics2D;
import java.awt.Shape;
import java.awt.geom.AffineTransform;

import org.jorigin.Common;
import org.jorigin.identification.Named;

/**
 * An image feature that can be displayed within a {@link JImagePanel JImagePanel}.
 * @author Julien Seinturier - COMEX S.A. - [email protected] - https://github.com/jorigin/jeometry
 * @version {@value Common#version} - b{@value Common#BUILD}
 * @since 1.0.4
 */
public interface JImageFeature extends Named, Displayable{

  /**
   * Draw this feature on the given {@link Graphics2D graphic context}. The given graphic context is related to the original image space. 
   * The transformation applied to the current display is given as transform and can be used to 
   * avoid rotation or scale for feature that have constant size or orientation (for example text features). 
   * @param g2d a graphic context expressed within image space.
   * @param transform the transform applied to the view within the {@link JImagePanel JImagePanel}.
   */
  public void draw(Graphics2D g2d, AffineTransform transform);
  
  /**
   * Check if the point described by the given coordinates (x, y) is inside the feature. 
   * The coordinates have to be expressed within original image space.
   * @param x the x coordinate of the point to check.
   * @param y the y coordinate of the point to check.
   * @return true if the feature is containing the point and false otherwise.
   * @see #contains(Shape)
   * @see #intersects(Shape)
   * @see JImageFeature#inside(Shape)
   */
  public boolean contains(double x, double y);
  
  /**
   * Check if the {@link Shape shape} given in parameter is inside the feature. 
   * The shape have to be expressed within original image space.
   * @param s the {@link Shape shape} to check.
   * @return true if the feature is containing the shape and false otherwise.
   * @see #contains(double, double)
   * @see #intersects(Shape)
   * @see #inside(Shape)
   */
  public boolean contains(Shape s);
  
  /**
   * Check if the {@link Shape shape} given in parameter is intersecting the feature. 
   * The shape have to be expressed within original image space.
   * @param s the {@link Shape shape} to check.
   * @return true if the feature is intersecting the shape and false otherwise.
   * @see #contains(double, double)
   * @see #contains(Shape)
   * @see #inside(Shape)
   */
  public boolean intersects(Shape s);
  
  /**
   * Check if the {@link Shape shape} given in parameter is inside the feature.
   * The shape have to be expressed within original image space.
   * @param s the {@link Shape shape} to check.
   * @return true if the feature is inside the shape and false otherwise.
   * @see #contains(Shape)
   * @see #contains(double, double)
   * @see #intersects(Shape)
   */
  public boolean inside(Shape s);
}