Class PolyhedralSurface

Contiguous collection of polygons which share common boundary segments.

author: osbornb

Hierarchy

Surface
- PolyhedralSurface
  - TIN

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new PolyhedralSurface(): PolyhedralSurface
new PolyhedralSurface(polygon: Polygon): PolyhedralSurface
new PolyhedralSurface(polyhedralSurface: PolyhedralSurface): PolyhedralSurface
new PolyhedralSurface(polygons: Array<Polygon>): PolyhedralSurface
new PolyhedralSurface(hasZ: boolean, hasM: boolean): PolyhedralSurface
new PolyhedralSurface(type: GeometryType, hasZ: boolean, hasM: boolean): PolyhedralSurface

Overrides Surface.constructor
- Defined in lib/PolyhedralSurface.ts:13
Constructor Constructor

Returns PolyhedralSurface
Overrides Surface.constructor
- Defined in lib/PolyhedralSurface.ts:15
Constructor Constructor

Parameters
- polygon: Polygon
Returns PolyhedralSurface
Overrides Surface.constructor
- Defined in lib/PolyhedralSurface.ts:16
Constructor Constructor

Parameters
- polyhedralSurface: PolyhedralSurface
Returns PolyhedralSurface
Overrides Surface.constructor
- Defined in lib/PolyhedralSurface.ts:17
Constructor Constructor

Parameters
- polygons: Array<Polygon>
Returns PolyhedralSurface
Overrides Surface.constructor
- Defined in lib/PolyhedralSurface.ts:18
Constructor Constructor

Parameters
- hasZ: boolean
- hasM: boolean
Returns PolyhedralSurface
Overrides Surface.constructor
- Defined in lib/PolyhedralSurface.ts:19
Constructor Constructor

Parameters
- type: GeometryType
- hasZ: boolean
- hasM: boolean
Returns PolyhedralSurface

Accessors

geometryType

get geometryType(): GeometryType

Inherited from Geometry.geometryType
- Defined in lib/Geometry.ts:39
Get the geometry type

Returns GeometryType

geometry type

hasM

get hasM(): boolean
set hasM(hasM: boolean): void

Inherited from Geometry.hasM
- Defined in lib/Geometry.ts:72
Does the geometry have m coordinates

Returns boolean

true if has m coordinates
Inherited from Geometry.hasM
- Defined in lib/Geometry.ts:80
Set if the geometry has m coordinates

Parameters
- hasM: boolean
  
  true if has m coordinates
Returns void

true if has m coordinates

hasZ

get hasZ(): boolean
set hasZ(hasZ: boolean): void

Inherited from Geometry.hasZ
- Defined in lib/Geometry.ts:47
Does the geometry have z coordinates

Returns boolean

true if has z coordinates
Inherited from Geometry.hasZ
- Defined in lib/Geometry.ts:55
Set if the geometry has z coordinates

Parameters
- hasZ: boolean
  
  true if has z coordinates
Returns void

true if has z coordinates

is3D

get is3D(): boolean

Inherited from Geometry.is3D
- Defined in lib/Geometry.ts:64
Does the geometry have z coordinates

see

#hasZ()

Returns boolean

true if has z coordinates

patches

get patches(): Array<Polygon>
set patches(polygons: Array<Polygon>): void

- Defined in lib/PolyhedralSurface.ts:63
Get patches

see

#getPolygons()

Returns Array<Polygon>

patches
- Defined in lib/PolyhedralSurface.ts:84
Set patches

see

#setPolygons(List)

Parameters
- polygons: Array<Polygon>
Returns void

patches

polygons

get polygons(): Array<Polygon>
set polygons(polygons: Array<Polygon>): void

- Defined in lib/PolyhedralSurface.ts:53
Get polygons

Returns Array<Polygon>

polygons
- Defined in lib/PolyhedralSurface.ts:73
Set polygons

Parameters
- polygons: Array<Polygon>
```
       polygons
```
Returns void

polygons

Methods

addPatch

addPatch(patch: Polygon): void

- Defined in lib/PolyhedralSurface.ts:102
Add patch

see

#addPolygon(Polygon)

Parameters
- patch: Polygon
  
  patch
Returns void

addPatches

addPatches(patches: Array<Polygon>): void

- Defined in lib/PolyhedralSurface.ts:121
Add patches

see

#addPolygons(List)

Parameters
- patches: Array<Polygon>
  
  patches
Returns void

addPolygon

addPolygon(polygon: Polygon): void

- Defined in lib/PolyhedralSurface.ts:92
Add polygon

Parameters
- polygon: Polygon
  
  polygon
Returns void

addPolygons

addPolygons(polygons: Array<Polygon>): void

- Defined in lib/PolyhedralSurface.ts:110
Add polygons

Parameters
- polygons: Array<Polygon>
  
  polygons
Returns void

copy

copy(): Geometry

Overrides Geometry.copy
- Defined in lib/PolyhedralSurface.ts:164
{@inheritDoc}

Returns Geometry

equals

equals(obj: Geometry): boolean

Overrides Geometry.equals
- Defined in lib/PolyhedralSurface.ts:185
{@inheritDoc}

Parameters
- obj: Geometry
Returns boolean

expandEnvelope

expandEnvelope(envelope: GeometryEnvelope): void

Inherited from Geometry.expandEnvelope
- Defined in lib/Geometry.ts:150
Expand the envelope with the minimum bounding box for this Geometry

Parameters
- envelope: GeometryEnvelope
  
  geometry envelope to expand
Returns void

getCentroid

getCentroid(): Point

Inherited from Geometry.getCentroid
- Defined in lib/Geometry.ts:170
Get the mathematical centroid point of a 2 dimensional representation of the Geometry (balancing point of a 2d cutout of the geometry). Only the x and y coordinate of the resulting point are calculated and populated. The resulting {@link Point#getZ()} and {@link Point#getM()} methods will always return null.

Returns Point

centroid point

getDegreesCentroid

getDegreesCentroid(): Point

Inherited from Geometry.getDegreesCentroid
- Defined in lib/Geometry.ts:181
Get the geographic centroid point of a 2 dimensional representation of the degree unit Geometry. Only the x and y coordinate of the resulting point are calculated and populated. The resulting {@link Point#getZ()} and {@link Point#getM()} methods will always return null.

Returns Point

centroid point

getDimension

getDimension(): number

Inherited from Geometry.getDimension
- Defined in lib/Geometry.ts:158
Get the inherent dimension (0, 1, or 2) for this Geometry

Returns number

dimension

getEnvelope

getEnvelope(): GeometryEnvelope

Inherited from Geometry.getEnvelope
- Defined in lib/Geometry.ts:142
Get the minimum bounding box for this Geometry

Returns GeometryEnvelope

geometry envelope

getPatch

getPatch(n: number): Polygon

- Defined in lib/PolyhedralSurface.ts:157
Get the Nth polygon patch

see

#getPolygon(int)

Parameters
- n: number
  
  nth polygon patch to return
Returns Polygon

polygon patch

getPolygon

getPolygon(n: number): Polygon

- Defined in lib/PolyhedralSurface.ts:147
Get the Nth polygon

Parameters
- n: number
  
  nth polygon to return
Returns Polygon

polygon

isEmpty

isEmpty(): boolean

Overrides Geometry.isEmpty
- Defined in lib/PolyhedralSurface.ts:171
{@inheritDoc}

Returns boolean

isMeasured

isMeasured(): boolean

Inherited from Geometry.isMeasured
- Defined in lib/Geometry.ts:134
Does the geometry have m coordinates.

see

#hasM()

Returns boolean

true if has m coordinates

isSimple

isSimple(): boolean

Overrides Geometry.isSimple
- Defined in lib/PolyhedralSurface.ts:178
{@inheritDoc}

Returns boolean

numPatches

numPatches(): number

- Defined in lib/PolyhedralSurface.ts:138
Get the number of polygons

see

#numPolygons()

Returns number

number of polygons

numPolygons

numPolygons(): number

- Defined in lib/PolyhedralSurface.ts:129
Get the number of polygons

Returns number

number of polygons

updateZM

updateZM(geometry: Geometry): void

Inherited from Geometry.updateZM
- Defined in lib/Geometry.ts:88
Update currently false hasZ and hasM values using the provided geometry

Parameters
- geometry: Geometry
  
  geometry
Returns void

Static hasM

hasM(geometries: Array<Geometry>): boolean

Inherited from Geometry.hasM
- Defined in lib/Geometry.ts:118
Determine if the geometries contain a M value

Parameters
- geometries: Array<Geometry>
  
  list of geometries
Returns boolean

true if has m

Static hasZ

hasZ(geometries: Array<Geometry>): boolean

Inherited from Geometry.hasZ
- Defined in lib/Geometry.ts:102
Determine if the geometries contain a Z value

Parameters
- geometries: Array<Geometry>
  
  list of geometries
Returns boolean

true if has z

Generated using TypeDoc