ClippingPolygonCollection

new Cesium.ClippingPolygonCollection(options)
engine/Source/Scene/ClippingPolygonCollection.js 60

指定一组剪切多边形。剪切多边形有选择地禁用区域中的渲染 单个 glTF 模型、3D 瓦片集或地球的指定 ClippingPolygon 对象列表的内部或外部。 仅在 WebGL 2 上下文中支持剪切多边形。
Name Type Description
options object optional 对象，具有以下属性:
Name Type Default Description
polygons Array.<ClippingPolygon> [] optional 一个 ClippingPolygon 对象数组，用于选择性地禁用每个多边形内部的渲染。
enabled boolean true optional 确定裁剪多边形是否处于活动状态。
inverse boolean false optional 如果为 true，则如果区域位于集合中的每个多边形之外，则该区域将被裁剪。否则，仅当区域位于任何多边形的内部时，才会对其进行裁剪。
Example:
const positions = Cesium.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 Cesium.ClippingPolygon({
    positions: positions
});

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

Members

readonly length : number
engine/Source/Scene/ClippingPolygonCollection.js 136

返回此集合中的多边形数。 这通常与 ClippingPolygonCollection#get 迭代所有多边形 在集合中。

polygonAdded : Event
engine/Source/Scene/ClippingPolygonCollection.js 92

将新的剪切多边形添加到集合时触发的事件。 事件处理程序 的 Bean Bean Bean 的 Bean Bean S Bean 的 Polygon 和添加该 Polygon 的索引。
Default Value: Event()

polygonRemoved : Event
engine/Source/Scene/ClippingPolygonCollection.js 100

从集合中删除新的剪切多边形时触发的事件。 事件处理程序 将传递新多边形和从中删除该多边形的索引。
Default Value: Event()

Methods

static Cesium.ClippingPolygonCollection.isSupported(scene) → boolean
engine/Source/Scene/ClippingPolygonCollection.js 833

用于检查上下文是否允许剪切多边形的函数，这需要浮点纹理。
Name Type Description
scene Scene | object 将包含剪切对象和剪切纹理的场景。
Returns:
true，如果上下文支持剪切多边形。

add(polygon) → ClippingPolygon
engine/Source/Scene/ClippingPolygonCollection.js 292

将指定的 ClippingPolygon 添加到集合中，以用于选择性地禁用渲染 在每个多边形的内部。使用 ClippingPolygonCollection#unionClippingRegions 修改 如何修改多个多边形的裁剪行为。
Name Type Description
polygon ClippingPolygon 要添加到集合的 ClippingPolygon。
Returns:
添加的 ClippingPolygon。
Example:
const polygons = new Cesium.ClippingPolygonCollection();

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

polygons.add(new Cesium.ClippingPolygon({
    positions: positions
}));
See:

contains(polygon) → boolean
engine/Source/Scene/ClippingPolygonCollection.js 331

检查此集合是否包含等于给定 ClippingPolygon 的 ClippingPolygon。
Name Type Description
polygon ClippingPolygon 要检查的 ClippingPolygon。
Returns:
如果此集合包含 ClippingPolygon，则 true, 否则 false 。
See:

destroy()
engine/Source/Scene/ClippingPolygonCollection.js 954

销毁此对象持有的 WebGL 资源。 销毁对象允许确定性 释放 WebGL 资源，而不是依赖垃圾回收器来销毁这个对象。

一旦对象被销毁，就不应该使用它;调用 isDestroyed 将导致 DeveloperError 异常。 因此 将返回值 (undefined) 分配给对象，如示例中所示。
Throws:
Example:
clippingPolygons = clippingPolygons && clippingPolygons.destroy();
See:

get(index) → ClippingPolygon
engine/Source/Scene/ClippingPolygonCollection.js 315

返回集合中指定索引处的剪切多边形。 索引从 0 开始 并随着多边形的添加而增加。 移除 Polygon Faces 之后的所有多边形 它向左移动，更改其索引。 此功能通常用于 ClippingPolygonCollection#length 迭代所有多边形 在集合中。
Name Type Description
index number 多边形的从零开始的索引。
Returns:
指定索引处的 ClippingPolygon。
See:

isDestroyed() → boolean
engine/Source/Scene/ClippingPolygonCollection.js 934

如果此对象已销毁，则返回 true;否则为 false。

如果此对象已销毁，则不应使用;调用 isDestroyed 将导致 DeveloperError 异常。
Returns:
如果此对象被销毁，则为 true;否则为 false。
See:

remove(polygon) → boolean
engine/Source/Scene/ClippingPolygonCollection.js 349

从集合中删除给定 ClippingPolygon 的第一个匹配项。
Name Type Description
polygon ClippingPolygon
Returns:
如果删除了多边形，则为 true;如果在集合中找不到多边形，则为 false。
See:

removeAll()
engine/Source/Scene/ClippingPolygonCollection.js 460

从集合中删除所有多边形。
See:
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
packages/engine
packages/widgets