org.hkijena.jipipe.extensions.parameters.library.roi

Enum Anchor

java.lang.Object

java.lang.Enum<Anchor>

org.hkijena.jipipe.extensions.parameters.library.roi.Anchor

All Implemented Interfaces:

Serializable, Comparable<Anchor>

public enum Anchor
extends Enum<Anchor>

An anchor

Enum Constant Summary

Enum Constants

Enum Constant and Description
BottomCenter
BottomLeft
BottomRight
CenterCenter
CenterLeft
CenterRight
TopCenter
TopLeft
TopRight

Method Summary

Modifier and Type	Method and Description
Rectangle	getRectangle(Point location, int width, int height) Reconstructs the rectangle from a location anchored inside
Point	getRectangleCoordinates(Rectangle rectangle) Gets the coordinate inside given rectangle
double	getRelativeX()
double	getRelativeY()
int	getRelevantParameters()
Rectangle	placeInside(Rectangle inner, Rectangle outer) Places the inner rectangle into the outer rectangle according to the anchor
static Anchor	valueOf(String name) Returns the enum constant of this type with the specified name.
static Anchor[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TopLeft

public static final Anchor TopLeft

TopCenter

public static final Anchor TopCenter

TopRight

public static final Anchor TopRight

BottomLeft

public static final Anchor BottomLeft

BottomCenter

public static final Anchor BottomCenter

BottomRight

public static final Anchor BottomRight

CenterLeft

public static final Anchor CenterLeft

CenterRight

public static final Anchor CenterRight

CenterCenter

public static final Anchor CenterCenter

Method Detail

values

public static Anchor[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Anchor c : Anchor.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Anchor valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getRelevantParameters

public int getRelevantParameters()

getRectangle

public Rectangle getRectangle(Point location,
                              int width,
                              int height)

Reconstructs the rectangle from a location anchored inside

Parameters:

width - the width

height - the height

Returns:

the rectangle

getRectangleCoordinates

public Point getRectangleCoordinates(Rectangle rectangle)

Gets the coordinate inside given rectangle

Parameters:

rectangle - the rectangle

Returns:

the coordinate inside the rectangle according to the anchor

placeInside

public Rectangle placeInside(Rectangle inner,
                             Rectangle outer)

Places the inner rectangle into the outer rectangle according to the anchor

Parameters:

inner - the inner (x and y are used to shift the rectangle; ignored on center-center); relative x and y

outer - the outer rectangle; absolute x and y

Returns:

the new inner rectangle. width and height are unchanged

getRelativeX

public double getRelativeX()

getRelativeY

public double getRelativeY()