Bounds (Groovy Documentation)

geoscript.geom.Bounds

class Bounds
extends java.lang.Object

A Bounds is an Envelope with a Projection.

 Bounds b = new Bounds(1,2,3,4, new Projection("EPSG:2927"))

Authors:: Jared Erickson

Properties Summary

Properties
Type	Name and description
`ReferencedEnvelope`	`env` The GeoTools' wrapped ReferencedEnvelope
`Projection`	`proj`

Constructor Summary

Constructors
Constructor and description
`Bounds (ReferencedEnvelope env)` Create a new Bounds wrapping a ReferencedEnvelope.
`Bounds (Envelope env)` Create a new Bounds wrapping an Envelope.
`Bounds (double minX, double minY, double maxX, double maxY)` Create a new Bounds with minX, minY, maxX, and maxY coordinates.
`Bounds (double minX, double minY, double maxX, double maxY, java.lang.Object proj)` Create a new Bounds with minX, minY, maxX, and maxY coordinates and a Projection.
`Bounds (Point point, double width, double height, boolean isOrigin)` Create a new Bounds from a Point (which can either be the origin/lower left or center) and a width and height

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.Object`	`asType(java.lang.Class type)` Override the asType method to convert Bounds to Geometry if the Class is Geometry
	`boolean`	`contains(Bounds other)` Determine whether this Bounds contains the other Bounds
	`boolean`	`contains(Point point)` Determine whether this Bounds contains the Point
	`LineString`	`createArc(double startAngle, double angleExtent, int numPoints, double rotation)` Create a LineString arc based on this Bound's extent from the start angle (in radians) for the given angle extent (also in radians) with the given number of points and rotation.
	`Polygon`	`createArcPolygon(double startAngle, double angleExtent, int numPoints, double rotation)` Create a Polygon arc based on this Bound's extent from the start angle (in radians) for the given angle extent (also in radians) with the given number of points and rotation.
	`Polygon`	`createEllipse(int numPoints, double rotation)` Create an ellipse or circle based on this Bound's extent with the given number of points and rotation.
	`Polygon`	`createHexagon(boolean inverted)` Create a hexagon based on this Bound's extent
	`Polygon`	`createRectangle(int numPoints, double rotation)` Create a rectangle or square based on this Bound's extent with the given number of points and rotation.
	`Polygon`	`createSineStar(int numberOfArms, double armLengthRatio, int numPoints, double rotation)` Create a sine star based on this Bound's extent with the given number of arms and arm length ratio with the given number of points and rotation.
	`Polygon`	`createSquircle(int numPoints, double rotation)` Create a squircle based on this Bound's extent with the given number of points and rotation.
	`Polygon`	`createSuperCircle(double power, int numPoints, double rotation)` Create a super circle based on this Bound's extent with the given number of points and rotation.
	`MultiPolygon`	`createTriangles()` Create triangles to fill the Bounds
	`Bounds`	`ensureWidthAndHeight()` Ensure that the Bounds has a width and height.
	`boolean`	`equals(java.lang.Object other)` Determine whether this Bounds equals another Bounds
	`Bounds`	`expand(Bounds other)` Expand this Bounds to include another Bounds
	`Bounds`	`expandBy(double distance)` Expand the Bounds by the given distance in all directions
	`Bounds`	`fixAspectRatio(int w, int h)` Fix the aspect ration of this Bounds based on the given width and height.
	`static Bounds`	`fromString(java.lang.String str)` Create a Bounds from a String or return null
	`void`	`generateGrid(int columns, int rows, java.lang.String type, groovy.lang.Closure c)` Generate a grid with the given number or rows and columns
	`void`	`generateGrid(double cellWidth, double cellHeight, java.lang.String type, groovy.lang.Closure c)` Generate a grid with the given cell width and height
	`double`	`getArea()` Get the area of this Bounds
	`double`	`getAspect()` Get the ratio of width to height for this bounds.
	`java.lang.Object`	`getAt(int index)` Get a value from this Bounds at the given index (minX = 0, minY = 1, maxX = 2, maxY = 3).
	`java.util.List`	`getCorners()` Get the corners of the Bounds as a List of Points.
	`Geometry`	`getGeometry()` Convert this Bounds into a Geometry object
	`Geometry`	`getGrid(int columns, int rows, java.lang.String type)` Get a generated grid with the given number of the rows and column
	`Geometry`	`getGrid(double cellWidth, double cellHeight, java.lang.String type)` Get a generated grid with the given cell width and height
	`double`	`getHeight()` Get the height
	`double`	`getMaxX()` Get the right/east most coordinate (maxX)
	`double`	`getMaxY()` Get the top/north most coordinate (maxY)
	`double`	`getMinX()` Get the left/west most coordinate (minX)
	`double`	`getMinY()` Get the bottom/south most coordinate (minY)
	`Polygon`	`getPolygon()` Convert this Bounds into a Polygon
	`Projection`	`getProj()` Get the Projection (if any) or null
	`double`	`getWidth()` Get the width
	`int`	`hashCode()` Get the hash code for this Bounds
	`Bounds`	`intersection(Bounds other)` Calculate the intersection between this Bounds and the other Bounds
	`boolean`	`intersects(Bounds other)` Determine whether this Bounds intersects with the other Bounds
	`boolean`	`isEmpty()` Get whether the Bounds is empty (width and height are zero)
	`void`	`quadTree(int start, int stop, groovy.lang.Closure closure)` Calculate a quad tree for this Bounds between the start and stop levels.
	`Bounds`	`reproject(java.lang.Object proj)` Reprojects the Bounds
	`Bounds`	`scale(double factor)` Scales the current Bounds by a specific factor.
	`void`	`setProj(java.lang.Object projection)` Set a Projection if the current Projection is not set or reproject if needed
	`java.util.List<Bounds>`	`tile(double res)` Partitions the bounding box into a set of smaller bounding boxes.
	`java.lang.String`	`toString()` The string representation

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - ReferencedEnvelope env
    
    The GeoTools' wrapped ReferencedEnvelope
  - Projection proj
- Constructor Detail
  - Bounds(ReferencedEnvelope env)
    
    Create a new Bounds wrapping a ReferencedEnvelope.
    ReferencedEnvelope e = new ReferencedEnvelope(1,3,2,4,null)
    
    Bounds b = new Bounds(e)
    
    Parameters:
    env - The ReferencedEnvelope
  - Bounds(Envelope env)
    
    Create a new Bounds wrapping an Envelope.
    Envelope e = new Envelope(1,3,2,4)
    
    Bounds b = new Bounds(e)
    
    Parameters:
    env - The ReferencedEnvelope
  - Bounds(double minX, double minY, double maxX, double maxY)
    
    Create a new Bounds with minX, minY, maxX, and maxY coordinates.
    Bounds b = new Bounds(1,2,3,4)
    
    Parameters:
    minX - The left/west most coordinate (minX)
    minY - the bottom/south most coordinate (minY)
    maxX - The right/east most coordinate (maxX)
    maxY - The top/north most coordinate (maxY)
  - Bounds(double minX, double minY, double maxX, double maxY, java.lang.Object proj)
    
    Create a new Bounds with minX, minY, maxX, and maxY coordinates and a Projection.
    Bounds b = new Bounds(1,2,3,4, new Projection("EPSG:2927"))
    
    Bounds b = new Bounds(1,2,3,4, "EPSG:2927")
    
    Parameters:
    minX - The left/minX most coordinate (minX)
    minY - the bottom/minY most coordinate (minY)
    maxX - The right/maxX most coordinate (maxX)
    maxY - The top/maxY most coordinate (maxY)
    proj - The Projection can either be a Projection or a String
  - Bounds(Point point, double width, double height, boolean isOrigin)
    
    Create a new Bounds from a Point (which can either be the origin/lower left or center) and a width and height
    Parameters:
    point - The Point origin or center
    width - The width
    height - The height
    isOrigin - Whether the Point is the origin (true) or the center (false)
- Method Detail
  - java.lang.Object asType(java.lang.Class type)
    
    Override the asType method to convert Bounds to Geometry if the Class is Geometry
    Parameters:
    type - The Class
    Returns:
    The converted Object
  - boolean contains(Bounds other)
    
    Determine whether this Bounds contains the other Bounds
    Parameters:
    other - The other Bounds
    Returns:
    Whether this Bounds contains the other Bounds
  - boolean contains(Point point)
    
    Determine whether this Bounds contains the Point
    Parameters:
    point - The Point
    Returns:
    Whether this Bounds contains the Point
  - LineString createArc(double startAngle, double angleExtent, int numPoints, double rotation)
    
    Create a LineString arc based on this Bound's extent from the start angle (in radians) for the given angle extent (also in radians) with the given number of points and rotation.
    Parameters:
    startAngle - The start angle (in radians)
    angleExtent - The extent of the angle (in radians)
    numPoints - The number of points
    rotation - The rotation angle
    Returns:
    The LineString arc
  - Polygon createArcPolygon(double startAngle, double angleExtent, int numPoints, double rotation)
    
    Create a Polygon arc based on this Bound's extent from the start angle (in radians) for the given angle extent (also in radians) with the given number of points and rotation.
    Parameters:
    startAngle - The start angle (in radians)
    angleExtent - The extent of the angle (in radians)
    numPoints - The number of points
    rotation - The rotation angle
    Returns:
    The Polygon arc
  - Polygon createEllipse(int numPoints, double rotation)
    
    Create an ellipse or circle based on this Bound's extent with the given number of points and rotation.
    Parameters:
    numPoints - The number of points
    rotation - The rotation angle
    Returns:
    The elliptical or circular Geometry
  - Polygon createHexagon(boolean inverted)
    
    Create a hexagon based on this Bound's extent
    Parameters:
    inverted - Whether the hexagon is inverted. If true then the point is north/south, else point is east/west
    Returns:
    A Polygon
  - Polygon createRectangle(int numPoints, double rotation)
    
    Create a rectangle or square based on this Bound's extent with the given number of points and rotation.
    Parameters:
    numPoints - The number of points
    rotation - The rotation angle
    Returns:
    The rectangular Geometry
  - Polygon createSineStar(int numberOfArms, double armLengthRatio, int numPoints, double rotation)
    
    Create a sine star based on this Bound's extent with the given number of arms and arm length ratio with the given number of points and rotation.
    Parameters:
    numberOfArms - The number of arms
    armLengthRatio - The arm length ratio
    numPoints - The number of points
    rotation - The rotation angle
    Returns:
    The sine star Polygon
  - Polygon createSquircle(int numPoints, double rotation)
    
    Create a squircle based on this Bound's extent with the given number of points and rotation.
    Parameters:
    numPoints - The number of points
    rotation - The rotation angle
    Returns:
    The squircular Geometry
  - Polygon createSuperCircle(double power, int numPoints, double rotation)
    
    Create a super circle based on this Bound's extent with the given number of points and rotation.
    Parameters:
    power - The positive power
    numPoints - The number of points
    rotation - The rotation angle
    Returns:
    The super circular Geometry
  - MultiPolygon createTriangles()
    
    Create triangles to fill the Bounds
    Returns:
    A MultiPolygon of 8 triangles
  - Bounds ensureWidthAndHeight()
    
    Ensure that the Bounds has a width and height. Handle vertical and horizontal lines and points.
    Returns:
    A new Bounds with a width and height
  - @java.lang.Override boolean equals(java.lang.Object other)
    
    Determine whether this Bounds equals another Bounds
    Parameters:
    other - The other Bounds
    Returns:
    Whether this Bounds and the other Bounds are equal
  - Bounds expand(Bounds other)
    
    Expand this Bounds to include another Bounds
    Parameters:
    other - Another Bounds
    Returns:
    The modified Bounds
  - Bounds expandBy(double distance)
    
    Expand the Bounds by the given distance in all directions
    Parameters:
    distance - The distance
    Returns:
    The modified Bounds
  - Bounds fixAspectRatio(int w, int h)
    
    Fix the aspect ration of this Bounds based on the given width and height.
    Parameters:
    w - The image width
    h - The image height
    Returns:
    A new Bounds
  - static Bounds fromString(java.lang.String str)
    
    Create a Bounds from a String or return null
    Parameters:
    str - The string
    Returns:
    A Bounds or null
  - void generateGrid(int columns, int rows, java.lang.String type, groovy.lang.Closure c)
    
    Generate a grid with the given number or rows and columns
    Parameters:
    columns - The number of columns
    rows - The number of rows
    type - The cell type (polygon, point, circle/ellipse, hexagon, hexagon-inv, triangle)
    c - A Closure that is called with each Geometry cell with the geometry, the column, and the row
  - void generateGrid(double cellWidth, double cellHeight, java.lang.String type, groovy.lang.Closure c)
    
    Generate a grid with the given cell width and height
    Parameters:
    cellWidth - The cell width
    cellHeight - The cell height
    type - The cell type (polygon, point, circle/ellipse, hexagon, hexagon-inv, triangle)
    c - A Closure that is called with each Geometry cell with the geometry, the column, and the row
  - double getArea()
    
    Get the area of this Bounds
    Returns:
    The area
  - double getAspect()
    
    Get the ratio of width to height for this bounds.
    Returns:
    The aspect ratio
  - java.lang.Object getAt(int index)
    
    Get a value from this Bounds at the given index (minX = 0, minY = 1, maxX = 2, maxY = 3).
    Bounds b = new Bounds(1,2,3,4)
    
    def w = b[0]
    
    def (w,s,e,n) = b
    
    Returns:
    A value from this Bounds or null if the index is greater than 3
  - java.util.List getCorners()
    
    Get the corners of the Bounds as a List of Points. The ordering is: [minX,minY],[minX, maxY],[maxX,maxY],[maxX,minY]
    Returns:
    A List of Points
  - Geometry getGeometry()
    
    Convert this Bounds into a Geometry object
    Returns:
    A Geometry
  - Geometry getGrid(int columns, int rows, java.lang.String type)
    
    Get a generated grid with the given number of the rows and column
    Parameters:
    columns - The number of columns
    rows - The number of rows
    type - The cell type (polygon, point, circle/ellipse, hexagon, hexagon-inv, triangle)
    Returns:
    The generated grid as a Geometry
  - Geometry getGrid(double cellWidth, double cellHeight, java.lang.String type)
    
    Get a generated grid with the given cell width and height
    Parameters:
    cellWidth - The cell width
    cellHeight - The cell height
    type - The cell type (polygon, point, circle/ellipse, hexagon, hexagon-inv, triangle)
    Returns:
    The generated grid as a Geometry
  - double getHeight()
    
    Get the height
    Returns:
    The height
  - double getMaxX()
    
    Get the right/east most coordinate (maxX)
    Returns:
    The right/east most coordinate (maxX)
  - double getMaxY()
    
    Get the top/north most coordinate (maxY)
    Returns:
    The top/north most coordinate (maxY)
  - double getMinX()
    
    Get the left/west most coordinate (minX)
    Returns:
    The left/west most coordinate (minX)
  - double getMinY()
    
    Get the bottom/south most coordinate (minY)
    Returns:
    The bottom/south most coordinate (minY)
  - Polygon getPolygon()
    
    Convert this Bounds into a Polygon
    Returns:
    A Polygon
  - Projection getProj()
    
    Get the Projection (if any) or null
    Returns:
    The Projection (if any) or null
  - double getWidth()
    
    Get the width
    Returns:
    The width
  - @java.lang.Override int hashCode()
    
    Get the hash code for this Bounds
    Returns:
    The hash code for this Bounds
  - Bounds intersection(Bounds other)
    
    Calculate the intersection between this Bounds and the other Bounds
    Parameters:
    other - The other Bounds
    Returns:
    The intersection Bounds between this and the other Bounds
  - boolean intersects(Bounds other)
    
    Determine whether this Bounds intersects with the other Bounds
    Parameters:
    other - The other Bounds
    Returns:
    Whether this Bounds intersects with the other Bounds
  - boolean isEmpty()
    
    Get whether the Bounds is empty (width and height are zero)
    Returns:
    Whether the Bounds is empty
  - void quadTree(int start, int stop, groovy.lang.Closure closure)
    
    Calculate a quad tree for this Bounds between the start and stop levels. The Closure is called for each new Bounds generated.
    Parameters:
    start - The start level
    stop - The stop level
    closure - The Closure called for each new Bounds
  - Bounds reproject(java.lang.Object proj)
    
    Reprojects the Bounds
    Parameters:
    proj - A Projection or String
    Returns:
    The reprojected Bounds
  - Bounds scale(double factor)
    
    Scales the current Bounds by a specific factor.
    Parameters:
    factor - The scale factor
    Returns:
    The new scaled Bounds
  - void setProj(java.lang.Object projection)
    
    Set a Projection if the current Projection is not set or reproject if needed
    Parameters:
    projection - The new Projection
  - java.util.List<Bounds> tile(double res)
    
    Partitions the bounding box into a set of smaller bounding boxes.
    Parameters:
    res - The resolution to tile at and should be in range 0-1.
    Returns:
    A List of smaller bounding boxes
  - java.lang.String toString()
    
    The string representation
    Returns:
    The string representation

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Bounds

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

ReferencedEnvelope env

Projection proj

Constructor Detail

Bounds(ReferencedEnvelope env)

Bounds(Envelope env)

Bounds(double minX, double minY, double maxX, double maxY)

Bounds(double minX, double minY, double maxX, double maxY, java.lang.Object proj)

Bounds(Point point, double width, double height, boolean isOrigin)

Method Detail

java.lang.Object asType(java.lang.Class type)

boolean contains(Bounds other)

boolean contains(Point point)

LineString createArc(double startAngle, double angleExtent, int numPoints, double rotation)

Polygon createArcPolygon(double startAngle, double angleExtent, int numPoints, double rotation)

Polygon createEllipse(int numPoints, double rotation)

Polygon createHexagon(boolean inverted)

Polygon createRectangle(int numPoints, double rotation)

Polygon createSineStar(int numberOfArms, double armLengthRatio, int numPoints, double rotation)

Polygon createSquircle(int numPoints, double rotation)

Polygon createSuperCircle(double power, int numPoints, double rotation)

MultiPolygon createTriangles()

Bounds ensureWidthAndHeight()

@java.lang.Override boolean equals(java.lang.Object other)

Bounds expand(Bounds other)

Bounds expandBy(double distance)

Bounds fixAspectRatio(int w, int h)

static Bounds fromString(java.lang.String str)

void generateGrid(int columns, int rows, java.lang.String type, groovy.lang.Closure c)

void generateGrid(double cellWidth, double cellHeight, java.lang.String type, groovy.lang.Closure c)

double getArea()

double getAspect()

java.lang.Object getAt(int index)

java.util.List getCorners()

Geometry getGeometry()

Geometry getGrid(int columns, int rows, java.lang.String type)

Geometry getGrid(double cellWidth, double cellHeight, java.lang.String type)

double getHeight()

double getMaxX()

double getMaxY()

double getMinX()

double getMinY()

Polygon getPolygon()

Projection getProj()

double getWidth()

@java.lang.Override int hashCode()

Bounds intersection(Bounds other)

boolean intersects(Bounds other)

boolean isEmpty()

void quadTree(int start, int stop, groovy.lang.Closure closure)

Bounds reproject(java.lang.Object proj)

Bounds scale(double factor)

void setProj(java.lang.Object projection)

java.util.List<Bounds> tile(double res)

java.lang.String toString()