ImageShape.Builder (JPAZ2 1.1.1 API)

java.lang.Object
- sk.upjs.jpaz2.ImageShape.Builder

Enclosing class:

ImageShape
```
public static class ImageShape.Builder
extends Object
```
The builder of ImageShape class instances. This class is not thread-safe.

Constructor Summary

Constructors
Constructor and Description
`Builder(File imageFile)` Constructs a builder of a shape from an image file.
`Builder(String imageLocation)` Constructs a builder of a shape from a file at the given location (resource or file).
`Builder(String packageName, String fileName)` Constructs a builder of a shape from a resource located in specified package and given filename.
`Builder(URL imageURL)` Constructs a builder of a shape from image with given URL.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`areFramesInRows()` Returns orientation of animation frames in the input image.
`ImageShape`	`createShape()` Creates an instance of the ImageTurtleShape according to current setting of this builder.
`int`	`getFrameCount()` Returns the number of animation frames.
`Long`	`getFrameDuration()` Returns the frame duration in milliseconds for views with multiple frames.
`Point2D`	`getShapeCenter()` Returns position of the shape center or null if it is not defined.
`URL`	`getURL()` Returns URL of the image.
`int`	`getViewCount()` Returns the number of views in the image.
`boolean`	`isTopLeftToTransparentColor()` Returns whether color of the pixel in the top-left corner of the image is considered as a transparent color.
`boolean`	`isTransparentExcludedFromShape()` Returns whether transparent pixels of the shape image are considered as excluded from the shape in sense of the isPointOfShape method.
`ImageShape.Builder`	`setFrameCount(int frameCount)` Sets the number of animation frames in the image.
`ImageShape.Builder`	`setFrameDuration(long frameDuration)` Sets the frame duration in milliseconds for views with multiple frames.
`ImageShape.Builder`	`setFramesInRows(boolean framesInRows)` Sets orientation of animation frames in the input image.
`ImageShape.Builder`	`setShapeCenter(double x, double y)` Sets the position of shape center.
`ImageShape.Builder`	`setTopLeftToTransparentColor(boolean recolor)` Sets whether color of the pixel in the top-left corner of the image is considered as a transparent color.
`ImageShape.Builder`	`setTransparentExcludedFromShape(boolean excluded)` SetsReturns whether transparent pixels of the shape image are considered as excluded from the shape in sense of the isPointOfShape method.
`ImageShape.Builder`	`setViewCount(int viewCount)` Sets the number of views in the image.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder(URL imageURL)
```
    Constructs a builder of a shape from image with given URL.
    
    Parameters:
    
    imageURL - the URL of the image file
  - Builder
```
public Builder(File imageFile)
```
    Constructs a builder of a shape from an image file.
    
    Parameters:
    
    imageFile - the image file
  - Builder
```
public Builder(String imageLocation)
```
    Constructs a builder of a shape from a file at the given location (resource or file). If location string starts with /, it is first considered to be a resource location. If resource localization failed, location string is considered as a file
    
    Parameters:
    
    imageLocation - the string with location of an image (file or resource)
  - Builder
```
public Builder(String packageName,
               String fileName)
```
    Constructs a builder of a shape from a resource located in specified package and given filename.
    
    Parameters:
    
    packageName - the package where resource file is searched
    
    fileName - the filename (in the package given by parameter packageName)
- Method Detail
  - setShapeCenter
```
public ImageShape.Builder setShapeCenter(double x,
                                         double y)
```
    Sets the position of shape center.
    
    Parameters:
    
    x - the X-coordinate of the shape center
    
    y - the Y-coordinate of the shape center
    
    Returns:
    
    a reference to this object
  - getShapeCenter
```
public Point2D getShapeCenter()
```
    Returns position of the shape center or null if it is not defined.
    
    Returns:
    
    the defined position of the shape center
  - setFrameCount
```
public ImageShape.Builder setFrameCount(int frameCount)
```
    Sets the number of animation frames in the image.
    
    Parameters:
    
    frameCount - the number of animation frames
    
    Returns:
    
    a reference to this object
  - getFrameCount
```
public int getFrameCount()
```
    Returns the number of animation frames.
    
    Returns:
    
    the number of animation frames.
  - setViewCount
```
public ImageShape.Builder setViewCount(int viewCount)
```
    Sets the number of views in the image.
    
    Parameters:
    
    viewCount - the number of shape views
    
    Returns:
    
    a reference to this object
  - getViewCount
```
public int getViewCount()
```
    Returns the number of views in the image.
    
    Returns:
    
    the number of views that are available in this image shape.
  - setFrameDuration
```
public ImageShape.Builder setFrameDuration(long frameDuration)
```
    Sets the frame duration in milliseconds for views with multiple frames.
    
    Parameters:
    
    frameDuration - the frame duration in milliseconds
    
    Returns:
    
    a reference to this object
  - getFrameDuration
```
public Long getFrameDuration()
```
    Returns the frame duration in milliseconds for views with multiple frames.
    
    Returns:
    
    the frame duration in milliseconds
  - getURL
```
public URL getURL()
```
    Returns URL of the image.
    
    Returns:
    
    URL of the image
  - setFramesInRows
```
public ImageShape.Builder setFramesInRows(boolean framesInRows)
```
    Sets orientation of animation frames in the input image.
    
    Parameters:
    
    framesInRows - true, if frames of a view are placed horizontally, false, if vertically
    
    Returns:
    
    a reference to this object
  - areFramesInRows
```
public boolean areFramesInRows()
```
    Returns orientation of animation frames in the input image.
    
    Returns:
    
    true, if animation frames of a view are placed horizontally, false, if vertically
  - createShape
```
public ImageShape createShape()
```
    Creates an instance of the ImageTurtleShape according to current setting of this builder.
    
    Returns:
    
    a new instance of the ImageTurtleShape class
  - isTopLeftToTransparentColor
```
public boolean isTopLeftToTransparentColor()
```
    Returns whether color of the pixel in the top-left corner of the image is considered as a transparent color.
    
    Returns:
    
    true, if recoloring will be applied, false otherwise
  - setTopLeftToTransparentColor
```
public ImageShape.Builder setTopLeftToTransparentColor(boolean recolor)
```
    Sets whether color of the pixel in the top-left corner of the image is considered as a transparent color.
    
    Parameters:
    
    recolor - true, if recoloring has to be applied, false otherwise
    
    Returns:
    
    a reference to this object
  - isTransparentExcludedFromShape
```
public boolean isTransparentExcludedFromShape()
```
    Returns whether transparent pixels of the shape image are considered as excluded from the shape in sense of the isPointOfShape method.
    
    Returns:
    
    true, if transparent pixels are excluded from the shape, false otherwise.
  - setTransparentExcludedFromShape
```
public ImageShape.Builder setTransparentExcludedFromShape(boolean excluded)
```
    SetsReturns whether transparent pixels of the shape image are considered as excluded from the shape in sense of the isPointOfShape method.
    
    Parameters:
    
    excluded - true, if transparent pixels are excluded from the shape, false otherwise.
    
    Returns:
    
    a reference to this object

Class ImageShape.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Builder

Builder

Builder

Method Detail

setShapeCenter

getShapeCenter

setFrameCount

getFrameCount

setViewCount

getViewCount

setFrameDuration

getFrameDuration

getURL

setFramesInRows

areFramesInRows

createShape

isTopLeftToTransparentColor

setTopLeftToTransparentColor

isTransparentExcludedFromShape

setTransparentExcludedFromShape