Top Description Fields Constructors Methods
com.sun.javafx.geom

public Class GeneralShapePair

extends ShapePair
Class Inheritance
Known Direct Subclasses
com.sun.prism.BasicStroke.CAGShapePair
Imports
com.sun.javafx.geom.transform.BaseTransform
A concrete implementation of ShapePair for general shapes and combination types. This class can represent the combination and perform basic operations like bounds, intersects and contains, but it cannot supply a PathIterator for the result of the combination. As a result the renderer will either have to be able to render the combination of two shapes directly or perform some other geometry computation of its own to achieve the subtraction or intersection.

Field Summary

Modifier and TypeField and Description
private final int
combinationType

private final Shape
inner

private final Shape
outer

Inherited from com.sun.javafx.geom.ShapePair:
INCLUDES_I_NOT_OINCLUDES_NEITHERINCLUDES_O_AND_IINCLUDES_O_NOT_ITYPE_INTERSECTTYPE_SUBTRACT

Constructor Summary

AccessConstructor and Description
public
GeneralShapePair(Shape outer, Shape inner, int combinationType)

Method Summary

Modifier and TypeMethod and Description
public boolean
contains(float x, float y)

Implements abstract com.sun.javafx.geom.Shape.contains.

Tests if the specified coordinates are inside the boundary of the Shape.

public boolean
contains(float x, float y, float w, float h)

Implements abstract com.sun.javafx.geom.Shape.contains.

Tests if the interior of the Shape entirely contains the specified rectangular area.

public Shape
copy()

Implements abstract com.sun.javafx.geom.Shape.copy.

Returns a new copy of this Shape instance.

public RectBounds
getBounds()

Implements abstract com.sun.javafx.geom.Shape.getBounds.

Note that there is no guarantee that the returned RectBounds is the smallest bounding box that encloses the Shape, only that the Shape lies entirely within the indicated RectBounds.

public final int
getCombinationType()

Implements abstract com.sun.javafx.geom.ShapePair.getCombinationType.

Returns the method with which to combine the two shapes.

public final Shape
getInnerShape()

Implements abstract com.sun.javafx.geom.ShapePair.getInnerShape.

Returns the inner Shape.

public final Shape
getOuterShape()

Implements abstract com.sun.javafx.geom.ShapePair.getOuterShape.

Returns the outer Shape.

public PathIterator
getPathIterator(BaseTransform tx)

Implements abstract com.sun.javafx.geom.Shape.getPathIterator.

Returns an iterator object that iterates along the Shape boundary and provides access to the geometry of the Shape outline.

public PathIterator
getPathIterator(BaseTransform tx, float flatness)

Implements abstract com.sun.javafx.geom.Shape.getPathIterator.

Returns an iterator object that iterates along the Shape boundary and provides access to a flattened view of the Shape outline geometry.

public boolean
intersects(float x, float y, float w, float h)

Implements abstract com.sun.javafx.geom.Shape.intersects.

Tests if the interior of the Shape intersects the interior of a specified rectangular area.

Field Detail

combinationTypeback to summary
private final int combinationType
innerback to summary
private final Shape inner
outerback to summary
private final Shape outer

Constructor Detail

GeneralShapePairback to summary
public GeneralShapePair(Shape outer, Shape inner, int combinationType)

Method Detail

containsback to summary
public boolean contains(float x, float y)

Implements abstract com.sun.javafx.geom.Shape.contains.

Doc from com.sun.javafx.geom.Shape.contains.

Tests if the specified coordinates are inside the boundary of the Shape.

Annotations
@Override
containsback to summary
public boolean contains(float x, float y, float w, float h)

Implements abstract com.sun.javafx.geom.Shape.contains.

Doc from com.sun.javafx.geom.Shape.contains.

Tests if the interior of the Shape entirely contains the specified rectangular area. All coordinates that lie inside the rectangular area must lie within the Shape for the entire rectanglar area to be considered contained within the Shape.

The Shape.contains() method allows a Shape implementation to conservatively return false when:

  • the intersect method returns true and
  • the calculations to determine whether or not the Shape entirely contains the rectangular area are prohibitively expensive.
This means that for some Shapes this method might return false even though the Shape contains the rectangular area. The Area class performs more accurate geometric computations than most Shape objects and therefore can be used if a more precise answer is required.
Annotations
@Override
copyback to summary
public Shape copy()

Implements abstract com.sun.javafx.geom.Shape.copy.

Doc from com.sun.javafx.geom.Shape.copy.

Returns a new copy of this Shape instance.

Annotations
@Override
getBoundsback to summary
public RectBounds getBounds()

Implements abstract com.sun.javafx.geom.Shape.getBounds.

Doc from com.sun.javafx.geom.Shape.getBounds.

Note that there is no guarantee that the returned RectBounds is the smallest bounding box that encloses the Shape, only that the Shape lies entirely within the indicated RectBounds.

Annotations
@Override
getCombinationTypeback to summary
public final int getCombinationType()

Implements abstract com.sun.javafx.geom.ShapePair.getCombinationType.

Doc from com.sun.javafx.geom.ShapePair.getCombinationType.

Returns the method with which to combine the two shapes. For now, only TYPE_SUBTRACT and TYPE_INTERSECT are supported.

Annotations
@Override
getInnerShapeback to summary
public final Shape getInnerShape()

Implements abstract com.sun.javafx.geom.ShapePair.getInnerShape.

Doc from com.sun.javafx.geom.ShapePair.getInnerShape.

Returns the inner Shape.

Annotations
@Override
getOuterShapeback to summary
public final Shape getOuterShape()

Implements abstract com.sun.javafx.geom.ShapePair.getOuterShape.

Doc from com.sun.javafx.geom.ShapePair.getOuterShape.

Returns the outer Shape.

Annotations
@Override
getPathIteratorback to summary
public PathIterator getPathIterator(BaseTransform tx)

Implements abstract com.sun.javafx.geom.Shape.getPathIterator.

Doc from com.sun.javafx.geom.Shape.getPathIterator.

Returns an iterator object that iterates along the Shape boundary and provides access to the geometry of the Shape outline. If an optional BaseTransform is specified, the coordinates returned in the iteration are transformed accordingly.

Each call to this method returns a fresh PathIterator object that traverses the geometry of the Shape object independently from any other PathIterator objects in use at the same time.

It is recommended, but not guaranteed, that objects implementing the Shape interface isolate iterations that are in process from any changes that might occur to the original object's geometry during such iterations.

Annotations
@Override
getPathIteratorback to summary
public PathIterator getPathIterator(BaseTransform tx, float flatness)

Implements abstract com.sun.javafx.geom.Shape.getPathIterator.

Doc from com.sun.javafx.geom.Shape.getPathIterator.

Returns an iterator object that iterates along the Shape boundary and provides access to a flattened view of the Shape outline geometry.

Only SEG_MOVETO, SEG_LINETO, and SEG_CLOSE point types are returned by the iterator.

If an optional BaseTransform is specified, the coordinates returned in the iteration are transformed accordingly.

The amount of subdivision of the curved segments is controlled by the flatness parameter, which specifies the maximum distance that any point on the unflattened transformed curve can deviate from the returned flattened path segments. Note that a limit on the accuracy of the flattened path might be silently imposed, causing very small flattening parameters to be treated as larger values. This limit, if there is one, is defined by the particular implementation that is used.

Each call to this method returns a fresh PathIterator object that traverses the Shape object geometry independently from any other PathIterator objects in use at the same time.

It is recommended, but not guaranteed, that objects implementing the Shape interface isolate iterations that are in process from any changes that might occur to the original object's geometry during such iterations.

Annotations
@Override
intersectsback to summary
public boolean intersects(float x, float y, float w, float h)

Implements abstract com.sun.javafx.geom.Shape.intersects.

Doc from com.sun.javafx.geom.Shape.intersects.

Tests if the interior of the Shape intersects the interior of a specified rectangular area. The rectangular area is considered to intersect the Shape if any point is contained in both the interior of the Shape and the specified rectangular area.

The Shape.intersects() method allows a Shape implementation to conservatively return true when:

  • there is a high probability that the rectangular area and the Shape intersect, but
  • the calculations to accurately determine this intersection are prohibitively expensive.
This means that for some Shapes this method might return true even though the rectangular area does not intersect the Shape. The Area class performs more accurate computations of geometric intersection than most Shape objects and therefore can be used if a more precise answer is required.
Annotations
@Override