Class OctagonalEnvelope

Namespace

NetTopologySuite.Geometries

Assembly

NetTopologySuite.dll

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

public class OctagonalEnvelope

Inheritance

object

OctagonalEnvelope

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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

OctagonalEnvelope()

Creates a new null bounding octagon

public OctagonalEnvelope()

OctagonalEnvelope(Coordinate)

Creates a new null bounding octagon bounding a Coordinate

public OctagonalEnvelope(Coordinate p)

Parameters

p Coordinate

The coordinate to bound

OctagonalEnvelope(Coordinate, Coordinate)

Creates a new null bounding octagon bounding a pair of Coordinates

public OctagonalEnvelope(Coordinate p0, Coordinate p1)

Parameters

p0 Coordinate

A coordinate to bound

p1 Coordinate

A coordinate to bound

OctagonalEnvelope(Envelope)

Creates a new null bounding octagon bounding an Envelope

public OctagonalEnvelope(Envelope env)

Parameters

env Envelope

OctagonalEnvelope(Geometry)

Creates a new null bounding octagon bounding a Geometry

public OctagonalEnvelope(Geometry geom)

Parameters

geom Geometry

OctagonalEnvelope(OctagonalEnvelope)

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

public OctagonalEnvelope(OctagonalEnvelope oct)

Parameters

oct OctagonalEnvelope

Properties

IsNull

Gets a value indicating that this object is null

public bool IsNull { get; }

Property Value

bool

MaxA

Gets a value indicating the maximal a value

public double MaxA { get; }

Property Value

double

MaxB

Gets a value indicating the maximal b value

public double MaxB { get; }

Property Value

double

MaxX

Gets a value indicating the maximal x-ordinate value

public double MaxX { get; }

Property Value

double

MaxY

Gets a value indicating the maximal y-ordinate value

public double MaxY { get; }

Property Value

double

MinA

Gets a value indicating the minimal a value

public double MinA { get; }

Property Value

double

MinB

Gets a value indicating the minimal b value

public double MinB { get; }

Property Value

double

MinX

Gets a value indicating the minimal x-ordinate value

public double MinX { get; }

Property Value

double

MinY

Gets a value indicating the minimal y-ordinate value

public double MinY { get; }

Property Value

double

Methods

Contains(OctagonalEnvelope)

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

public bool Contains(OctagonalEnvelope other)

Parameters

other OctagonalEnvelope

An octagonal envelope

Returns

bool

true if this octagonal envelope contains other octagonal envelope.

ExpandBy(double)

public void ExpandBy(double distance)

Parameters

distance double

ExpandToInclude(Coordinate)

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

public OctagonalEnvelope ExpandToInclude(Coordinate p)

Parameters

p Coordinate

The coordinate

Returns

OctagonalEnvelope

A reference to this octagonal envelope, expanded by p

ExpandToInclude(CoordinateSequence)

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

public OctagonalEnvelope ExpandToInclude(CoordinateSequence seq)

Parameters

seq CoordinateSequence

The coordinate sequence

Returns

OctagonalEnvelope

A reference to this octagonal envelope, expanded by seq

ExpandToInclude(Envelope)

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

public OctagonalEnvelope ExpandToInclude(Envelope env)

Parameters

env Envelope

The envelope

Returns

OctagonalEnvelope

A reference to this octagonal envelope, expanded by env

ExpandToInclude(Geometry)

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

public void ExpandToInclude(Geometry g)

Parameters

g Geometry

The geometry

ExpandToInclude(OctagonalEnvelope)

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

public OctagonalEnvelope ExpandToInclude(OctagonalEnvelope oct)

Parameters

oct OctagonalEnvelope

The OctogonalEnvelope

Returns

OctagonalEnvelope

A reference to this octagonal envelope, expanded by oct

ExpandToInclude(double, double)

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

public OctagonalEnvelope ExpandToInclude(double x, double y)

Parameters

x double

A x-ordinate value

y double

A y-ordinate value

Returns

OctagonalEnvelope

A reference to this octagonal envelope, expanded by x and y

GetOctagonalEnvelope(Geometry)

Gets the octagonal envelope of a geometry

public static Geometry GetOctagonalEnvelope(Geometry geom)

Parameters

geom Geometry

The geometry

Returns

Geometry

The octagonal envelope of the geometry

Intersects(Coordinate)

Function to test if this octagonal envelope contains p coordinate.

public bool Intersects(Coordinate p)

Parameters

p Coordinate

A coordinate

Returns

bool

true if this octagonal envelope contains p coordinate.

Intersects(OctagonalEnvelope)

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

public bool Intersects(OctagonalEnvelope other)

Parameters

other OctagonalEnvelope

An octagonal envelope

Returns

bool

true if this octagonal envelope intersects other octagonal envelope .

ToGeometry(GeometryFactory)

Function to convert this octagonal envelope into a geometry

public Geometry ToGeometry(GeometryFactory geomFactory)

Parameters

geomFactory GeometryFactory

The factory to create the geometry

Returns

Geometry

A geometry