ModelExperimental

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

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.
show Boolean true optional Whether or not to render the model.
modelMatrix Matrix4 Matrix4.IDENTITY optional The 4x4 transformation matrix that transforms the model from model to world coordinates.
scale Number 1.0 optional A uniform scale applied to this model.
minimumPixelSize Number 0.0 optional The approximate minimum pixel size of the model regardless of zoom.
maximumScale Number optional The maximum scale size of a model. An upper limit for minimumPixelSize.
id Object optional A user-defined object to return when the model is picked with Scene#pick.
allowPicking Boolean true optional When true, each primitive is pickable with Scene#pick.
clampAnimations Boolean true optional Determines if the model's animations should hold a pose over frames where no keyframes are specified.
shadows ShadowMode ShadowMode.ENABLED optional Determines whether the model casts or receives shadows from light sources.
debugShowBoundingVolume Boolean false optional For debugging only. Draws the bounding sphere for each draw command in the model.
enableDebugWireframe Boolean false optional For debugging only. This must be set to true for debugWireframe to work in WebGL1. This cannot be set after the model has loaded.
debugWireframe Boolean false optional For debugging only. Draws the model in wireframe. Will only work for WebGL1 if enableDebugWireframe is set to true.
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.
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.
heightReference HeightReference HeightReference.NONE optional Determines how the model is drawn relative to terrain.
scene Scene optional Must be passed in for models that use the height reference property.
distanceDisplayCondition DistanceDisplayCondition optional The condition specifying at what distance from the camera that this model will be displayed.
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.
silhouetteColor Color Color.RED optional The silhouette color. If more than 256 models have silhouettes enabled, there is a small chance that overlapping models will have minor artifacts.
silhouetteSize Number 0.0 optional The size of the silhouette in pixels.
clippingPlanes ClippingPlaneCollection optional The ClippingPlaneCollection used to selectively disable rendering the model.
lightColor Cartesian3 optional The light color when shading the model. When undefined the scene's light color is used instead.
imageBasedLighting ImageBasedLighting optional The properties for managing image-based lighting on this model.
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.
credit Credit | String optional A credit for the data source, which is displayed on the canvas.
showCreditsOnScreen Boolean false optional Whether to display the credits of this model on screen.
splitDirection SplitDirection SplitDirection.NONE optional The SplitDirection split to apply to this model.
projectTo2D Boolean false optional Whether to accurately project the model's positions in 2D. If this is true, the model will be projected accurately to 2D, but it will use more memory to do so. If this is false, the model will use less memory and will still render in 2D / CV mode, but its positions may be inaccurate. This disables minimumPixelSize and prevents future modification to the model matrix. This also cannot be set after the model has loaded.
featureIdLabel String | Number "featureId_0" optional Label of the feature ID set to use for picking and styling. For EXT_mesh_features, this is the feature ID's label property, or "featureId_N" (where N is the index in the featureIds array) when not specified. EXT_feature_metadata did not have a label field, so such feature ID sets are always labeled "featureId_N" where N is the index in the list of all feature Ids, where feature ID attributes are listed before feature ID textures. If featureIdLabel is an integer N, it is converted to the string "featureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.
instanceFeatureIdLabel String | Number "instanceFeatureId_0" optional Label of the instance feature ID set used for picking and styling. If instanceFeatureIdLabel is set to an integer N, it is converted to the string "instanceFeatureId_N" automatically. 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.
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 activeAnimations : ModelExperimentalAnimationCollection
Scene/ModelExperimental/ModelExperimental.js 581

The currently playing glTF animations.

backFaceCulling : Boolean
Scene/ModelExperimental/ModelExperimental.js 1237

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 ModelExperimental#color is translucent or ModelExperimental#silhouetteSize is greater than 0.0.
Default Value: true

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

Gets the model's bounding sphere in world space. This does not take into account glTF animations, skins, or morph targets. It also does not account for ModelExperimental#minimumPixelSize.

clampAnimations : Boolean
Scene/ModelExperimental/ModelExperimental.js 595

Determines if the model's animations should hold a pose over frames where no keyframes are specified.
Default Value: true

clippingPlanes : ClippingPlaneCollection
Scene/ModelExperimental/ModelExperimental.js 1156

The ClippingPlaneCollection used to selectively disable rendering the model.

color : Color
Scene/ModelExperimental/ModelExperimental.js 878

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

colorBlendAmount : Number
Scene/ModelExperimental/ModelExperimental.js 917

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 899

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

readonly credit : Credit
Scene/ModelExperimental/ModelExperimental.js 1364

Gets the credit that will be displayed for the model

customShader : CustomShader
Scene/ModelExperimental/ModelExperimental.js 667

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 1015

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

debugWireframe : Boolean
Scene/ModelExperimental/ModelExperimental.js 1039

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

Draws the model in wireframe.

Default Value: false

distanceDisplayCondition : DistanceDisplayCondition
Scene/ModelExperimental/ModelExperimental.js 742

Gets or sets the distance display condition, which specifies at what distance from the camera this model will be displayed.
Default Value: undefined

featureIdLabel : String
Scene/ModelExperimental/ModelExperimental.js 1091

Label of the feature ID set to use for picking and styling.

For EXT_mesh_features, this is the feature ID's label property, or "featureId_N" (where N is the index in the featureIds array) when not specified. EXT_feature_metadata did not have a label field, so such feature ID sets are always labeled "featureId_N" where N is the index in the list of all feature Ids, where feature ID attributes are listed before feature ID textures.

If featureIdLabel is set to an integer N, it is converted to the string "featureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.

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.

heightReference : HeightReference
Scene/ModelExperimental/ModelExperimental.js 719

The height reference of the model, which determines how the model is drawn relative to terrain.
Default Value: {HeightReference.NONE}

id : Object
Scene/ModelExperimental/ModelExperimental.js 823

A user-defined object that is returned when the model is picked.
Default Value: undefined
See:

imageBasedLighting : ImageBasedLighting
Scene/ModelExperimental/ModelExperimental.js 1202

The properties for managing image-based lighting on this model.

instanceFeatureIdLabel : String
Scene/ModelExperimental/ModelExperimental.js 1127

Label of the instance feature ID set used for picking and styling.

If instanceFeatureIdLabel is set to an integer N, it is converted to the string "instanceFeatureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.

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.

lightColor : Cartesian3
Scene/ModelExperimental/ModelExperimental.js 1182

The light color when shading the model. When undefined the scene's light color is used instead.

Disabling additional light sources by setting model.imageBasedLighting.imageBasedLightingFactor = new Cartesian2(0.0, 0.0) will make the model much darker. Here, increasing the intensity of the light source will make the model brighter.

Default Value: undefined

maximumScale : Number
Scene/ModelExperimental/ModelExperimental.js 1322

The maximum scale size for a model. This can be used to give an upper limit to the Model#minimumPixelSize, ensuring that the model is never an unreasonable scale.

minimumPixelSize : Number
Scene/ModelExperimental/ModelExperimental.js 1301

The approximate minimum pixel size of the model regardless of zoom. This can be used to ensure that a model is visible even when the viewer zooms out. When 0.0, no minimum size is enforced.
Default Value: 0.0

pointCloudShading : PointCloudShading
Scene/ModelExperimental/ModelExperimental.js 644

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 506

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 524

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.

scale : Number
Scene/ModelExperimental/ModelExperimental.js 1261

A uniform scale applied to this model before the Model#modelMatrix. Values greater than 1.0 increase the size of the model; values less than 1.0 decrease.
Default Value: 1.0

shadows : ShadowMode
Scene/ModelExperimental/ModelExperimental.js 1343

Determines whether the model casts or receives shadows from light sources.
Default Value: ShadowMode.ENABLED

show : Boolean
Scene/ModelExperimental/ModelExperimental.js 1060

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

showCreditsOnScreen : Boolean
Scene/ModelExperimental/ModelExperimental.js 1379

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

silhouetteColor : Color
Scene/ModelExperimental/ModelExperimental.js 935

The silhouette color.
Default Value: Color.RED

silhouetteSize : Number
Scene/ModelExperimental/ModelExperimental.js 958

The size of the silhouette in pixels.
Default Value: 0.0

splitDirection : SplitDirection
Scene/ModelExperimental/ModelExperimental.js 1401

The SplitDirection to apply to this model.
Default Value: SplitDirection.NONE

style : Cesium3DTileStyle
Scene/ModelExperimental/ModelExperimental.js 859

The style to apply the to the features in the model. Cannot be applied if a CustomShader is also applied.

Methods

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

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
url String | Resource The url to the .gltf or .glb file.
basePath String | Resource '' optional The base path that paths in the glTF JSON are relative to.
show Boolean true optional Whether or not to render the model.
modelMatrix Matrix4 Matrix4.IDENTITY optional The 4x4 transformation matrix that transforms the model from model to world coordinates.
scale Number 1.0 optional A uniform scale applied to this model.
minimumPixelSize Number 0.0 optional The approximate minimum pixel size of the model regardless of zoom.
maximumScale Number optional The maximum scale size of a model. An upper limit for minimumPixelSize.
id Object optional A user-defined object to return when the model is picked with Scene#pick.
allowPicking Boolean true optional When true, each primitive is pickable with Scene#pick.
incrementallyLoadTextures Boolean true optional Determine if textures may continue to stream in after the model is loaded.
asynchronous Boolean true optional Determines if model WebGL resource creation will be spread out over several frames or block until completion once all glTF files are loaded.
clampAnimations Boolean true optional Determines if the model's animations should hold a pose over frames where no keyframes are specified.
shadows ShadowMode ShadowMode.ENABLED optional Determines whether the model casts or receives shadows from light sources.
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.
enableDebugWireframe Boolean false optional For debugging only. This must be set to true for debugWireframe to work in WebGL1. This cannot be set after the model has loaded.
debugWireframe Boolean false optional For debugging only. Draws the model in wireframe. Will only work for WebGL1 if enableDebugWireframe is set to true.
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.
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.
heightReference HeightReference HeightReference.NONE optional Determines how the model is drawn relative to terrain.
scene Scene optional Must be passed in for models that use the height reference property.
distanceDisplayCondition DistanceDisplayCondition optional The condition specifying at what distance from the camera that this model will be displayed.
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.
silhouetteColor Color Color.RED optional The silhouette color. If more than 256 models have silhouettes enabled, there is a small chance that overlapping models will have minor artifacts.
silhouetteSize Number 0.0 optional The size of the silhouette in pixels.
clippingPlanes ClippingPlaneCollection optional The ClippingPlaneCollection used to selectively disable rendering the model.
lightColor Cartesian3 optional The light color when shading the model. When undefined the scene's light color is used instead.
imageBasedLighting ImageBasedLighting optional The properties for managing image-based lighting on this model.
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.
credit Credit | String optional A credit for the data source, which is displayed on the canvas.
showCreditsOnScreen Boolean false optional Whether to display the credits of this model on screen.
splitDirection SplitDirection SplitDirection.NONE optional The SplitDirection split to apply to this model.
projectTo2D Boolean false optional Whether to accurately project the model's positions in 2D. If this is true, the model will be projected accurately to 2D, but it will use more memory to do so. If this is false, the model will use less memory and will still render in 2D / CV mode, but its positions may be inaccurate. This disables minimumPixelSize and prevents future modification to the model matrix. This also cannot be set after the model has loaded.
featureIdLabel String | Number "featureId_0" optional Label of the feature ID set to use for picking and styling. For EXT_mesh_features, this is the feature ID's label property, or "featureId_N" (where N is the index in the featureIds array) when not specified. EXT_feature_metadata did not have a label field, so such feature ID sets are always labeled "featureId_N" where N is the index in the list of all feature Ids, where feature ID attributes are listed before feature ID textures. If featureIdLabel is an integer N, it is converted to the string "featureId_N" automatically. If both per-primitive and per-instance feature IDs are present, the instance feature IDs take priority.
instanceFeatureIdLabel String | Number "instanceFeatureId_0" optional Label of the instance feature ID set used for picking and styling. If instanceFeatureIdLabel is set to an integer N, it is converted to the string "instanceFeatureId_N" automatically. 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.
Returns:
The newly created model.

applyArticulations()
Scene/ModelExperimental/ModelExperimental.js 1453

Applies any modified articulation stages to the matrix of each node that participates in any articulation. Note that this will overwrite any node transformations on participating nodes.
Throws:
  • DeveloperError : The model is not loaded. Use ModelExperimental.readyPromise or wait for ModelExperimental.ready to be true.

destroy()
Scene/ModelExperimental/ModelExperimental.js 2135

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 2115

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:

setArticulationStage(articulationStageKey, value)
Scene/ModelExperimental/ModelExperimental.js 1430

Sets the current value of an articulation stage. After setting one or multiple stage values, call ModelExperimental.applyArticulations() to cause the node matrices to be recalculated.
Name Type Description
articulationStageKey String The name of the articulation, a space, and the name of the stage.
value Number The numeric value of this stage of the articulation.
Throws:
  • DeveloperError : The model is not loaded. Use ModelExperimental.readyPromise or wait for ModelExperimental.ready to be true.
Example:
// Sets the value of the stage named "MoveX" belonging to the articulation named "SampleArticulation"
model.setArticulationStage("SampleArticulation MoveX", 50.0);
See:

update()
Scene/ModelExperimental/ModelExperimental.js 1488

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:
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.