OctagonalEnvelope (org.locationtech.jts:jts-core 1.20.0 API)

java.lang.Object
- org.locationtech.jts.geom.OctagonalEnvelope

```
public class OctagonalEnvelope
extends Object
```
A bounding container for a Geometry which is in the shape of a general octagon. The OctagonalEnvelope of a geometric object is a geometry which is a tight bound along the (up to) four extremal rectilinear parallels and along the (up to) four extremal diagonal parallels. Depending on the shape of the contained geometry, the octagon may be degenerate to any extreme (e.g. it may be a rectangle, a line, or a point).

Constructor Summary

Constructors
Constructor and Description
`OctagonalEnvelope()` Creates a new null bounding octagon
`OctagonalEnvelope(Coordinate p)` Creates a new null bounding octagon bounding a `Coordinate`
`OctagonalEnvelope(Coordinate p0, Coordinate p1)` Creates a new null bounding octagon bounding a pair of `Coordinate`s
`OctagonalEnvelope(Envelope env)` Creates a new null bounding octagon bounding an `Envelope`
`OctagonalEnvelope(Geometry geom)` Creates a new null bounding octagon bounding a `Geometry`
`OctagonalEnvelope(OctagonalEnvelope oct)` Creates a new null bounding octagon bounding an `OctagonalEnvelope` (the copy constructor).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(OctagonalEnvelope other)`
`void`	`expandBy(double distance)`
`OctagonalEnvelope`	`expandToInclude(Coordinate p)`
`OctagonalEnvelope`	`expandToInclude(CoordinateSequence seq)`
`OctagonalEnvelope`	`expandToInclude(double x, double y)`
`OctagonalEnvelope`	`expandToInclude(Envelope env)`
`void`	`expandToInclude(Geometry g)`
`OctagonalEnvelope`	`expandToInclude(OctagonalEnvelope oct)`
`double`	`getMaxA()`
`double`	`getMaxB()`
`double`	`getMaxX()`
`double`	`getMaxY()`
`double`	`getMinA()`
`double`	`getMinB()`
`double`	`getMinX()`
`double`	`getMinY()`
`boolean`	`intersects(Coordinate p)`
`boolean`	`intersects(OctagonalEnvelope other)`
`boolean`	`isNull()`
`static Geometry`	`octagonalEnvelope(Geometry geom)` Gets the octagonal envelope of a geometry
`void`	`setToNull()` Sets the value of this object to the null value
`Geometry`	`toGeometry(GeometryFactory geomFactory)`

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

Constructor Detail
- OctagonalEnvelope
```
public OctagonalEnvelope()
```
  Creates a new null bounding octagon
- OctagonalEnvelope
```
public OctagonalEnvelope(Coordinate p)
```
  Creates a new null bounding octagon bounding a Coordinate
  
  Parameters:
  
  p - the coordinate to bound
- OctagonalEnvelope
```
public OctagonalEnvelope(Coordinate p0,
                         Coordinate p1)
```
  Creates a new null bounding octagon bounding a pair of Coordinates
  
  Parameters:
  
  p0 - a coordinate to bound
  
  p1 - a coordinate to bound
- OctagonalEnvelope
```
public OctagonalEnvelope(Envelope env)
```
  Creates a new null bounding octagon bounding an Envelope
- OctagonalEnvelope
```
public OctagonalEnvelope(OctagonalEnvelope oct)
```
  Creates a new null bounding octagon bounding an OctagonalEnvelope (the copy constructor).
- OctagonalEnvelope
```
public OctagonalEnvelope(Geometry geom)
```
  Creates a new null bounding octagon bounding a Geometry

Method Detail

octagonalEnvelope
```
public static Geometry octagonalEnvelope(Geometry geom)
```
Gets the octagonal envelope of a geometry

Parameters:

geom - the geometry

Returns:

the octagonal envelope of the geometry

getMinX
```
public double getMinX()
```

getMaxX
```
public double getMaxX()
```

getMinY
```
public double getMinY()
```

getMaxY
```
public double getMaxY()
```

getMinA
```
public double getMinA()
```

getMaxA
```
public double getMaxA()
```

getMinB
```
public double getMinB()
```

getMaxB
```
public double getMaxB()
```

isNull
```
public boolean isNull()
```

setToNull
```
public void setToNull()
```
Sets the value of this object to the null value

expandToInclude

public void expandToInclude(Geometry g)

expandToInclude

public OctagonalEnvelope expandToInclude(CoordinateSequence seq)

expandToInclude

public OctagonalEnvelope expandToInclude(OctagonalEnvelope oct)

expandToInclude

public OctagonalEnvelope expandToInclude(Coordinate p)

expandToInclude

public OctagonalEnvelope expandToInclude(Envelope env)

expandToInclude

public OctagonalEnvelope expandToInclude(double x,
                                         double y)

expandBy

public void expandBy(double distance)

intersects

public boolean intersects(OctagonalEnvelope other)

intersects

public boolean intersects(Coordinate p)

contains

public boolean contains(OctagonalEnvelope other)

toGeometry

public Geometry toGeometry(GeometryFactory geomFactory)

Class OctagonalEnvelope

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OctagonalEnvelope

OctagonalEnvelope

OctagonalEnvelope

OctagonalEnvelope

OctagonalEnvelope

OctagonalEnvelope

Method Detail

octagonalEnvelope

getMinX

getMaxX

getMinY

getMaxY

getMinA

getMaxA

getMinB

getMaxB

isNull

setToNull

expandToInclude

expandToInclude

expandToInclude

expandToInclude

expandToInclude

expandToInclude

expandBy

intersects

intersects

contains

toGeometry