Skip to content

Commit 7567c0c

Browse files
lilleyselilleyse
authored
Merge pull request #5913 from ggetz/clipping-planes-models
Clipping planes for models, tilesets, point clouds
2 parents 24cc60f + b01ffa9 commit 7567c0c

11 files changed

+380
-4
lines changed

‎Apps/Sandcastle/gallery/Clipping Planes.html

+191
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1"> <!-- Use Chrome Frame in IE -->
6+
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, minimum-scale=1, user-scalable=no">
7+
<meta name="description" content="User-defined clipping planes applied to a batched 3D Tileset, point cloud, and model.">
8+
<meta name="cesium-sandcastle-labels" content="Showcases, 3D Tiles">
9+
<title>Cesium Demo</title>
10+
<script type="text/javascript" src="../Sandcastle-header.js"></script>
11+
<script type="text/javascript" src="../../../ThirdParty/requirejs-2.1.20/require.js"></script>
12+
<script type="text/javascript">
13+
require.config({
14+
baseUrl : '../../../Source',
15+
waitSeconds : 60
16+
});
17+
</script>
18+
</head>
19+
<body class="sandcastle-loading" data-sandcastle-bucket="bucket-requirejs.html">
20+
<style>
21+
@import url(../templates/bucket.css);
22+
#toolbar {
23+
background: rgba(42, 42, 42, 0.8);
24+
padding: 4px;
25+
border-radius: 4px;
26+
}
27+
#toolbar input {
28+
vertical-align: middle;
29+
padding-top: 2px;
30+
padding-bottom: 2px;
31+
}
32+
#toolbar .header {
33+
font-weight: bold;
34+
}
35+
</style>
36+
<div id="cesiumContainer" class="fullSize"></div>
37+
<div id="loadingOverlay"><h1>Loading...</h1></div>
38+
<div id="toolbar">
39+
<table><tbody>
40+
<tr>
41+
<td>Type</td>
42+
<td><select data-bind="options: exampleTypes, value: exampleType"></select></td>
43+
</tr>
44+
<tr>
45+
<td>x</td>
46+
<td>
47+
<input type="range" min="-100" max="100" step="1" data-bind="value: xOffset, valueUpdate: 'input'">
48+
<input type="text" size="2" data-bind="value: xOffset">
49+
</td>
50+
</tr>
51+
<tr>
52+
<td>y</td>
53+
<td>
54+
<input type="range" min="-100" max="100" step="1" data-bind="value: yOffset, valueUpdate: 'input'">
55+
<input type="text" size="2" data-bind="value: yOffset">
56+
</td>
57+
</tr>
58+
<tr>
59+
<td>z</td>
60+
<td>
61+
<input type="range" min="-100" max="100" step="1" data-bind="value: zOffset, valueUpdate: 'input'">
62+
<input type="text" size="2" data-bind="value: zOffset">
63+
</td>
64+
</tr>
65+
</tbody></table>
66+
</div>
67+
68+
<script id="cesium_sandcastle_script">
69+
function startup(Cesium) {
70+
'use strict';
71+
//Sandcastle_Begin
72+
var viewer = new Cesium.Viewer('cesiumContainer');
73+
74+
var defaultClippingPlanes = [
75+
new Cesium.Plane(new Cesium.Cartesian3(-1, 0, 0), 0.0),
76+
new Cesium.Plane(new Cesium.Cartesian3(0, -1, 0), 100.0),
77+
new Cesium.Plane(new Cesium.Cartesian3(0, 0, 1), 100.0)
78+
];
79+
80+
function loadTileset (url) {
81+
reset();
82+
83+
var tileset = viewer.scene.primitives.add(new Cesium.Cesium3DTileset({
84+
url : url
85+
}));
86+
87+
tileset.readyPromise.then(function() {
88+
var boundingSphere = tileset.boundingSphere;
89+
viewer.camera.viewBoundingSphere(boundingSphere, new Cesium.HeadingPitchRange(0.5, -0.2, boundingSphere.radius * 4.0));
90+
viewer.camera.lookAtTransform(Cesium.Matrix4.IDENTITY);
91+
}).otherwise(function(error) {
92+
throw(error);
93+
});
94+
95+
tileset.clippingPlanes = defaultClippingPlanes;
96+
return tileset.clippingPlanes;
97+
}
98+
99+
function loadModel (url) {
100+
reset();
101+
102+
var position = Cesium.Cartesian3.fromDegrees(-123.0744619, 44.0503706, 100.0);
103+
var heading = Cesium.Math.toRadians(135);
104+
var pitch = 0;
105+
var roll = 0;
106+
var hpr = new Cesium.HeadingPitchRoll(heading, pitch, roll);
107+
var orientation = Cesium.Transforms.headingPitchRollQuaternion(position, hpr);
108+
109+
var entity = viewer.entities.add({
110+
name : url,
111+
position : position,
112+
orientation : orientation,
113+
model : {
114+
uri : url,
115+
scale: 8,
116+
minimumPixelSize: 100.0
117+
}
118+
});
119+
120+
viewer.trackedEntity = entity;
121+
122+
entity.model.clippingPlanes = defaultClippingPlanes;
123+
return entity.model.clippingPlanes.getValue();
124+
}
125+
126+
// Power Plant design model provided by Bentley Systems
127+
var bimUrl = 'https://beta.cesium.com/api/assets/1459?access_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIzNjUyM2I5Yy01YmRhLTQ0MjktOGI0Zi02MDdmYzBjMmY0MjYiLCJpZCI6NDQsImFzc2V0cyI6WzE0NTldLCJpYXQiOjE0OTkyNjQ3ODF9.SW_rwY-ic0TwQBeiweXNqFyywoxnnUBtcVjeCmDGef4';
128+
var pointCloudUrl = 'https://beta.cesium.com/api/assets/1460?access_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIyMzk2YzJiOS1jZGFmLTRlZmYtYmQ4MS00NTA3NjEwMzViZTkiLCJpZCI6NDQsImFzc2V0cyI6WzE0NjBdLCJpYXQiOjE0OTkyNjQ3NTV9.oWjvN52CRQ-dk3xtvD4e8ZnOHZhoWSpJLlw115mbQJM';
129+
var modelUrl = '../../SampleData/models/CesiumAir/Cesium_Air.glb';
130+
131+
var clippingPlanes = loadTileset(bimUrl);
132+
133+
// Track and create the bindings for the view model
134+
135+
var viewModel = {
136+
exampleType : 'BIM',
137+
exampleTypes : ['BIM', 'Model', 'Point Cloud'],
138+
xOffset : 0.0,
139+
yOffset: 100.0,
140+
zOffset: 100.0
141+
};
142+
var toolbar = document.getElementById('toolbar');
143+
Cesium.knockout.track(viewModel);
144+
Cesium.knockout.applyBindings(viewModel, toolbar);
145+
146+
Cesium.knockout.getObservable(viewModel, 'xOffset').subscribe(function(newValue) {
147+
clippingPlanes[0].distance = parseFloat(newValue);
148+
});
149+
150+
Cesium.knockout.getObservable(viewModel, 'yOffset').subscribe(function(newValue) {
151+
clippingPlanes[1].distance = parseFloat(newValue);
152+
});
153+
154+
Cesium.knockout.getObservable(viewModel, 'zOffset').subscribe(function(newValue) {
155+
clippingPlanes[2].distance = parseFloat(newValue);
156+
});
157+
158+
Cesium.knockout.getObservable(viewModel, 'exampleType').subscribe(
159+
function(newValue) {
160+
if (newValue === 'BIM') {
161+
clippingPlanes = loadTileset(bimUrl);
162+
} else if (newValue === 'Point Cloud') {
163+
clippingPlanes = loadTileset(pointCloudUrl);
164+
} else {
165+
clippingPlanes = loadModel(modelUrl);
166+
}
167+
}
168+
);
169+
170+
function reset () {
171+
viewer.entities.removeAll();
172+
viewer.scene.primitives.removeAll();
173+
174+
if (Cesium.defined(viewModel)) {
175+
viewModel.xOffset = 0.0;
176+
viewModel.yOffset = 100.0;
177+
viewModel.zOffset = 100.0;
178+
}
179+
}
180+
181+
//Sandcastle_End
182+
Sandcastle.finishedLoading();
183+
}
184+
if (typeof Cesium !== "undefined") {
185+
startup(Cesium);
186+
} else if (typeof require === "function") {
187+
require(["Cesium"], startup);
188+
}
189+
</script>
190+
</body>
191+
</html>

‎Apps/Sandcastle/gallery/Clipping Planes.jpg

20.5 KB
Loading

‎CHANGES.md

+1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Change Log
1818
* Fixed a 3D Tiles point cloud bug causing a stray point to appear at the center of the screen on certain hardware. [#5599](https://github.com/AnalyticalGraphicsInc/cesium/issues/5599)
1919
* Fixed removing multiple event listeners within event callbacks. [#5827](https://github.com/AnalyticalGraphicsInc/cesium/issues/5827)
2020
* Running `buildApps` now creates a built version of Sandcastle which uses the built version of Cesium for better performance.
21+
* Added `clippingPlanes` property to models and 3D Tilesets, which specify an array of planes to clip the object. [TODO]()
2122
* Fixed a tileset traversal bug when the `skipLevelOfDetail` optimization is off. [#5869](https://github.com/AnalyticalGraphicsInc/cesium/issues/5869)
2223

2324
### 1.37 - 2017-09-01

‎Source/DataSources/ModelGraphics.js

+14-1
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ define([
5454
* @param {Property} [options.color=Color.WHITE] A Property specifying the {@link Color} that blends with the model's rendered color.
5555
* @param {Property} [options.colorBlendMode=ColorBlendMode.HIGHLIGHT] An enum Property specifying how the color blends with the model.
5656
* @param {Property} [options.colorBlendAmount=0.5] A numeric Property specifying the color strength when the <code>colorBlendMode</code> is <code>MIX</code>. A value of 0.0 results in the model's rendered color while a value of 1.0 results in a solid color, with any value in-between resulting in a mix of the two.
57+
* @param {Property} [options.clippingPlanes=[]] A property specifying an array of {@link Plane} used to clip the model.
5758
*
5859
* @see {@link http://cesiumjs.org/2014/03/03/Cesium-3D-Models-Tutorial/|3D Models Tutorial}
5960
* @demo {@link http://cesiumjs.org/Cesium/Apps/Sandcastle/index.html?src=3D%20Models.html|Cesium Sandcastle 3D Models Demo}
@@ -91,6 +92,8 @@ define([
9192
this._colorBlendModeSubscription = undefined;
9293
this._colorBlendAmount = undefined;
9394
this._colorBlendAmountSubscription = undefined;
95+
this._clippingPlanes = undefined;
96+
this._clippingPlanesSubscription = undefined;
9497
this._definitionChanged = new Event();
9598

9699
this.merge(defaultValue(options, defaultValue.EMPTY_OBJECT));
@@ -242,7 +245,15 @@ define([
242245
* @type {Property}
243246
* @default 0.5
244247
*/
245-
colorBlendAmount : createPropertyDescriptor('colorBlendAmount')
248+
colorBlendAmount : createPropertyDescriptor('colorBlendAmount'),
249+
250+
/**
251+
* A property specifying an array of {@link Plane} used to clip the model.
252+
* @memberof ModelGraphics.prototype
253+
* @type {Property}
254+
* @default []
255+
*/
256+
clippingPlanes: createPropertyDescriptor('clippingPlanes')
246257
});
247258

248259
/**
@@ -271,6 +282,7 @@ define([
271282
result.color = this.color;
272283
result.colorBlendMode = this.colorBlendMode;
273284
result.colorBlendAmount = this.colorBlendAmount;
285+
result.clippingPlanes = this.clippingPlanes;
274286

275287
return result;
276288
};
@@ -303,6 +315,7 @@ define([
303315
this.color = defaultValue(this.color, source.color);
304316
this.colorBlendMode = defaultValue(this.colorBlendMode, source.colorBlendMode);
305317
this.colorBlendAmount = defaultValue(this.colorBlendAmount, source.colorBlendAmount);
318+
this.clippingPlanes = defaultValue(this.clippingPlanes, source.clippingPlanes);
306319

307320
var sourceNodeTransformations = source.nodeTransformations;
308321
if (defined(sourceNodeTransformations)) {

‎Source/DataSources/ModelVisualizer.js

+2
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ define([
4040
var defaultColor = Color.WHITE;
4141
var defaultColorBlendMode = ColorBlendMode.HIGHLIGHT;
4242
var defaultColorBlendAmount = 0.5;
43+
var defaultClippingPlanes = [];
4344

4445
var modelMatrixScratch = new Matrix4();
4546
var nodeMatrixScratch = new Matrix4();
@@ -152,6 +153,7 @@ define([
152153
model.color = Property.getValueOrDefault(modelGraphics._color, time, defaultColor, model._color);
153154
model.colorBlendMode = Property.getValueOrDefault(modelGraphics._colorBlendMode, time, defaultColorBlendMode);
154155
model.colorBlendAmount = Property.getValueOrDefault(modelGraphics._colorBlendAmount, time, defaultColorBlendAmount);
156+
model.clippingPlanes = Property.getValueOrDefault(modelGraphics._clippingPlanes, time, defaultClippingPlanes);
155157

156158
if (model.ready) {
157159
var runAnimations = Property.getValueOrDefault(modelGraphics._runAnimations, time, true);

‎Source/Scene/Batched3DModel3DTileContent.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,8 @@ define([
377377
pickFragmentShaderLoaded : batchTable.getPickFragmentShaderCallback(),
378378
pickUniformMapLoaded : batchTable.getPickUniformMapCallback(),
379379
addBatchIdToGeneratedShaders : (batchLength > 0), // If the batch table has values in it, generated shaders will need a batchId attribute
380-
pickObject : pickObject
380+
pickObject : pickObject,
381+
clippingPlanes : tileset.clippingPlanes
381382
});
382383
}
383384

@@ -447,6 +448,7 @@ define([
447448
this._model.modelMatrix = this._tile.computedTransform;
448449
this._model.shadows = this._tileset.shadows;
449450
this._model.debugWireframe = this._tileset.debugWireframe;
451+
this._model.clippingPlanes = this._tileset.clippingPlanes;
450452
this._model.update(frameState);
451453

452454
// If any commands were pushed, add derived commands

‎Source/Scene/Cesium3DTileset.js

+9
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ define([
105105
* @param {Number} [options.skipLevels=1] When <code>skipLevelOfDetail</code> is <code>true</code>, a constant defining the minimum number of levels to skip when loading tiles. When it is 0, no levels are skipped. Used in conjunction with <code>skipScreenSpaceErrorFactor</code> to determine which tiles to load.
106106
* @param {Boolean} [options.immediatelyLoadDesiredLevelOfDetail=false] When <code>skipLevelOfDetail</code> is <code>true</code>, only tiles that meet the maximum screen space error will ever be downloaded. Skipping factors are ignored and just the desired tiles are loaded.
107107
* @param {Boolean} [options.loadSiblings=false] When <code>skipLevelOfDetail</code> is <code>true</code>, determines whether siblings of visible tiles are always downloaded during traversal.
108+
* @param {Plane[]} [options.clippingPlanes=[]] An array of {@link Plane} used to clip the tileset.
108109
* @param {Boolean} [options.debugFreezeFrame=false] For debugging only. Determines if only the tiles from last frame should be used for rendering.
109110
* @param {Boolean} [options.debugColorizeTiles=false] For debugging only. When true, assigns a random color to each tile.
110111
* @param {Boolean} [options.debugWireframe=false] For debugging only. When true, render's each tile's content as a wireframe.
@@ -522,6 +523,14 @@ define([
522523
*/
523524
this.loadSiblings = defaultValue(options.loadSiblings, false);
524525

526+
/**
527+
* An array of {@link Plane} used to clip the tileset.
528+
*
529+
* @type {Plane[]}
530+
* @default []
531+
*/
532+
this.clippingPlanes = defaultValue(options.clippingPlanes, []);
533+
525534
/**
526535
* This property is for debugging only; it is not optimized for production use.
527536
* <p>

0 commit comments

Comments
 (0)