Class PromptImageGeometryData

java.lang.Object

de.xima.fc.prompt.service.support.PromptImageGeometryData

public final class PromptImageGeometryData
extends Object

Represents the target geometry of an image. The image is placed on a canvas of the given size at the given coordinates and with the given size.

      (Canvas)
    +----------------------------------------------+
    |                                              |
    |                                              |
    |                                              |
    |                                              |
    |   P(imageX,imageY)                            |
    |   +-----------------------+                  |
    |   |                       |                  | (canvas height)
    |   |                       |                  |
    |   |         (Image)       | (image height)   |
    |   |                       |                  |
    |   |                       |                  |
    |   +-----------------------+                  |
    |         (image width)                        |
    |                                              |
    +----------------------------------------------+
              (canvas width)

Since:

8.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PromptImageGeometryData.Builder	Builder for PromptImageGeometryData.

Method Summary

Modifier and Type	Method	Description
static PromptImageGeometryData.Builder	builder()	Creates a builder for PromptImageGeometryData.
int	canvasHeight()	Gets the height of the canvas.
int	canvasWidth()	Gets the width of the canvas.
int	imageHeight()	Gets the height of the image inside the canvas.
int	imageWidth()	Gets the width of the image inside the canvas.
int	imageX()	Gets the X coordinate of the image inside the canvas.
int	imageY()	Gets the Y coordinate of the image inside the canvas.

Methods inherited from class Object

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

Method Details

canvasHeight

public int canvasHeight()

Gets the height of the canvas.

Returns:

The height of the canvas.

canvasWidth

public int canvasWidth()

Gets the width of the canvas.

Returns:

The width of the canvas.

imageHeight

public int imageHeight()

Gets the height of the image inside the canvas.

Returns:

The height of the image.

imageWidth

public int imageWidth()

Gets the width of the image inside the canvas.

Returns:

The width of the image.

imageX

public int imageX()

Gets the X coordinate of the image inside the canvas.

Returns:

The X coordinate of the image.

imageY

public int imageY()

Gets the Y coordinate of the image inside the canvas.

Returns:

The Y coordinate of the image.

builder

public static PromptImageGeometryData.Builder builder()

Creates a builder for PromptImageGeometryData.

Returns:

The builder.