ClippingPlaneCollection
查阅Mars3D API

new Cesium.ClippingPlaneCollection(options)
engine/Source/Scene/ClippingPlaneCollection.js 68

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.

参数名称 类型 描述信息
options object 可选 Object with the following properties:
参数名称 类型 默认值 描述信息
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.
使用示例:
// 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 Cesium.ClippingPlaneCollection({
    planes : [
        new Cesium.ClippingPlane(new Cesium.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 : Cesium.Cartesian3.fromDegrees(-123.0744619, 44.0503706, 10000),
    model : {
        uri : 'model.gltf',
        minimumPixelSize : 128,
        maximumScale : 20000,
        clippingPlanes : clippingPlanes
    }
});
viewer.zoomTo(entity);
Demo:

成员(属性)

edgeColor : Color
engine/Source/Scene/ClippingPlaneCollection.js 97

The color applied to highlight the edge along which an object is clipped.
默认值: Color.WHITE

edgeWidth : number
engine/Source/Scene/ClippingPlaneCollection.js 105

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

enabled : boolean
engine/Source/Scene/ClippingPlaneCollection.js 206

If true, clipping will be enabled.
默认值: true

readonly length : number
engine/Source/Scene/ClippingPlaneCollection.js 169

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

modelMatrix : Matrix4
engine/Source/Scene/ClippingPlaneCollection.js 87

The 4x4 transformation matrix specifying an additional transform relative to the clipping planes original coordinate system.
默认值: Matrix4.IDENTITY

planeAdded : Event
engine/Source/Scene/ClippingPlaneCollection.js 113

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.
默认值: Event()

planeRemoved : Event
engine/Source/Scene/ClippingPlaneCollection.js 121

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.
默认值: Event()

unionClippingRegions : boolean
engine/Source/Scene/ClippingPlaneCollection.js 184

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.
默认值: false

方法

add(plane)
engine/Source/Scene/ClippingPlaneCollection.js 285

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.
参数名称 类型 描述信息
plane ClippingPlane The ClippingPlane to add to the collection.
参考:

contains(clippingPlane) → boolean
engine/Source/Scene/ClippingPlaneCollection.js 338

Checks whether this collection contains a ClippingPlane equal to the given ClippingPlane.
参数名称 类型 描述信息
clippingPlane ClippingPlane 可选 The ClippingPlane to check for.
返回值:
true if this collection contains the ClippingPlane, false otherwise.
参考:

destroy()
engine/Source/Scene/ClippingPlaneCollection.js 766

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.
Throws:
  • DeveloperError : This object was destroyed, i.e., destroy() was called.
使用示例:
clippingPlanes = clippingPlanes && clippingPlanes.destroy();
参考:

get(index) → ClippingPlane
engine/Source/Scene/ClippingPlaneCollection.js 311

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.
参数名称 类型 描述信息
index number The zero-based index of the plane.
返回值:
The ClippingPlane at the specified index.
参考:

isDestroyed() → boolean
engine/Source/Scene/ClippingPlaneCollection.js 746

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.
返回值:
true if this object was destroyed; otherwise, false.
参考:

remove(clippingPlane) → boolean
engine/Source/Scene/ClippingPlaneCollection.js 352

Removes the first occurrence of the given ClippingPlane from the collection.
参数名称 类型 描述信息
clippingPlane ClippingPlane
返回值:
true if the plane was removed; false if the plane was not found in the collection.
参考:

removeAll()
engine/Source/Scene/ClippingPlaneCollection.js 391

Removes all planes from the collection.
参考:

update()
engine/Source/Scene/ClippingPlaneCollection.js 472

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

Do not call this function directly.

packages/engine
packages/widgets