Model

This page describes the possible content of a CZML document or stream. Please read CZML Structure for an explanation of how a CZML document is put together.

Model

A 3D model.

Interpolatable: no

Properties

show - Boolean

Whether or not the model is shown.

Default: true

gltf - Uri - Required

The URI of a glTF model. For broadest client compatibility, the URI should be accessible via Cross-Origin Resource Sharing (CORS). The URI may also be a data URI.

scale - Double

The scale of the model.

Default: 1.0

minimumPixelSize - Double

The approximate minimum pixel size of the model regardless of zoom.

Default: 0.0

maximumScale - Double

The maximum scale size of the model. This is used as an upper limit for minimumPixelSize.

incrementallyLoadTextures - Boolean

Whether or not the model can be rendered before all textures have loaded.

Default: true

runAnimations - Boolean

Whether or not to run all animations defined in the glTF model.

Default: true

shadows - ShadowMode

Whether or not the model casts or receives shadows.

Default: ENABLED

heightReference - HeightReference

The height reference of the model, which indicates if the position is relative to terrain or not.

Default: NONE

silhouetteColor - Color

The color of the silhouette drawn around the model.

Default: red

silhouetteSize - Double

The size, in pixels, of the silhouette drawn around the model.

Default: 0.0

color - Color

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

Default: white

colorBlendMode - ColorBlendMode

The mode to use for blending between color and the model's color.

Default: HIGHLIGHT

colorBlendAmount - Double

The color strength when 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: 0.5

distanceDisplayCondition - DistanceDisplayCondition

The display condition specifying at what distance from the camera this model will be displayed.

nodeTransformations - NodeTransformations

A mapping of node names to node transformations.

Examples:

{
    "model": {
        "gltf": "example.gltf",
        "nodeTransformations": {
            "node1": {
                "scale": {
                    "cartesian": [
                        1.0, 2.0, 3.0
                    ]
                },
                "rotation": {
                    "unitQuaternion": [
                        0.0, 0.0, 0.0, 1.0
                    ]
                },
                "translation": {
                    "cartesian": [
                        4.0, 5.0, 6.0
                    ]
                }
            },
            "node2": {
                "scale": {
                    "epoch": "2012-04-02T12:00:00Z",
                    "cartesian": [
                        0.0, 1.0, 2.0, 3.0,
                        60.0, 10.0, 12.0, 14.0
                    ]
                }
            }
        }
    }
}

articulations - Articulations

A mapping of keys to articulation values, where the keys are the name of the articulation, a single space, and the name of the stage.

Examples:

{
    "model": {
        "gltf": "example.gltf",
        "articulations": {
            "articulation1 stage1": 45.0,
            "articulation1 stage2": {
                "epoch": "2012-04-02T12:00:00Z",
                "number": [
                    0.0, 1.0,
                    60.0, 10.0
                ]
            }
        }
    }
}