ClippingCollection

new Cesium.ClippingCollection()

平面裁剪集合
Example:
var clippingCollection = viewer.scene.clippingCollection;
   clippingCollection.enabled = true;

Members

boxHeight : Number

裁剪Box的默认高度，单位为米
Default Value: [3]

enabled : Boolean

是否激活，当赋值时，会对当前所有已经存在的裁剪对象有效
Default Value: [true]

readonlyframeNumber : Number

裁剪刷新的当前帧数

readonlyisDestroied : Boolean

是否销毁

isReverse : Boolean

是否反向裁剪, 当赋值时，会对当前所有已经存在的裁剪对象有效
Default Value: [false]

isUnion : Boolean

是否激活公共区域裁剪效果, 当赋值时，会对当前所有已经存在的裁剪对象有效
Default Value: [false]

outlineColor : Color

裁剪轮廓线的颜色
Default Value: [Color.RED]

outlineEnabled : Boolean

激活裁剪轮廓线的显示效果
Default Value: [false]

outlineWidth : Number

裁剪轮廓线的宽度，单位为米
Default Value: [0.2]

planeColor : Color

裁剪示意对象的默认颜色, 当赋值时，不会修改已存在裁剪对象效果
Default Value: [Color.BLUE.withAlpha(0.5)]

planeHeight : Number

裁剪示意对象的默认高度, 当赋值时，不会修改已存在裁剪对象效果
Default Value: [400]

planeWidth : Number

裁剪示意对象的默认宽度, 当赋值时，不会修改已存在裁剪对象效果
Default Value: [600]

showPlanePrimitive : Boolean

是否显示裁剪面的示意图元, 当赋值时，会对当前所有已经存在的裁剪对象有效
Default Value: [true]

Methods

clear()

清除所有已添加的裁剪对象
Example:
viewer.scene.clippingCollection.clear();

has(clipping) → Boolean

判断裁剪对象是否已被添加
Name Type Description
clipping PlaneClipping 裁剪对象
Returns:
是否已被添加
Example:
if (viewer.scene.clippingCollection.has(clippingPlane) == false){
       viewer.scene.clippingCollection.push(clippingPlane);
   }

push(clipping) → Boolean

添加裁剪对象
Name Type Description
clipping PlaneClipping 待添加裁剪对象
Returns:
是否成功
Example:
viewer.scene.clippingCollection.push(clippingPlane);

queryClippingsByMatchedPrimitive(matchedPrimitive, TYPE) → Object

获取与匹配图元匹配的所有指定类型的裁剪对象
Name Type Description
matchedPrimitive Model 待匹配的图元对象
TYPE GeoClipping.PlaneClipping 裁剪类型
Returns:
Example:
var clippingObjects = viewer.scene.clippingCollection.queryClippingsByMatchedPrimitive(model, Cesium.GeoClipping.PlaneClipping);
   if (clippingObjects !== undefined){
       for (var name in clippingObjects){
           var clippingPlane = clippingObjects[name];
       }
   }

queryPlane(TYPE, index) → PlaneClipping

使用索引，获取指定类型的裁剪对象
Name Type Description
TYPE PlaneClipping 裁剪类型
index Number 索引
Returns:
Example:
var clippingPlane = viewer.scene.clippingCollection.queryPlane(Cesium.GeoClipping.PlaneClipping, 0);
   if (clippingPlane !== undefined){
       clippingPlane.enabled = false;
   }

remove(clipping) → Boolean

删除已被添加裁剪对象
Name Type Description
clipping PlaneClipping 裁剪对象
Returns:
是否删除成功
Example:
if (viewer.scene.clippingCollection.has(clippingPlane) == true){
       viewer.scene.clippingCollection.remove(clippingPlane);
       clippingPlane = undefined;
   }