Fix scene sampleHeightMostDetailed does not work when a tileset is added by primitive collection

[plainheart]

Description

Fix the bug that sampleHeightMostDetailed/clampToHeightMostDetailed can not get height from a tileset that is added to the scene.primitives by a primitive collection. This bug was originally reported in the community 4 years ago.

Possible Cause:

cesium/packages/engine/Source/Scene/Picking.js

Line 1008 in 8209a59

if (tileset.show && scene.primitives.contains(tileset)) {

Here we can know scene.primitives.contains(tileset) will return false when the tileset is added by primitive collection - That is not expected, and causes the height sample to fail.

Here is a comment that says:

// Only update tilesets that are still contained in the scene's primitive collection and are still visible
// Update tilesets continually until all tilesets are ready. This way tiles are never removed from the cache.

But we can know the tilesets are already collected from the scene.primitives from the following function (Line 1070):

cesium/packages/engine/Source/Scene/Picking.js

Lines 1061 to 1080 in 8209a59

	function launchMostDetailedRayPick(
	picking,
	scene,
	ray,
	objectsToExclude,
	width,
	callback,
	) {
	const tilesets = [];
	getTilesets(scene.primitives, objectsToExclude, tilesets);
	if (tilesets.length === 0) {
	return Promise.resolve(callback());
	}
	const rayPick = new MostDetailedRayPick(ray, width, tilesets);
	picking._mostDetailedRayPicks.push(rayPick);
	return rayPick.promise.then(function () {
	return callback();
	});
	}

So I think we can remove the scene.primitives.contains(tileset) check to make the sample work, or consider adding a new function to check whether a tileset is in scene.primitives to replace this check?

Comparison

Before	After

Issue number and link

Fix https://community.cesium.com/t/clamptoheightmostdetailed-get-the-elevation-problem/15056

Sandcastle

https://sandcastle.cesium.com/#c=7VVRa9swEP4rh5/cEeSV9KVdElbSwQodC7SsD/MeFPsSi8mSkWSHrOS/72xZTUIcBmNjL/OLrdN9d999d4dFWWnj4A1wC3O0oi5hZXQJaZR1pzR6l6pUZVpZB43ADRqYgsJN782+dLY4+M+1clwoNGl00SGTBJ65ywpwBQLdWi0RdO2q2qXK1Cr2btxuVQarWmVOaAXdBbykCoBvuHDA8/xJSLToOsCp+Vm4YmFEKZxocK6lxC5S570byHAY0Cfy1TGboUJWhVCWGSx1g7dS9lQBvBrOw0kOz6UXxL/Gd3101sp5r9WtpcN9Ho+vrsbXl9e+iHMpiVzchz9yXMntkw43I3iBvDa8LecG3sIu0PN02h4tKLewGMcGSfcGL2A688VCoM+EoqRcdnQfNM8xb9N/aFC5B2EdMTOx1y4+hAcVKpF9X2grOlGnryJw4/Ta8KoQWadAa6ArruIA3zNY6lrlQq0fqwINMhLDoRkFPy9A+/i6jjSzvKwkfkSxLtwnbd0d0vRJzOOvh7y+7WNkfgKZ1OsDJmm0IHfMoegiwYaGCSxRolkNbX5tz00ajfbQwzzMwweo9/rHwbLzH7tfT+fZuf69oa1OQx3v87kd+oNTP8Dh7MQPrsZAgP9r8q/W5GQ/CBy68hdWJRpFE+u2Emet9b3w/6/ayJixxCHVyUnBZFkTUccya1vcJAmQSS4aEPl04H8FmeTW0s2qlvJR/MA0mk0S8j+CSeo9NeFzg0bybetSXM4evJExNknoeIpyWsslNwcRfwI

Another sandcastle based on the Sample Height from 3D Tiles example:

https://sandcastle.cesium.com/#c=vVbbbuM2EP0V1uiD3PXSulmXxBs0SFxsgNywa3SxqAssI9ExsTQpkHRcN/C/dyRKshyrRfvSF0kkZ+bMnLlQbF1IZdBPiGh0RTXbrNFSyTVaDLJqtRicL8RCZFJog14Y3VKFPiBBt7U0/rXacxr5KykMYYKqxWCEXhcCIUOVgp2zRmFu17iE+SIVz+sNZzhaiP3wvAHTGRUUsCworpaVL2yJnB+qJc44WRdz+ZGy55X5vCnKWGg+tMBbJnK5xYRTZcC/+Ypp9KTkVkMIuaQaCQkoVgkdWbqT2lxTiIPTHC8GpU/7ErkGJWuqCNbUlLE7FVZOtWGCGCYh0A47VwQc0oyIwCnFEPJ8Lwo9D7txmMRx6kfhyB68D+MgCrwAe3AUT5Kg3g/dxAsmKZ54/mQSebFvFYbVUypGge8T2I+U5Ew8PzKTrT5JzmvwEPtBmvoTzw0mURJESYPt4jD1PD8NkiBMXB/w65MI+3GahKmf+m6STKIuOBX5XBGhl1Kt2+zeEaPYHyG+uZ7dz2/mX5ucLoRRO5sXm14D5AKFkGCyJcy0hFWv4Hpuj6squZHiUsPiJneAjSgq7SE0HqOtVN81MmVit2RXb9okFYqtmWEvVGOS506NZj2pxNoKKI2g7YoKBIJAGiKtb0bC4rGxdAVE0qzk+hBFcXp43B492s6w1O/RfOsp6o+lR7OqUJQRSDdyoJ2kGh64lpxiLp+db7PyAHFZ1UYT5Bn68bXS2H9r65zoncjQciNsQBpag1PbGtqpLddtCeUHvoBniq7lC72EWmtItgxlTQd4x8T0dkaQutiNgsAPg3Ry3BghTrwwjNMwOOqM0MNpnMRp7IO6Lc7zHnD/34D70GWhFwReEiVHbenHPnb91HVTaIYOeujGOA1Cv3TLi1v0Dr7ciLLEA7fPKV07dQnzb+dUstZ56CjkcChABhLuObym1tQ5eveO1QlozMnl0vYRQ2NkraD3yLOWUAftN/Y7SJ0wgGE+FjUNHXFvdLLlt1sWs132Mzusz60n+yNeymlL86suE3YM9Mz17jR2DuEc8twU+InV4X8g8209l5322gRYSM3skD3BAFZbHijnrNCS5WeoVUVIQb+xv7sVXOyPUPMYjg5aawIXJyO8nazQ7VLhT7PrVmhff+2PGP6HQArJdxwu5457TWS6J7QWiKhsvito68qlXeP7h/tZK7RluVmdoUORHCLozsPahYeNKV93tcyjkgVc0zunw1tWBvwm/K+z29uHLwcGDozltDCrX6BI7v5HWJuB/eEH4XhSwvZgNJhqs+P0opT8mdnfrY3iDsZjQ0EcXNHjp032HW67TFdlPR03KtOcvSCWf+j5vSrzpTWcLDecf2Z/0sXgYjoG+SO1eto/vFDF4YoEkZV3cWs3McbTMSxPtYyU/ImojsW/AA

Author checklist

• I have submitted a Contributor License Agreement
• I have added my name to CONTRIBUTORS.md.
• I have updated CHANGES.md with a short summary of my change
• I have added or updated unit tests to ensure consistent code coverage
• I have updated the inline documentation, and included code examples where relevant
• I have performed a self-review of my code

[github-actions]

Thank you for the pull request, @plainheart!

✅ We can confirm we have a CLA on file for you.