# ModelGraphics

#### new Cesium.ModelGraphics(options)
DataSources/ModelGraphics.js 70

A 3D model based on glTF, the runtime asset format for WebGL, OpenGL ES, and OpenGL. The position and orientation of the model is determined by the containing `Entity`.

Cesium includes support for glTF geometry, materials, animations, and skinning. Cameras and lights are not currently supported.

Name | Type | Description
--- | --- | ---

`options`

Object

optional Object with the following properties:

Name | Type | Default | Description
--- | --- | --- | ---
`show` | Property | `true` | optional A boolean Property specifying the visibility of the model.
`uri` | Property |  | optional A string or Resource Property specifying the URI of the glTF asset.
`scale` | Property | `1.0` | optional A numeric Property specifying a uniform linear scale.
`minimumPixelSize` | Property | `0.0` | optional A numeric Property specifying the approximate minimum pixel size of the model regardless of zoom.
`maximumScale` | Property |  | optional The maximum scale size of a model. An upper limit for minimumPixelSize.
`incrementallyLoadTextures` | Property | `true` | optional Determine if textures may continue to stream in after the model is loaded.
`runAnimations` | Property | `true` | optional A boolean Property specifying if glTF animations specified in the model should be started.
`clampAnimations` | Property | `true` | optional A boolean Property specifying if glTF animations should hold the last pose for time durations with no keyframes.
`shadows` | Property | `ShadowMode.ENABLED` | optional An enum Property specifying whether the model casts or receives shadows from each light source.
`heightReference` | Property | `HeightReference.NONE` | optional A Property specifying what the height is relative to.
`silhouetteColor` | Property | `Color.RED` | optional A Property specifying the `Color` of the silhouette.
`silhouetteSize` | Property | `0.0` | optional A numeric Property specifying the size of the silhouette in pixels.
`color` | Property | `Color.WHITE` | optional A Property specifying the `Color` that blends with the model's rendered color.
`colorBlendMode` | Property | `ColorBlendMode.HIGHLIGHT` | optional An enum Property specifying how the color blends with the model.
`colorBlendAmount` | Property | `0.5` | optional A numeric Property specifying 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.
`imageBasedLightingFactor` | Property | `new Cartesian2(1.0, 1.0)` | optional A property specifying the contribution from diffuse and specular image-based lighting.
`lightColor` | Property |  | optional A property specifying the light color to use when shading the model. The default sun light color will be used when `undefined`.
`distanceDisplayCondition` | Property |  | optional A Property specifying at what distance from the camera that this model will be displayed.
`nodeTransformations` | PropertyBag |  | optional An object, where keys are names of nodes, and values are `TranslationRotationScale` Properties describing the transformation to apply to that node. The transformation is applied after the node's existing transformation as specified in the glTF, and does not replace the node's existing transformation.
`articulations` | PropertyBag |  | optional An object, where keys are composed of an articulation name, a single space, and a stage name, and the values are numeric properties.
`clippingPlanes` | Property |  | optional A property specifying the `ClippingPlaneCollection` used to selectively disable rendering the model.

##### Demo:

- Cesium Sandcastle 3D Models Demo

##### See:

- 3D Models Tutorial

### Members

#### articulations : PropertyBag
DataSources/ModelGraphics.js 295

Gets or sets the set of articulation values to apply to this model. This is represented as an `PropertyBag`, where keys are composed as the name of the articulation, a single space, and the name of the stage.

#### clampAnimations : Property
DataSources/ModelGraphics.js 198

Gets or sets the boolean Property specifying if glTF animations should hold the last pose for time durations with no keyframes.

Default Value: `true`

#### clippingPlanes : Property
DataSources/ModelGraphics.js 302

A property specifying the `ClippingPlaneCollection` used to selectively disable rendering the model.

#### color : Property
DataSources/ModelGraphics.js 239

Gets or sets the Property specifying the `Color` that blends with the model's rendered color.

Default Value: `Color.WHITE`

#### colorBlendAmount : Property
DataSources/ModelGraphics.js 257

A numeric Property specifying 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 : Property
DataSources/ModelGraphics.js 247

Gets or sets the enum Property specifying how the color blends with the model.

Default Value: `ColorBlendMode.HIGHLIGHT`

#### readonlydefinitionChanged : Event
DataSources/ModelGraphics.js 125

Gets the event that is raised whenever a property or sub-property is changed or modified.

#### distanceDisplayCondition : Property
DataSources/ModelGraphics.js 278

Gets or sets the `DistanceDisplayCondition` Property specifying at what distance from the camera that this model will be displayed.

#### heightReference : Property
DataSources/ModelGraphics.js 215

Gets or sets the Property specifying the `HeightReference`.

Default Value: `HeightReference.NONE`

#### imageBasedLightingFactor : Property
DataSources/ModelGraphics.js 264

A property specifying the `Cartesian2` used to scale the diffuse and specular image-based lighting contribution to the final color.

#### incrementallyLoadTextures : Property
DataSources/ModelGraphics.js 182

Get or sets the boolean Property specifying whether textures may continue to stream in after the model is loaded.

#### lightColor : Property
DataSources/ModelGraphics.js 271

A property specifying the `Cartesian3` color of the light source when shading the model.

#### maximumScale : Property
DataSources/ModelGraphics.js 174

Gets or sets the numeric Property specifying the maximum scale size of a model. This property is used as an upper limit for `ModelGraphics#minimumPixelSize`.

#### minimumPixelSize : Property
DataSources/ModelGraphics.js 165

Gets or sets the numeric Property specifying 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`

#### nodeTransformations : PropertyBag
DataSources/ModelGraphics.js 287

Gets or sets the set of node transformations to apply to this model. This is represented as an `PropertyBag`, where keys are names of nodes, and values are `TranslationRotationScale` Properties describing the transformation to apply to that node. The transformation is applied after the node's existing transformation as specified in the glTF, and does not replace the node's existing transformation.

#### runAnimations : Property
DataSources/ModelGraphics.js 190

Gets or sets the boolean Property specifying if glTF animations should be run.

Default Value: `true`

#### scale : Property
DataSources/ModelGraphics.js 154

Gets or sets the numeric Property specifying a uniform linear scale for this model. Values greater than 1.0 increase the size of the model while values less than 1.0 decrease it.

Default Value: `1.0`

#### shadows : Property
DataSources/ModelGraphics.js 207

Get or sets the enum Property specifying whether the model casts or receives shadows from each light source.

Default Value: `ShadowMode.ENABLED`

#### show : Property
DataSources/ModelGraphics.js 137

Gets or sets the boolean Property specifying the visibility of the model.

Default Value: `true`

#### silhouetteColor : Property
DataSources/ModelGraphics.js 223

Gets or sets the Property specifying the `Color` of the silhouette.

Default Value: `Color.RED`

#### silhouetteSize : Property
DataSources/ModelGraphics.js 231

Gets or sets the numeric Property specifying the size of the silhouette in pixels.

Default Value: `0.0`

#### uri : Property
DataSources/ModelGraphics.js 144

Gets or sets the string Property specifying the URI of the glTF asset.

### Methods

#### clone(result) → ModelGraphics
DataSources/ModelGraphics.js 311

Duplicates this instance.

Name | Type | Description
--- | --- | ---
`result` | ModelGraphics | optional The object onto which to store the result.

##### Returns:

The modified result parameter or a new instance if one was not provided.

#### merge(source)
DataSources/ModelGraphics.js 344

Assigns each unassigned property on this object to the value of the same property on the provided source object.

Name | Type | Description
--- | --- | ---
`source` | ModelGraphics | The object to be merged into this object.