flywave-terrain-datasource.groundmodificationpolygon

Home > @flywave/flywave-terrain-datasource > GroundModificationPolygon

GroundModificationPolygon interface

Represents a ground modification polygon with spatial properties

Used to define areas where terrain height should be modified. This interface provides a rich set of properties for defining complex terrain modifications with spatial boundaries.

Signature:

export interface GroundModificationPolygon 

Properties

Property	Modifiers	Type	Description
boundingBox		GeoBox	Bounding box of the polygon Provides a quick spatial index for the modification without requiring complex geometric calculations. Used for spatial queries and culling.
depthOrHeight?		number	(Optional) Depth or height value for the modification (optional) When present, defines the vertical extent of the modification in meters. Positive values typically represent elevation, negative values excavation.
geoArea		GeoBox | GeoPolygon | GeoLineString	Geographical area where the modification applies Can be a bounding box, polygon, or line string depending on the shape of the area to be modified.
id		string	Unique identifier for the polygon Generated to uniquely identify this modification across the system.
slopeWidth?		number	(Optional) Width of the slope (optional) When present, defines the horizontal extent of the slope transition zone around the modification area. This creates smoother transitions between modified and unmodified terrain.
type		GroundModificationType	Type of ground modification to apply Defines how the terrain should be modified using vertex source and height operation parameters.