Class OctagonalEnvelope

A bounding container for a Geometry which is in the shape of a general octagon.

Inheritance

object

OctagonalEnvelope

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: NetTopologySuite.Geometries

Assembly: NetTopologySuite.dll

Syntax

public class OctagonalEnvelope

Remarks

The OctagonalEnvelope of a geometric object is a geometry which is 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).

Constructors

| Edit this page View Source

OctagonalEnvelope()

Creates a new null bounding octagon

Declaration

public OctagonalEnvelope()

| Edit this page View Source

OctagonalEnvelope(Coordinate)

Creates a new null bounding octagon bounding a Coordinate

Declaration

public OctagonalEnvelope(Coordinate p)

Parameters

Type	Name	Description
Coordinate	p	The coordinate to bound

| Edit this page View Source

OctagonalEnvelope(Coordinate, Coordinate)

Creates a new null bounding octagon bounding a pair of Coordinates

Declaration

public OctagonalEnvelope(Coordinate p0, Coordinate p1)

Parameters

Type	Name	Description
Coordinate	p0	A coordinate to bound
Coordinate	p1	A coordinate to bound

| Edit this page View Source

OctagonalEnvelope(Envelope)

Creates a new null bounding octagon bounding an Envelope

Declaration

public OctagonalEnvelope(Envelope env)

Parameters

Type	Name	Description
Envelope	env

| Edit this page View Source

OctagonalEnvelope(Geometry)

Creates a new null bounding octagon bounding a Geometry

Declaration

public OctagonalEnvelope(Geometry geom)

Parameters

Type	Name	Description
Geometry	geom

| Edit this page View Source

OctagonalEnvelope(OctagonalEnvelope)

Creates a new null bounding octagon bounding an OctagonalEnvelope (the copy constructor).

Declaration

public OctagonalEnvelope(OctagonalEnvelope oct)

Parameters

Type	Name	Description
OctagonalEnvelope	oct

Properties

| Edit this page View Source

IsNull

Gets a value indicating that this object is null

Declaration

public bool IsNull { get; }

Property Value

Type	Description
bool

| Edit this page View Source

MaxA

Gets a value indicating the maximal a value

Declaration

public double MaxA { get; }

Property Value

Type	Description
double

| Edit this page View Source

MaxB

Gets a value indicating the maximal b value

Declaration

public double MaxB { get; }

Property Value

Type	Description
double

| Edit this page View Source

MaxX

Gets a value indicating the maximal x-ordinate value

Declaration

public double MaxX { get; }

Property Value

Type	Description
double

| Edit this page View Source

MaxY

Gets a value indicating the maximal y-ordinate value

Declaration

public double MaxY { get; }

Property Value

Type	Description
double

| Edit this page View Source

MinA

Gets a value indicating the minimal a value

Declaration

public double MinA { get; }

Property Value

Type	Description
double

| Edit this page View Source

MinB

Gets a value indicating the minimal b value

Declaration

public double MinB { get; }

Property Value

Type	Description
double

| Edit this page View Source

MinX

Gets a value indicating the minimal x-ordinate value

Declaration

public double MinX { get; }

Property Value

Type	Description
double

| Edit this page View Source

MinY

Gets a value indicating the minimal y-ordinate value

Declaration

public double MinY { get; }

Property Value

Type	Description
double

Methods

| Edit this page View Source

Contains(OctagonalEnvelope)

Function to test if this octagonal envelope contains other octagonal envelope.

Declaration

public bool Contains(OctagonalEnvelope other)

Parameters

Type	Name	Description
OctagonalEnvelope	other	An octagonal envelope

Returns

Type	Description
bool	`true` if `this` octagonal envelope contains `other` octagonal envelope.

| Edit this page View Source

ExpandBy(double)

Declaration

public void ExpandBy(double distance)

Parameters

Type	Name	Description
double	distance

| Edit this page View Source

ExpandToInclude(Coordinate)

Function to expand this OctagonalEnvelope to include the provided p coordinate.

Declaration

public OctagonalEnvelope ExpandToInclude(Coordinate p)

Parameters

Type	Name	Description
Coordinate	p	The coordinate

Returns

Type	Description
OctagonalEnvelope	A reference to `this` octagonal envelope, expanded by `p`

| Edit this page View Source

ExpandToInclude(CoordinateSequence)

Method to expand this OctagonalEnvelope to include the provided seq coordinate sequence.

Declaration

public OctagonalEnvelope ExpandToInclude(CoordinateSequence seq)

Parameters

Type	Name	Description
CoordinateSequence	seq	The coordinate sequence

Returns

Type	Description
OctagonalEnvelope	A reference to `this` octagonal envelope, expanded by `seq`

| Edit this page View Source

ExpandToInclude(Envelope)

Function to expand this OctagonalEnvelope to include the provided env envelope.

Declaration

public OctagonalEnvelope ExpandToInclude(Envelope env)

Parameters

Type	Name	Description
Envelope	env	The envelope

Returns

Type	Description
OctagonalEnvelope	A reference to `this` octagonal envelope, expanded by `env`

| Edit this page View Source

ExpandToInclude(Geometry)

Method to expand this OctagonalEnvelope to include the provided g geometry.

Declaration

public void ExpandToInclude(Geometry g)

Parameters

Type	Name	Description
Geometry	g	The geometry

| Edit this page View Source

ExpandToInclude(OctagonalEnvelope)

Method to expand this OctagonalEnvelope to include the provided oct OctogonalEnvelope.

Declaration

public OctagonalEnvelope ExpandToInclude(OctagonalEnvelope oct)

Parameters

Type	Name	Description
OctagonalEnvelope	oct	The OctogonalEnvelope

Returns

Type	Description
OctagonalEnvelope	A reference to `this` octagonal envelope, expanded by `oct`

| Edit this page View Source

ExpandToInclude(double, double)

Function to expand this OctagonalEnvelope to include the provided x- and y ordinates.

Declaration

public OctagonalEnvelope ExpandToInclude(double x, double y)

Parameters

Type	Name	Description
double	x	A x-ordinate value
double	y	A y-ordinate value

Returns

Type	Description
OctagonalEnvelope	A reference to `this` octagonal envelope, expanded by `x` and `y`

| Edit this page View Source

GetOctagonalEnvelope(Geometry)

Gets the octagonal envelope of a geometry

Declaration

public static Geometry GetOctagonalEnvelope(Geometry geom)

Parameters

Type	Name	Description
Geometry	geom	The geometry

Returns

Type	Description
Geometry	The octagonal envelope of the geometry

| Edit this page View Source

Intersects(Coordinate)

Function to test if this octagonal envelope contains p coordinate.

Declaration

public bool Intersects(Coordinate p)

Parameters

Type	Name	Description
Coordinate	p	A coordinate

Returns

Type	Description
bool	`true` if `this` octagonal envelope contains `p` coordinate.

| Edit this page View Source

Intersects(OctagonalEnvelope)

Function to test if this octagonal envelope intersects other octagonal envelope .

Declaration

public bool Intersects(OctagonalEnvelope other)

Parameters

Type	Name	Description
OctagonalEnvelope	other	An octagonal envelope

Returns

Type	Description
bool	`true` if `this` octagonal envelope intersects `other` octagonal envelope .

| Edit this page View Source

ToGeometry(GeometryFactory)

Function to convert this octagonal envelope into a geometry

Declaration

public Geometry ToGeometry(GeometryFactory geomFactory)

Parameters

Type	Name	Description
GeometryFactory	geomFactory	The factory to create the geometry

Returns

Type	Description
Geometry	A geometry