Skip to content

Add back ModelInstance class #12588

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 21 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 118 additions & 0 deletions Apps/Sandcastle/gallery/3D Model Instancing.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta
name="viewport"
content="width=device-width, initial-scale=1, maximum-scale=1, minimum-scale=1, user-scalable=no"
/>
<meta name="description" content="Create 3D models using glTF." />
<meta name="cesium-sandcastle-labels" content="Tutorials,Showcases" />
<title>Cesium Demo</title>
<script type="text/javascript" src="../Sandcastle-header.js"></script>
<script
type="text/javascript"
src="../../../Build/CesiumUnminified/Cesium.js"
nomodule
></script>
<script type="module" src="../load-cesium-es6.js"></script>
</head>
<body class="sandcastle-loading" data-sandcastle-bucket="bucket-requirejs.html">
<style>
@import url(../templates/bucket.css);
</style>
<div id="cesiumContainer" class="fullSize"></div>
<div id="loadingOverlay"><h1>Loading...</h1></div>
<div id="toolbar"></div>
<script id="cesium_sandcastle_script">
window.startup = async function (Cesium) {
"use strict";
//Sandcastle_Begin
const viewer = new Cesium.Viewer("cesiumContainer");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lukemckinstry Once the public API is where you'd like it, a reminder to clean up the Sandcastle example.


let model;
try {
model = await Cesium.Model.fromGltfAsync({
url: "../../SampleData/models/GroundVehicle/GroundVehicle.glb",
minimumPixelSize: 64,
});
viewer.scene.primitives.add(model);
} catch (error) {
console.log(`Failed to load model. ${error}`);
}

const lng = -75.1652;
const lat = 39.9526;

let position;
const headingPositionRoll = new Cesium.HeadingPitchRoll();
const fixedFrameTransform = Cesium.Transforms.localFrameToFixedFrameGenerator(
"north",
"west",
);

let instanceTransform;
for (let i = 0; i < 10; i++) {
position = Cesium.Cartesian3.fromDegrees(
lng + i * Math.random() * 0.0001,
lat + i * 0.0001,
);
instanceTransform = new Cesium.Transforms.headingPitchRollToFixedFrame(
position,
headingPositionRoll,
Cesium.Ellipsoid.WGS84,
fixedFrameTransform,
);
model.instances.add(instanceTransform);
}

viewer.scene.camera.setView({
destination: new Cesium.Cartesian3(
1253512.5232461668,
-4732922.214567729,
4074115.474546098,
),
orientation: new Cesium.HeadingPitchRoll(
2.205737333179613,
-0.7255022564055849,
6.283181225638178,
),
});

let instance;
let rotation = new Cesium.Matrix3();
let newTransform;
// modify the instance transform by supplying a new rotations after a delay
setTimeout(() => {
for (let i = 0; i < model.instances.length; i++) {
instance = model.instances.get(i);
rotation = Cesium.Matrix4.getRotation(instance.transform, rotation);
newTransform = Cesium.clone(instance.transform);

const angleDegrees = Math.random() * 180;
const angleRadians = Cesium.Math.toRadians(angleDegrees);
const rotationZ = Cesium.Matrix3.fromRotationZ(angleRadians);
const newRotation = Cesium.Matrix3.multiply(
rotationZ,
rotation,
new Cesium.Matrix3(),
);
newTransform = Cesium.clone(instance.transform);
Cesium.Matrix4.setRotation(newTransform, newRotation, newTransform);
instance.transform = newTransform;
}
}, "6000");
//Sandcastle_End
};
if (typeof Cesium !== "undefined") {
window.startupCalled = true;
window.startup(Cesium).catch((error) => {
"use strict";
console.error(error);
});
Sandcastle.finishedLoading();
}
</script>
</body>
</html>
12 changes: 12 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Change Log

## 1.130 - 2025-06-02

### @cesium/engine

#### Breaking Changes :mega:

#### Additions :tada:

- Adds support for instancing a model at runtime via `ModelInstance` and `ModelInstanceCollection` classes. Supply `Matrix4` transformation matrices in world space from the earth origin to `model.instances.add(transform)`. [#12588](https://github.com/CesiumGS/cesium/pull/12588)

#### Fixes :wrench:

## 1.129 - 2025-05-01

### @cesium/engine
Expand Down
Loading
Loading