JavaFX 24 · com.sun.javafx.geom.Area · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private RectBounds	cachedBounds
private Vector<E>	curves
private static final Vector<E>	EmptyCurves

Access	Constructor and Description
public	Area() Default constructor which creates an empty area.
public	Area(Shape the `Shape` from which the area is constructed s) The `Area` class creates an area geometry from the specified `Shape` object.
public	Area(PathIterator iter)

Method Summary

Modifier and Type	Method and Description
public void	add(Area the `Area` to be added to the current shape rhs) Adds the shape of the specified `Area` to the shape of this `Area`.
public boolean	contains(float the specified X coordinate to be tested x, float the specified Y coordinate to be tested y) Implements abstract com.sun.javafx.geom.Shape.contains. Tests if the specified coordinates are inside the boundary of the `Shape`.
public boolean	contains(Point2D the specified `Point2D` to be tested p) Overrides com.sun.javafx.geom.Shape.contains. Tests if a specified `Point2D` is inside the boundary of the `Shape`.
public boolean	contains(float the X coordinate of the upper-left corner of the specified rectangular area x, float the Y coordinate of the upper-left corner of the specified rectangular area y, float the width of the specified rectangular area w, float the height of the specified rectangular area h) Implements abstract com.sun.javafx.geom.Shape.contains. Tests if the interior of the `Shape` entirely contains the specified rectangular area.
public Area	copy() Implements abstract com.sun.javafx.geom.Shape.copy. Returns a new copy of this `Shape` instance.
public Area	Returns: a new `Area` object representing the transformed geometry. createTransformedArea(BaseTransform the specified `BaseTransform` used to transform the new `Area` tx) Creates a new `Area` object that contains the same geometry as this `Area` transformed by the specified `BaseTransform`.
public void	exclusiveOr(Area the `Area` to be exclusive ORed with this `Area`. rhs) Sets the shape of this `Area` to be the combined area of its current shape and the shape of the specified `Area`, minus their intersection.
public RectBounds	Returns: the bounding `RectBounds` for the `Area`. getBounds() Implements abstract com.sun.javafx.geom.Shape.getBounds. Returns a high precision bounding `RectBounds` that completely encloses this `Area`.
private RectBounds	getCachedBounds()
public PathIterator	Returns: the `PathIterator` object that returns the geometry of the outline of this `Area`, one segment at a time. getPathIterator(BaseTransform an optional `BaseTransform` to be applied to the coordinates as they are returned in the iteration, or `null` if untransformed coordinates are desired tx) Implements abstract com.sun.javafx.geom.Shape.getPathIterator. Creates a `PathIterator` for the outline of this `Area` object.
public PathIterator	Returns: the `PathIterator` object that returns the geometry of the outline of this `Area`, one segment at a time. getPathIterator(BaseTransform an optional `BaseTransform` to be applied to the coordinates as they are returned in the iteration, or `null` if untransformed coordinates are desired tx, float the maximum amount that the control points for a given curve can vary from colinear before a subdivided curve is replaced by a straight line connecting the end points flatness) Implements abstract com.sun.javafx.geom.Shape.getPathIterator. Creates a `PathIterator` for the flattened outline of this `Area` object.
public void	intersect(Area the `Area` to be intersected with this `Area` rhs) Sets the shape of this `Area` to the intersection of its current shape and the shape of the specified `Area`.
public boolean	intersects(float the X coordinate of the upper-left corner of the specified rectangular area x, float the Y coordinate of the upper-left corner of the specified rectangular area y, float the width of the specified rectangular area w, float the height of the specified rectangular area h) Implements abstract com.sun.javafx.geom.Shape.intersects. Tests if the interior of the `Shape` intersects the interior of a specified rectangular area.
private void	invalidateBounds()
public boolean	Returns: `true` if this `Area` object represents an empty area; `false` otherwise. isEmpty() Tests whether this `Area` object encloses any area.
public boolean	Returns: `true` if the two geometries are equivalent; `false` otherwise. isEquivalent(Area the `Area` to be compared to this `Area` other) Tests whether the geometries of the two `Area` objects cover the same area.
public boolean	Returns: `true` if the geometry of this `Area` consists entirely of line segments; `false` otherwise. isPolygonal() Tests whether this `Area` consists entirely of straight edged polygonal geometry.
public boolean	Returns: `true` if the geometry of this `Area` is rectangular in shape; `false` otherwise. isRectangular() Tests whether this `Area` is rectangular in shape.
public boolean	Returns: `true` if the `Area` is comprised of a single basic geometry; `false` otherwise. isSingular() Tests whether this `Area` is comprised of a single closed subpath.
private static Vector<E>	pathToCurves(PathIterator pi)
public void	reset() Removes all of the geometry from this `Area` and restores it to an empty area.
public void	subtract(Area the `Area` to be subtracted from the current shape rhs) Subtracts the shape of the specified `Area` from the shape of this `Area`.
public void	transform(BaseTransform the transformation used to transform the area tx) Transforms the geometry of this `Area` using the specified `BaseTransform`.

Inherited from com.sun.javafx.geom.Shape:: accumulate accumulateCubic accumulateCubic accumulateQuad contains intersects intersectsLine outcode pointCrossingsForCubic pointCrossingsForLine pointCrossingsForPath pointCrossingsForQuad rectCrossingsForCubic rectCrossingsForLine rectCrossingsForPath rectCrossingsForQuad

cachedBounds	back to summary
private RectBounds cachedBounds

curves	back to summary
private Vector<E> curves

EmptyCurves	back to summary
private static final Vector<E> EmptyCurves

Area	back to summary
public Area() Default constructor which creates an empty area.

Area	back to summary
public Area(Shape s) The `Area` class creates an area geometry from the specified `Shape` object. The geometry is explicitly closed, if the `Shape` is not already closed. The fill rule (even-odd or winding) specified by the geometry of the `Shape` is used to determine the resulting enclosed area. Parameters s:Shape the `Shape` from which the area is constructed Exceptions NullPointerException: if `s` is null

Area	back to summary
public Area(PathIterator iter)

Method Detail

add back to summary

add	back to summary
public void add(Area rhs) Adds the shape of the specified `Area` to the shape of this `Area`. The resulting shape of this `Area` will include the union of both shapes, or all areas that were contained in either this or the specified `Area`. // Example: Area a1 = new Area([triangle 0,0 => 8,0 => 0,8]); Area a2 = new Area([triangle 0,0 => 8,0 => 8,8]); a1.add(a2); a1(before) + a2 = a1(after) ################ ################ ################ ############## ############## ################ ############ ############ ################ ########## ########## ################ ######## ######## ################ ###### ###### ###### ###### #### #### #### #### ## ## ## ## Parameters rhs:Area the `Area` to be added to the current shape Exceptions NullPointerException: if `rhs` is null

public void add(Area rhs)

Adds the shape of the specified Area to the shape of this Area. The resulting shape of this Area will include the union of both shapes, or all areas that were contained in either this or the specified Area.

    // Example:
    Area a1 = new Area([triangle 0,0 => 8,0 => 0,8]);
    Area a2 = new Area([triangle 0,0 => 8,0 => 8,8]);
    a1.add(a2);

       a1(before)     +         a2         =     a1(after)

    ################     ################     ################
    ##############         ##############     ################
    ############             ############     ################
    ##########                 ##########     ################
    ########                     ########     ################
    ######                         ######     ######    ######
    ####                             ####     ####        ####
    ##                                 ##     ##            ##

Parameters

rhs:Area: the Area to be added to the current shape

Exceptions

NullPointerException:: if rhs is null

contains back to summary

contains	back 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`. Parameters x:float the specified X coordinate to be tested y:float the specified Y coordinate to be tested Returns:boolean `true` if the specified coordinates are inside the `Shape` boundary; `false` otherwise. Annotations @Override

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.

Parameters

x:float: the specified X coordinate to be tested
y:float: the specified Y coordinate to be tested

Returns:boolean

true if the specified coordinates are inside the Shape boundary; false otherwise.

Annotations

@Override

contains back to summary

contains	back to summary
public boolean contains(Point2D p) Overrides com.sun.javafx.geom.Shape.contains. Doc from com.sun.javafx.geom.Shape.contains. Tests if a specified `Point2D` is inside the boundary of the `Shape`. Parameters p:Point2D the specified `Point2D` to be tested Returns:boolean `true` if the specified `Point2D` is inside the boundary of the `Shape`; `false` otherwise. Annotations @Override

public boolean contains(Point2D p)

Overrides com.sun.javafx.geom.Shape.contains.

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

Tests if a specified Point2D is inside the boundary of the Shape.

Parameters

p:Point2D: the specified Point2D to be tested

Returns:boolean

true if the specified Point2D is inside the boundary of the Shape; false otherwise.

Annotations

@Override

contains back to summary

contains	back 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. Parameters x:float the X coordinate of the upper-left corner of the specified rectangular area y:float the Y coordinate of the upper-left corner of the specified rectangular area w:float the width of the specified rectangular area h:float the height of the specified rectangular area Returns:boolean `true` if the interior of the `Shape` entirely contains the specified rectangular area; `false` otherwise or, if the `Shape` contains the rectangular area and the `intersects` method returns `true` and the containment calculations would be too expensive to perform. Annotations @Override

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.

Parameters

x:float: the X coordinate of the upper-left corner of the specified rectangular area
y:float: the Y coordinate of the upper-left corner of the specified rectangular area
w:float: the width of the specified rectangular area
h:float: the height of the specified rectangular area

Returns:boolean

true if the interior of the Shape entirely contains the specified rectangular area; false otherwise or, if the Shape contains the rectangular area and the intersects method returns true and the containment calculations would be too expensive to perform.

Annotations

@Override

copy back to summary

copy	back to summary
public Area 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. Returns:Area a copy of this shape Annotations @Override

public Area 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.

Returns:Area

a copy of this shape

Annotations

@Override

createTransformedArea back to summary

createTransformedArea	back to summary
public Area createTransformedArea(BaseTransform tx) Creates a new `Area` object that contains the same geometry as this `Area` transformed by the specified `BaseTransform`. This `Area` object is unchanged. Parameters tx:BaseTransform the specified `BaseTransform` used to transform the new `Area` Returns:Area a new `Area` object representing the transformed geometry. Exceptions NullPointerException: if `t` is null

public Area createTransformedArea(BaseTransform tx)

Creates a new Area object that contains the same geometry as this Area transformed by the specified BaseTransform. This Area object is unchanged.

Parameters

tx:BaseTransform: the specified BaseTransform used to transform the new Area

Returns:Area

a new Area object representing the transformed geometry.

Exceptions

NullPointerException:: if t is null

exclusiveOr back to summary

exclusiveOr	back to summary
public void exclusiveOr(Area rhs) Sets the shape of this `Area` to be the combined area of its current shape and the shape of the specified `Area`, minus their intersection. The resulting shape of this `Area` will include only areas that were contained in either this `Area` or in the specified `Area`, but not in both. // Example: Area a1 = new Area([triangle 0,0 => 8,0 => 0,8]); Area a2 = new Area([triangle 0,0 => 8,0 => 8,8]); a1.exclusiveOr(a2); a1(before) xor a2 = a1(after) ################ ################ ############## ############## ## ## ############ ############ #### #### ########## ########## ###### ###### ######## ######## ################ ###### ###### ###### ###### #### #### #### #### ## ## ## ## Parameters rhs:Area the `Area` to be exclusive ORed with this `Area`. Exceptions NullPointerException: if `rhs` is null

public void exclusiveOr(Area rhs)

Sets the shape of this Area to be the combined area of its current shape and the shape of the specified Area, minus their intersection. The resulting shape of this Area will include only areas that were contained in either this Area or in the specified Area, but not in both.

    // Example:
    Area a1 = new Area([triangle 0,0 => 8,0 => 0,8]);
    Area a2 = new Area([triangle 0,0 => 8,0 => 8,8]);
    a1.exclusiveOr(a2);

       a1(before)    xor        a2         =     a1(after)

    ################     ################
    ##############         ##############     ##            ##
    ############             ############     ####        ####
    ##########                 ##########     ######    ######
    ########                     ########     ################
    ######                         ######     ######    ######
    ####                             ####     ####        ####
    ##                                 ##     ##            ##

Parameters

rhs:Area: the Area to be exclusive ORed with this Area.

Exceptions

NullPointerException:: if rhs is null

getBounds back to summary

getBounds	back to summary
public RectBounds getBounds() Implements abstract com.sun.javafx.geom.Shape.getBounds. Returns a high precision bounding `RectBounds` that completely encloses this `Area`. The Area class will attempt to return the tightest bounding box possible for the Shape. The bounding box will not be padded to include the control points of curves in the outline of the Shape, but should tightly fit the actual geometry of the outline itself. Returns:RectBounds the bounding `RectBounds` for the `Area`. Annotations @Override

public RectBounds getBounds()

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

Returns a high precision bounding RectBounds that completely encloses this Area.

The Area class will attempt to return the tightest bounding box possible for the Shape. The bounding box will not be padded to include the control points of curves in the outline of the Shape, but should tightly fit the actual geometry of the outline itself.

Returns:RectBounds

the bounding RectBounds for the Area.

Annotations

@Override

getCachedBounds	back to summary
private RectBounds getCachedBounds()

getPathIterator back to summary

getPathIterator	back to summary
public PathIterator getPathIterator(BaseTransform tx) Implements abstract com.sun.javafx.geom.Shape.getPathIterator. Creates a `PathIterator` for the outline of this `Area` object. This `Area` object is unchanged. Parameters tx:BaseTransform an optional `BaseTransform` to be applied to the coordinates as they are returned in the iteration, or `null` if untransformed coordinates are desired Returns:PathIterator the `PathIterator` object that returns the geometry of the outline of this `Area`, one segment at a time. Annotations @Override

public PathIterator getPathIterator(BaseTransform tx)

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

Creates a PathIterator for the outline of this Area object. This Area object is unchanged.

Parameters

tx:BaseTransform: an optional BaseTransform to be applied to the coordinates as they are returned in the iteration, or null if untransformed coordinates are desired

Returns:PathIterator

the PathIterator object that returns the geometry of the outline of this Area, one segment at a time.

Annotations

@Override

getPathIterator back to summary

getPathIterator	back to summary
public PathIterator getPathIterator(BaseTransform tx, float flatness) Implements abstract com.sun.javafx.geom.Shape.getPathIterator. Creates a `PathIterator` for the flattened outline of this `Area` object. Only uncurved path segments represented by the SEG_MOVETO, SEG_LINETO, and SEG_CLOSE point types are returned by the iterator. This `Area` object is unchanged. Parameters tx:BaseTransform an optional `BaseTransform` to be applied to the coordinates as they are returned in the iteration, or `null` if untransformed coordinates are desired flatness:float the maximum amount that the control points for a given curve can vary from colinear before a subdivided curve is replaced by a straight line connecting the end points Returns:PathIterator the `PathIterator` object that returns the geometry of the outline of this `Area`, one segment at a time. Annotations @Override

public PathIterator getPathIterator(BaseTransform tx, float flatness)

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

Creates a PathIterator for the flattened outline of this Area object. Only uncurved path segments represented by the SEG_MOVETO, SEG_LINETO, and SEG_CLOSE point types are returned by the iterator. This Area object is unchanged.

Parameters

tx:BaseTransform: an optional BaseTransform to be applied to the coordinates as they are returned in the iteration, or null if untransformed coordinates are desired
flatness:float: the maximum amount that the control points for a given curve can vary from colinear before a subdivided curve is replaced by a straight line connecting the end points

Returns:PathIterator

the PathIterator object that returns the geometry of the outline of this Area, one segment at a time.

Annotations

@Override

intersect back to summary

intersect	back to summary
public void intersect(Area rhs) Sets the shape of this `Area` to the intersection of its current shape and the shape of the specified `Area`. The resulting shape of this `Area` will include only areas that were contained in both this `Area` and also in the specified `Area`. // Example: Area a1 = new Area([triangle 0,0 => 8,0 => 0,8]); Area a2 = new Area([triangle 0,0 => 8,0 => 8,8]); a1.intersect(a2); a1(before) intersect a2 = a1(after) ################ ################ ################ ############## ############## ############ ############ ############ ######## ########## ########## #### ######## ######## ###### ###### #### #### ## ## Parameters rhs:Area the `Area` to be intersected with this `Area` Exceptions NullPointerException: if `rhs` is null

public void intersect(Area rhs)

Sets the shape of this Area to the intersection of its current shape and the shape of the specified Area. The resulting shape of this Area will include only areas that were contained in both this Area and also in the specified Area.

    // Example:
    Area a1 = new Area([triangle 0,0 => 8,0 => 0,8]);
    Area a2 = new Area([triangle 0,0 => 8,0 => 8,8]);
    a1.intersect(a2);

     a1(before)   intersect     a2         =     a1(after)

    ################     ################     ################
    ##############         ##############       ############
    ############             ############         ########
    ##########                 ##########           ####
    ########                     ########
    ######                         ######
    ####                             ####
    ##                                 ##

Parameters

rhs:Area: the Area to be intersected with this Area

Exceptions

NullPointerException:: if rhs is null

intersects back to summary

intersects	back 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. Parameters x:float the X coordinate of the upper-left corner of the specified rectangular area y:float the Y coordinate of the upper-left corner of the specified rectangular area w:float the width of the specified rectangular area h:float the height of the specified rectangular area Returns:boolean `true` if the interior of the `Shape` and the interior of the rectangular area intersect, or are both highly likely to intersect and intersection calculations would be too expensive to perform; `false` otherwise. Annotations @Override

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.

Parameters

x:float: the X coordinate of the upper-left corner of the specified rectangular area
y:float: the Y coordinate of the upper-left corner of the specified rectangular area
w:float: the width of the specified rectangular area
h:float: the height of the specified rectangular area

Returns:boolean

true if the interior of the Shape and the interior of the rectangular area intersect, or are both highly likely to intersect and intersection calculations would be too expensive to perform; false otherwise.

Annotations

@Override

invalidateBounds	back to summary
private void invalidateBounds()

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Tests whether this `Area` object encloses any area. Returns:boolean `true` if this `Area` object represents an empty area; `false` otherwise.

public boolean isEmpty()

Tests whether this Area object encloses any area.

Returns:boolean: true if this Area object represents an empty area; false otherwise.

isEquivalent back to summary

isEquivalent	back to summary
public boolean isEquivalent(Area other) Tests whether the geometries of the two `Area` objects cover the same area. This method will return false if the argument is null. Parameters other:Area the `Area` to be compared to this `Area` Returns:boolean `true` if the two geometries are equivalent; `false` otherwise.

public boolean isEquivalent(Area other)

Tests whether the geometries of the two Area objects cover the same area. This method will return false if the argument is null.

Parameters

other:Area: the Area to be compared to this Area

Returns:boolean

true if the two geometries are equivalent; false otherwise.

isPolygonal back to summary

isPolygonal	back to summary
public boolean isPolygonal() Tests whether this `Area` consists entirely of straight edged polygonal geometry. Returns:boolean `true` if the geometry of this `Area` consists entirely of line segments; `false` otherwise.

public boolean isPolygonal()

Tests whether this Area consists entirely of straight edged polygonal geometry.

Returns:boolean: true if the geometry of this Area consists entirely of line segments; false otherwise.

isRectangular back to summary

isRectangular	back to summary
public boolean isRectangular() Tests whether this `Area` is rectangular in shape. Returns:boolean `true` if the geometry of this `Area` is rectangular in shape; `false` otherwise.

public boolean isRectangular()

Tests whether this Area is rectangular in shape.

Returns:boolean: true if the geometry of this Area is rectangular in shape; false otherwise.

isSingular back to summary

isSingular	back to summary
public boolean isSingular() Tests whether this `Area` is comprised of a single closed subpath. This method returns `true` if the path contains 0 or 1 subpaths, or `false` if the path contains more than 1 subpath. The subpaths are counted by the number of `SEG_MOVETO` segments that appear in the path. Returns:boolean `true` if the `Area` is comprised of a single basic geometry; `false` otherwise.

public boolean isSingular()

Tests whether this Area is comprised of a single closed subpath. This method returns true if the path contains 0 or 1 subpaths, or false if the path contains more than 1 subpath. The subpaths are counted by the number of SEG_MOVETO segments that appear in the path.

Returns:boolean: true if the Area is comprised of a single basic geometry; false otherwise.

pathToCurves	back to summary
private static Vector<E> pathToCurves(PathIterator pi)

reset	back to summary
public void reset() Removes all of the geometry from this `Area` and restores it to an empty area.

subtract back to summary

subtract	back to summary
public void subtract(Area rhs) Subtracts the shape of the specified `Area` from the shape of this `Area`. The resulting shape of this `Area` will include areas that were contained only in this `Area` and not in the specified `Area`. // Example: Area a1 = new Area([triangle 0,0 => 8,0 => 0,8]); Area a2 = new Area([triangle 0,0 => 8,0 => 8,8]); a1.subtract(a2); a1(before) - a2 = a1(after) ################ ################ ############## ############## ## ############ ############ #### ########## ########## ###### ######## ######## ######## ###### ###### ###### #### #### #### ## ## ## Parameters rhs:Area the `Area` to be subtracted from the current shape Exceptions NullPointerException: if `rhs` is null

public void subtract(Area rhs)

Subtracts the shape of the specified Area from the shape of this Area. The resulting shape of this Area will include areas that were contained only in this Area and not in the specified Area.

    // Example:
    Area a1 = new Area([triangle 0,0 => 8,0 => 0,8]);
    Area a2 = new Area([triangle 0,0 => 8,0 => 8,8]);
    a1.subtract(a2);

       a1(before)     -         a2         =     a1(after)

    ################     ################
    ##############         ##############     ##
    ############             ############     ####
    ##########                 ##########     ######
    ########                     ########     ########
    ######                         ######     ######
    ####                             ####     ####
    ##                                 ##     ##

Parameters

rhs:Area: the Area to be subtracted from the current shape

Exceptions

NullPointerException:: if rhs is null

transform back to summary

transform	back to summary
public void transform(BaseTransform tx) Transforms the geometry of this `Area` using the specified `BaseTransform`. The geometry is transformed in place, which permanently changes the enclosed area defined by this object. Parameters tx:BaseTransform the transformation used to transform the area Exceptions NullPointerException: if `t` is null

public void transform(BaseTransform tx)

Transforms the geometry of this Area using the specified BaseTransform. The geometry is transformed in place, which permanently changes the enclosed area defined by this object.

Parameters

tx:BaseTransform: the transformation used to transform the area

Exceptions

NullPointerException:: if t is null

public Class Area

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail