ClippingPlaneCollection
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.
In general the clipping planes' coordinates are relative to the object they're attached to, so a plane with distance set to 0 will clip through the center of the object.
For 3D Tiles, the root tile's transform is used to position the clipping planes. If a transform is not defined, the root tile's Cesium3DTile.boundingSphere is used instead.
// This clipping plane's distance is positive, which means its normal
// is facing the origin. This will clip everything that is behind
// the plane, which is anything with y coordinate < -5.
const clippingPlanes = new ClippingPlaneCollection({
planes : [
new ClippingPlane(new Cartesian3(0.0, 1.0, 0.0), 5.0)
],
});
// Create an entity and attach the ClippingPlaneCollection to the model.
const entity = viewer.entities.add({
position : Cartesian3.fromDegrees(-123.0744619, 44.0503706, 10000),
model : {
uri : 'model.gltf',
minimumPixelSize : 128,
maximumScale : 20000,
clippingPlanes : clippingPlanes
}
});
viewer.zoomTo(entity);
See also
Types
Properties
Returns the number of planes in this collection. This is commonly used with ClippingPlaneCollection.get to iterate over all the planes in the collection.
The 4x4 transformation matrix specifying an additional transform relative to the clipping planes original coordinate system.
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.
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.
If true, a region will be clipped if it is on the outside of any plane in the collection. Otherwise, a region will only be clipped if it is on the outside of every plane.
Functions
Adds the specified ClippingPlane to the collection to be used to selectively disable rendering on the outside of each plane. Use ClippingPlaneCollection.unionClippingRegions to modify how modify the clipping behavior of multiple planes.
Checks whether this collection contains a ClippingPlane equal to the given ClippingPlane.
Returns the plane in the collection at the specified index. Indices are zero-based and increase as planes are added. Removing a plane shifts all planes after it to the left, changing their indices. This function is commonly used with ClippingPlaneCollection.length to iterate over all the planes in the collection.
Returns true if this object was destroyed; otherwise, false.
Removes the first occurrence of the given ClippingPlane from the collection.
Called when Viewer or CesiumWidget render the scene to build the resources for clipping planes.