org.cesiumjs.cs.collections

Class ClippingPlaneCollection

java.lang.Object

org.cesiumjs.cs.collections.Collection<ClippingPlane>

org.cesiumjs.cs.collections.ClippingPlaneCollection

@JsType(isNative=true,
        namespace="Cesium",
        name="ClippingPlaneCollection")
public class ClippingPlaneCollection
extends Collection<ClippingPlane>

Specifies a set of clipping planes. Clipping planes selectively disable rendering in a region on the outside of the specified list of ClippingPlane objects for a single gltf model, 3D Tileset, or the globe.

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Color	edgeColor The color applied to highlight the edge along which an object is clipped.
double	edgeWidth The width, in pixels, of the highlight applied to the edge along which an object is clipped.
boolean	enabled Determines whether the clipping planes are active.
Matrix4	modelMatrix The 4x4 transformation matrix specifying an additional transform relative to the clipping planes original coordinate system.
Event	planeAdded An event triggered when a new clipping plane is added to the collection.
Event	planeRemoved An event triggered when a new clipping plane is removed from the collection.
boolean	unionClippingRegions If true, a region will be clipped if included in any plane in the collection.

Constructor Summary

Constructors

Constructor and Description
ClippingPlaneCollection() Specifies a set of clipping planes.
ClippingPlaneCollection(ClippingPlaneCollectionOptions options) Specifies a set of clipping planes.

Method Summary

Methods inherited from class org.cesiumjs.cs.collections.Collection

add, add, contains, destroy, get, isDestroyed, length, remove, remove, removeAll, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

edgeColor

@JsProperty
public Color edgeColor

The color applied to highlight the edge along which an object is clipped. Default: Color.WHITE().

edgeWidth

@JsProperty
public double edgeWidth

The width, in pixels, of the highlight applied to the edge along which an object is clipped. Default: 0.0

enabled

@JsProperty
public boolean enabled

Determines whether the clipping planes are active. Default: true

modelMatrix

@JsProperty
public Matrix4 modelMatrix

The 4x4 transformation matrix specifying an additional transform relative to the clipping planes original coordinate system. Default: Matrix4.IDENTITY().

planeAdded

@JsProperty
public Event planeAdded

An event triggered when a new clipping plane is added to the collection. Event handlers are passed the new plane and the index at which it was added. Default: Event()

planeRemoved

@JsProperty
public Event planeRemoved

An event triggered when a new clipping plane is removed from the collection. Event handlers are passed the new plane and the index from which it was removed. Default: Event()

unionClippingRegions

@JsProperty
public boolean unionClippingRegions

If true, a region will be clipped if included in any plane in the collection. Otherwise, the region to be clipped must intersect the regions defined by all planes in this collection. Default: true

Constructor Detail

ClippingPlaneCollection

@JsConstructor
public ClippingPlaneCollection()

Specifies a set of clipping planes. Clipping planes selectively disable rendering in a region on the outside of the specified list of Plane objects.

ClippingPlaneCollection

@JsConstructor
public ClippingPlaneCollection(ClippingPlaneCollectionOptions options)

Specifies a set of clipping planes. Clipping planes selectively disable rendering in a region on the outside of the specified list of Plane objects.

Parameters:

options - ClippingPlaneCollectionOptions object.