kotlin-cesium-engine/cesium.engine/ClippingPolygonCollection

ClippingPolygonCollection

external class ClippingPolygonCollection(options: ClippingPolygonCollection.ConstructorOptions? = definedExternally)(source)

Specifies a set of clipping polygons. Clipping polygons selectively disable rendering in a region inside or outside the specified list of ClippingPolygon objects for a single glTF model, 3D Tileset, or the globe.

Clipping Polygons are only supported in WebGL 2 contexts.

const positions = Cartesian3.fromRadiansArray([
    -1.3194369277314022,
    0.6988062530900625,
    -1.31941,
    0.69879,
    -1.3193955980204217,
    0.6988091578771254,
    -1.3193931220959367,
    0.698743632490865,
    -1.3194358224045408,
    0.6987471965556998,
]);

const polygon = new ClippingPolygon({
    positions: positions
});

const polygons = new ClippingPolygonCollection({
   polygons: [ polygon ]
});

Constructors

ClippingPolygonCollection

constructor(options: ClippingPolygonCollection.ConstructorOptions? = definedExternally)

Types

Companion

object Companion

ConstructorOptions

sealed interface ConstructorOptions

Properties

length

val length: Int

Returns the number of polygons in this collection. This is commonly used with ClippingPolygonCollection.get to iterate over all the polygons in the collection.

polygonAdded

var polygonAdded: DefaultEvent

An event triggered when a new clipping polygon is added to the collection. Event handlers are passed the new polygon and the index at which it was added.

polygonRemoved

var polygonRemoved: DefaultEvent

An event triggered when a new clipping polygon is removed from the collection. Event handlers are passed the new polygon and the index from which it was removed.

Functions

add

fun add(polygon: ClippingPolygon): ClippingPolygon

Adds the specified ClippingPolygon to the collection to be used to selectively disable rendering on the inside of each polygon. Use ClippingPolygonCollection.unionClippingRegions to modify how modify the clipping behavior of multiple polygons.

contains

fun contains(polygon: ClippingPolygon): Boolean

Checks whether this collection contains a ClippingPolygon equal to the given ClippingPolygon.

destroy

fun destroy()

Destroys the WebGL resources held by this object. Destroying an object allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this object.

get

operator fun get(index: Int): ClippingPolygon

Returns the clipping polygon in the collection at the specified index. Indices are zero-based and increase as polygons are added. Removing a polygon polygon all polygons after it to the left, changing their indices. This function is commonly used with ClippingPolygonCollection.length to iterate over all the polygons in the collection.

isDestroyed

fun isDestroyed(): Boolean

Returns true if this object was destroyed; otherwise, false.

remove

fun remove(polygon: ClippingPolygon): Boolean

Removes the first occurrence of the given ClippingPolygon from the collection.

removeAll

fun removeAll()

Removes all polygons from the collection.

ClippingPolygonCollection

See also

Constructors

Types

Properties

Functions