icy.util

Class ShapeUtil

java.lang.Object

icy.util.ShapeUtil

public class ShapeUtil
extends java.lang.Object

Author:

Stephane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShapeUtil.BooleanOperator
static interface	ShapeUtil.PathConsumer
static interface	ShapeUtil.ShapeConsumer
static class	ShapeUtil.ShapeOperation Deprecated. Use ShapeUtil.BooleanOperator instead.

Constructor Summary

Constructors

Constructor and Description
ShapeUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static java.awt.Shape	add(java.awt.Shape shape1, java.awt.Shape shape2) Deprecated. Use union(Shape, Shape) instead
static java.awt.geom.Path2D	buildPathFromAnchors(java.awt.geom.Path2D path, java.util.List<PathAnchor2D> points) Update specified path from the specified list of PathAnchor2D
static java.awt.geom.Path2D	buildPathFromAnchors(java.awt.geom.Path2D path, java.util.List<PathAnchor2D> points, boolean closePath) Update specified path from the specified list of PathAnchor2D
static boolean	consumeShapeFromPath(java.awt.geom.PathIterator path, ShapeUtil.ShapeConsumer consumer) Permit to describe any PathIterator in a list of Shape which are returned to the specified ShapeConsumer
static void	consumeSubPath(java.awt.geom.PathIterator pathIt, ShapeUtil.PathConsumer consumer) Consume all sub path of the specified PathIterator.
static void	consumeSubPath(java.awt.Shape shape, ShapeUtil.PathConsumer consumer) Consume all sub path of the specified Shape.
static void	drawFromPath(java.awt.geom.PathIterator path, java.awt.Graphics2D g) Deprecated. Use GraphicsUtil.drawPathIterator(PathIterator, Graphics2D) instead
static void	enlarge(java.awt.geom.RectangularShape shape, double width, double height, boolean centered) Enlarge the specified RectangularShape by specified width and height.
static java.awt.geom.Area	exclusiveUnion(java.awt.Shape shape1, java.awt.Shape shape2) Do exclusive union between the 2 shapes and return result in an Area type shape.
static java.util.ArrayList<PathAnchor2D>	getAnchorsFromShape(java.awt.Shape shape) Return all PathAnchor points from the specified shape
static java.util.ArrayList<PathAnchor2D>	getAnchorsFromShape(java.awt.Shape shape, java.awt.Color color, java.awt.Color selectedColor) Return all PathAnchor points from the specified shape
static java.awt.geom.Path2D	getClosedPath(java.awt.Shape shape) Returns only the closed path part of the specified Shape.
static java.awt.geom.Path2D	getOpenPath(java.awt.Shape shape) Returns only the open path part of the specified Shape.
static java.awt.geom.Path2D	getPathFromAnchors(java.util.List<PathAnchor2D> points) Create and return a path from the specified list of PathAnchor2D
static java.awt.geom.Path2D	getPathFromAnchors(java.util.List<PathAnchor2D> points, boolean closePath) Create and return a path from the specified list of PathAnchor2D
static java.awt.geom.Area	intersect(java.awt.Shape shape1, java.awt.Shape shape2) Intersects 2 shapes and return result in an Area type shape.
static boolean	isClosed(java.awt.Shape shape) Returns true if the specified Shape define a closed Shape (Area).
static boolean	isVisible(java.awt.Graphics g, java.awt.Shape shape) Use the Graphics clip area and Shape bounds informations to determine if the specified Shape is visible in the specified Graphics object.
static java.awt.Shape	merge(java.util.List<java.awt.Shape> shapes, ShapeUtil.BooleanOperator operator) Merge the specified list of Shape with the given ShapeUtil.BooleanOperator.
static java.awt.Shape	merge(java.awt.Shape[] shapes, ShapeUtil.ShapeOperation operation) Deprecated. Use merge(List, BooleanOperator) instead.
static boolean	pathIntersects(java.awt.geom.PathIterator path, java.awt.geom.Rectangle2D rect) Return true if the specified PathIterator intersects with the specified Rectangle
static void	scale(java.awt.geom.RectangularShape shape, double factor, boolean centered) Scale the specified RectangularShape by specified factor.
static void	scale(java.awt.geom.RectangularShape shape, double factor, boolean centered, boolean scalePosition) Scale the specified RectangularShape by specified factor.
static java.awt.geom.Area	subtract(java.awt.Shape shape1, java.awt.Shape shape2) Subtract shape2 from shape1 return result in an Area type shape.
static void	translate(java.awt.geom.RectangularShape shape, double dx, double dy) Translate a rectangular shape by the specified dx and dy value
static void	translate(java.awt.geom.RectangularShape shape, int dx, int dy) Translate a rectangular shape by the specified dx and dy value
static java.awt.Shape	union(java.awt.Shape shape1, java.awt.Shape shape2) Process union between the 2 shapes and return result in a new Shape.
static java.awt.geom.Area	xor(java.awt.Shape shape1, java.awt.Shape shape2) Deprecated. Use exclusiveUnion(Shape, Shape) instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShapeUtil

public ShapeUtil()

Method Detail

isVisible

public static boolean isVisible(java.awt.Graphics g,
                java.awt.Shape shape)

Use the Graphics clip area and Shape bounds informations to determine if the specified Shape is visible in the specified Graphics object.

isClosed

public static boolean isClosed(java.awt.Shape shape)

Returns true if the specified Shape define a closed Shape (Area).
Returns false if the specified Shape define a open Shape (Path).

merge

public static java.awt.Shape merge(java.util.List<java.awt.Shape> shapes,
                   ShapeUtil.BooleanOperator operator)

Merge the specified list of Shape with the given ShapeUtil.BooleanOperator.

Parameters:

shapes - Shapes we want to merge.

operator - ShapeUtil.BooleanOperator to apply.

Returns:

Area shape representing the result of the merge operation.

merge

@Deprecated
public static java.awt.Shape merge(java.awt.Shape[] shapes,
                              ShapeUtil.ShapeOperation operation)

Deprecated. Use merge(List, BooleanOperator) instead.

union

public static java.awt.Shape union(java.awt.Shape shape1,
                   java.awt.Shape shape2)

Process union between the 2 shapes and return result in a new Shape.

add

@Deprecated
public static java.awt.Shape add(java.awt.Shape shape1,
                            java.awt.Shape shape2)

Deprecated. Use union(Shape, Shape) instead

intersect

public static java.awt.geom.Area intersect(java.awt.Shape shape1,
                           java.awt.Shape shape2)

Intersects 2 shapes and return result in an Area type shape.
If one of the specified Shape is not an Area (do not contains any pixel) then an empty Area is returned.

exclusiveUnion

public static java.awt.geom.Area exclusiveUnion(java.awt.Shape shape1,
                                java.awt.Shape shape2)

Do exclusive union between the 2 shapes and return result in an Area type shape.
If one of the specified Shape is not an Area (do not contains any pixel) then it just return the other Shape in Area format. If both Shape are not Area then an empty Area is returned.

xor

@Deprecated
public static java.awt.geom.Area xor(java.awt.Shape shape1,
                                java.awt.Shape shape2)

Deprecated. Use exclusiveUnion(Shape, Shape) instead.

subtract

public static java.awt.geom.Area subtract(java.awt.Shape shape1,
                          java.awt.Shape shape2)

Subtract shape2 from shape1 return result in an Area type shape.

scale

public static void scale(java.awt.geom.RectangularShape shape,
         double factor,
         boolean centered,
         boolean scalePosition)

Scale the specified RectangularShape by specified factor.

Parameters:

shape - the RectangularShape to scale

factor - the scale factor

centered - if true then scaling is centered (shape location is modified)

scalePosition - if true then position is also 'rescaled' (shape location is modified)

scale

public static void scale(java.awt.geom.RectangularShape shape,
         double factor,
         boolean centered)

Scale the specified RectangularShape by specified factor.

Parameters:

shape - the RectangularShape to scale

factor - the scale factor

centered - if true then scaling is centered (shape location is modified)

enlarge

public static void enlarge(java.awt.geom.RectangularShape shape,
           double width,
           double height,
           boolean centered)

Enlarge the specified RectangularShape by specified width and height.

Parameters:

shape - the RectangularShape to scale

width - the width to add

height - the height to add

centered - if true then enlargement is centered (shape location is modified)

translate

public static void translate(java.awt.geom.RectangularShape shape,
             int dx,
             int dy)

Translate a rectangular shape by the specified dx and dy value

translate

public static void translate(java.awt.geom.RectangularShape shape,
             double dx,
             double dy)

Translate a rectangular shape by the specified dx and dy value

consumeShapeFromPath

public static boolean consumeShapeFromPath(java.awt.geom.PathIterator path,
                           ShapeUtil.ShapeConsumer consumer)

Permit to describe any PathIterator in a list of Shape which are returned to the specified ShapeConsumer

consumeSubPath

public static void consumeSubPath(java.awt.geom.PathIterator pathIt,
                  ShapeUtil.PathConsumer consumer)

Consume all sub path of the specified PathIterator.
We consider a new sub path when we meet both a PathIterator.SEG_MOVETO segment or after a PathIterator.SEG_CLOSE segment (except the ending one).

consumeSubPath

public static void consumeSubPath(java.awt.Shape shape,
                  ShapeUtil.PathConsumer consumer)

Consume all sub path of the specified Shape.
We consider a new sub path when we meet both a PathIterator.SEG_MOVETO segment or after a PathIterator.SEG_CLOSE segment (except the ending one).

getOpenPath

public static java.awt.geom.Path2D getOpenPath(java.awt.Shape shape)

Returns only the open path part of the specified Shape.
By default all sub path inside a Shape are considered closed which can be a problem when drawing or using Path2D.contains(double, double) method.

getClosedPath

public static java.awt.geom.Path2D getClosedPath(java.awt.Shape shape)

Returns only the closed path part of the specified Shape.
By default all sub path inside a Shape are considered closed which can be a problem when drawing or using Path2D.contains(double, double) method.

getAnchorsFromShape

public static java.util.ArrayList<PathAnchor2D> getAnchorsFromShape(java.awt.Shape shape,
                                                    java.awt.Color color,
                                                    java.awt.Color selectedColor)

Return all PathAnchor points from the specified shape

getAnchorsFromShape

public static java.util.ArrayList<PathAnchor2D> getAnchorsFromShape(java.awt.Shape shape)

Return all PathAnchor points from the specified shape

buildPathFromAnchors

public static java.awt.geom.Path2D buildPathFromAnchors(java.awt.geom.Path2D path,
                                        java.util.List<PathAnchor2D> points,
                                        boolean closePath)

Update specified path from the specified list of PathAnchor2D

buildPathFromAnchors

public static java.awt.geom.Path2D buildPathFromAnchors(java.awt.geom.Path2D path,
                                        java.util.List<PathAnchor2D> points)

Update specified path from the specified list of PathAnchor2D

getPathFromAnchors

public static java.awt.geom.Path2D getPathFromAnchors(java.util.List<PathAnchor2D> points,
                                      boolean closePath)

Create and return a path from the specified list of PathAnchor2D

getPathFromAnchors

public static java.awt.geom.Path2D getPathFromAnchors(java.util.List<PathAnchor2D> points)

Create and return a path from the specified list of PathAnchor2D

drawFromPath

@Deprecated
public static void drawFromPath(java.awt.geom.PathIterator path,
                           java.awt.Graphics2D g)

Deprecated. Use GraphicsUtil.drawPathIterator(PathIterator, Graphics2D) instead

pathIntersects

public static boolean pathIntersects(java.awt.geom.PathIterator path,
                     java.awt.geom.Rectangle2D rect)

Return true if the specified PathIterator intersects with the specified Rectangle