Class: ClippingPlaneCollection

ClippingPlaneCollection

new ClippingPlaneCollection(options)

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.

Name Type Description
options Object 可选

Object with the following properties:

Name Type Default Description
planes Array.<ClippingPlane> [] 可选

An array of ClippingPlane objects used to selectively disable rendering on the outside of each plane.
enabled Boolean true 可选

Determines whether the clipping planes are active.
modelMatrix Matrix4 Matrix4.IDENTITY 可选

The 4x4 transformation matrix specifying an additional transform relative to the clipping planes original coordinate system.
unionClippingRegions Boolean false 可选

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.
edgeColor Color Color.WHITE 可选

The color applied to highlight the edge along which an object is clipped.
edgeWidth Number 0.0 可选

The width, in pixels, of the highlight applied to the edge along which an object is clipped.
Example
// 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.
var clippingPlanes = new SuperMap3D.ClippingPlaneCollection({
    planes : [
        new SuperMap3D.ClippingPlane(new SuperMap3D.Cartesian3(0.0, 1.0, 0.0), 5.0)
    ],
});
// Create an entity and attach the ClippingPlaneCollection to the model.
var entity = viewer.entities.add({
    position : SuperMap3D.Cartesian3.fromDegrees(-123.0744619, 44.0503706, 10000),
    model : {
        uri : 'model.gltf',
        minimumPixelSize : 128,
        maximumScale : 20000,
        clippingPlanes : clippingPlanes
    }
});
viewer.zoomTo(entity);

Members

edgeColorColor

The color applied to highlight the edge along which an object is clipped.

Default Value:
Color.WHITE

edgeWidthNumber

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

Default Value:
0.0

enabledBoolean

If true, clipping will be enabled.

Default Value:
true

readonly lengthNumber

Returns the number of planes in this collection. This is commonly used with ClippingPlaneCollection#get to iterate over all the planes in the collection.

modelMatrixMatrix4

The 4x4 transformation matrix specifying an additional transform relative to the clipping planes original coordinate system.

Default Value:
Matrix4.IDENTITY

planeAddedEvent

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 Value:
Event()

planeRemovedEvent

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 Value:
Event()

unionClippingRegionsBoolean

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.

Default Value:
false

Methods

add(plane)

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.

Name Type Description
plane ClippingPlane

The ClippingPlane to add to the collection.
See:

contains(clippingPlane){Boolean}

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

Name Type Description
clippingPlane ClippingPlane 可选

The ClippingPlane to check for.
See:
Returns:
Type Description
Boolean true if this collection contains the ClippingPlane, false otherwise.

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.

Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.

See:
Throws:

This object was destroyed, i.e., destroy() was called.

Type
DeveloperError
Example
clippingPlanes = clippingPlanes && clippingPlanes .destroy();

get(index){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.

Name Type Description
index Number

The zero-based index of the plane.
See:
Returns:
Type Description
ClippingPlane The ClippingPlane at the specified index.

isDestroyed(){Boolean}

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

If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.

See:
Returns:
Type Description
Boolean true if this object was destroyed; otherwise, false.

remove(){Boolean}

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

See:
Returns:
Type Description
Boolean true if the plane was removed; false if the plane was not found in the collection.

removeAll()

Removes all planes from the collection.

See:

update()

Called when Viewer or Widget render the scene to build the resources for clipping planes.

Do not call this function directly.