ModelExperimental

new Cesium.ModelExperimental(options)
Scene/ModelExperimental/ModelExperimental.js 55

A 3D model. This is a new architecture that is more decoupled than the older Model. This class is still experimental.

Do not call this function directly, instead use the `from` functions to create the Model from your source data type.

Name Type Description
options Object Object with the following properties:
Name Type Default Description
resource Resource The Resource to the 3D model.
modelMatrix Matrix4 Matrix4.IDENTITY optional The 4x4 transformation matrix that transforms the model from model to world coordinates.
debugShowBoundingVolume Boolean false optional For debugging only. Draws the bounding sphere for each draw command in the model.
cull Boolean true optional Whether or not to cull the model using frustum/horizon culling. If the model is part of a 3D Tiles tileset, this property will always be false, since the 3D Tiles culling system is used.
opaquePass Boolean Pass.OPAQUE optional The pass to use in the DrawCommand for the opaque portions of the model.
allowPicking Boolean true optional When true, each primitive is pickable with Scene#pick.
customShader CustomShader optional A custom shader. This will add user-defined GLSL code to the vertex and fragment shaders. Using custom shaders with a Cesium3DTileStyle may lead to undefined behavior.
content Cesium3DTileContent optional The tile content this model belongs to. This property will be undefined if model is not loaded as part of a tileset.
show Boolean true optional Whether or not to render the model.
color Color optional A color that blends with the model's rendered color.
colorBlendMode ColorBlendMode ColorBlendMode.HIGHLIGHT optional Defines how the color blends with the model.
colorBlendAmount Number 0.5 optional Value used to determine the color strength when the colorBlendMode is MIX. 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.
featureIdIndex Number 0 optional The index into the list of primitive feature IDs used for picking and styling. For EXT_feature_metadata, feature ID attributes are listed before feature ID textures. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.
instanceFeatureIdIndex Number 0 optional The index into the list of instance feature IDs used for picking and styling. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.
pointCloudShading Object optional Options for constructing a PointCloudShading object to control point attenuation based on geometric error and lighting.
backFaceCulling Boolean true optional Whether to cull back-facing geometry. When true, back face culling is determined by the material's doubleSided property; when false, back face culling is disabled. Back faces are not culled if the model's color is translucent.
shadows ShadowMode ShadowMode.ENABLED optional Determines whether the model casts or receives shadows from light sources.
showCreditsOnScreen Boolean false optional Whether to display the credits of this model on screen.
Experimental

This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.

Members

readonly boundingSphere : BoundingSphere
Scene/ModelExperimental/ModelExperimental.js 535

Gets the model's bounding sphere.

color : Color
Scene/ModelExperimental/ModelExperimental.js 481

The color to blend with the model's rendered color.

colorBlendAmount : Number
Scene/ModelExperimental/ModelExperimental.js 518

Value used to determine the color strength when the colorBlendMode is MIX. 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.
Default Value: 0.5

colorBlendMode : Cesium3DTileColorBlendMode|ColorBlendMode
Scene/ModelExperimental/ModelExperimental.js 501

Defines how the color blends with the model.
Default Value: ColorBlendMode.HIGHLIGHT

customShader : CustomShader
Scene/ModelExperimental/ModelExperimental.js 364

The model's custom shader, if it exists. Using custom shaders with a Cesium3DTileStyle may lead to undefined behavior.

debugShowBoundingVolume : Boolean
Scene/ModelExperimental/ModelExperimental.js 561

This property is for debugging only; it is not for production use nor is it optimized.

Draws the bounding sphere for each draw command in the model.

Default Value: false

readonly featureIdIndex : Number
Scene/ModelExperimental/ModelExperimental.js 604

The index into the list of primitive feature IDs used for picking and styling. For EXT_feature_metadata, feature ID attributes are listed before feature ID textures. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.
Default Value: 0

instanceFeatureIdIndex : Number
Scene/ModelExperimental/ModelExperimental.js 628

The index into the list of instance feature IDs used for picking and styling. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.
Default Value: 0

pointCloudShading : PointCloudShading
Scene/ModelExperimental/ModelExperimental.js 341

Point cloud shading settings for controlling point cloud attenuation and lighting. For 3D Tiles, this is inherited from the Cesium3DTileset.

readonly ready : Boolean
Scene/ModelExperimental/ModelExperimental.js 270

When true, this model is ready to render, i.e., the external binary, image, and shader files were downloaded and the WebGL resources were created. This is set to true right before ModelExperimental#readyPromise is resolved.
Default Value: false

readonly readyPromise : Promise.<ModelExperimental>
Scene/ModelExperimental/ModelExperimental.js 288

Gets the promise that will be resolved when this model is ready to render, i.e. when the external resources have been downloaded and the WebGL resources are created.

This promise is resolved at the end of the frame before the first frame the model is rendered in.

show : Boolean
Scene/ModelExperimental/ModelExperimental.js 582

Whether or not to render the model.
Default Value: true

showCreditsOnScreen : Boolean
Scene/ModelExperimental/ModelExperimental.js 691

Gets or sets whether the credits of the model will be displayed on the screen
Default Value: false

Methods

static Cesium.ModelExperimental.fromGltf(options) → ModelExperimental
Scene/ModelExperimental/ModelExperimental.js 936

Creates a model from a glTF asset. When the model is ready to render, i.e., when the external binary, image, and shader files are downloaded and the WebGL resources are created, the Model#readyPromise is resolved.

The model can be a traditional glTF asset with a .gltf extension or a Binary glTF using the .glb extension.

Name Type Description
options Object Object with the following properties:
Name Type Default Description
gltf String | Resource | Uint8Array | Object A Resource/URL to a glTF/glb file, a binary glTF buffer, or a JSON object containing the glTF contents
basePath String | Resource '' optional The base path that paths in the glTF JSON are relative to.
modelMatrix Matrix4 Matrix4.IDENTITY optional The 4x4 transformation matrix that transforms the model from model to world coordinates.
incrementallyLoadTextures Boolean true optional Determine if textures may continue to stream in after the model is loaded.
releaseGltfJson Boolean false optional When true, the glTF JSON is released once the glTF is loaded. This is is especially useful for cases like 3D Tiles, where each .gltf model is unique and caching the glTF JSON is not effective.
debugShowBoundingVolume Boolean false optional For debugging only. Draws the bounding sphere for each draw command in the model.
cull Boolean true optional Whether or not to cull the model using frustum/horizon culling. If the model is part of a 3D Tiles tileset, this property will always be false, since the 3D Tiles culling system is used.
opaquePass Boolean Pass.OPAQUE optional The pass to use in the DrawCommand for the opaque portions of the model.
upAxis Axis Axis.Y optional The up-axis of the glTF model.
forwardAxis Axis Axis.Z optional The forward-axis of the glTF model.
allowPicking Boolean true optional When true, each primitive is pickable with Scene#pick.
customShader CustomShader optional A custom shader. This will add user-defined GLSL code to the vertex and fragment shaders. Using custom shaders with a Cesium3DTileStyle may lead to undefined behavior.
content Cesium3DTileContent optional The tile content this model belongs to. This property will be undefined if model is not loaded as part of a tileset.
show Boolean true optional Whether or not to render the model.
color Color optional A color that blends with the model's rendered color.
colorBlendMode ColorBlendMode ColorBlendMode.HIGHLIGHT optional Defines how the color blends with the model.
colorBlendAmount Number 0.5 optional Value used to determine the color strength when the colorBlendMode is MIX. 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.
featureIdIndex Number 0 optional The index into the list of primitive feature IDs used for picking and styling. For EXT_feature_metadata, feature ID attributes are listed before feature ID textures. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.
instanceFeatureIdIndex Number 0 optional The index into the list of instance feature IDs used for picking and styling. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.
pointCloudShading Object optional Options for constructing a PointCloudShading object to control point attenuation and lighting.
backFaceCulling Boolean true optional Whether to cull back-facing geometry. When true, back face culling is determined by the material's doubleSided property; when false, back face culling is disabled. Back faces are not culled if the model's color is translucent.
shadows ShadowMode ShadowMode.ENABLED optional Determines whether the model casts or receives shadows from light sources.
showCreditsOnScreen Boolean false optional Whether to display the credits of this model on screen.
Returns:
The newly created model.

destroy()
Scene/ModelExperimental/ModelExperimental.js 872

Destroys the WebGL resources held by this object. Destroying an object allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this object.

Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.
Throws:
  • DeveloperError : This object was destroyed, i.e., destroy() was called.
Example:
model = model && model.destroy();
See:

isDestroyed() → Boolean
Scene/ModelExperimental/ModelExperimental.js 852

Returns true if this object was destroyed; otherwise, false.

If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.
Returns:
true if this object was destroyed; otherwise, false.
See:

update()
Scene/ModelExperimental/ModelExperimental.js 724

Called when Viewer or CesiumWidget render the scene to get the draw commands needed to render this primitive.

Do not call this function directly. This is documented just to list the exceptions that may be propagated when the scene is rendered:

Throws: