基于 glTF(WebGL、OpenGL ES 和 OpenGL 的运行时资源格式)的 3D 模型。
模型的位置和朝向由其所在的
Entity 决定。
Cesium 支持 glTF 的几何体、材质、动画和蒙皮。 目前不支持相机和光照。
| Name | Type | Description |
|---|---|---|
options |
ModelGraphics.ConstructorOptions | optional 描述初始化选项的对象。 |
Members
articulations : PropertyBag
获取或设置要应用于此模型的一组关节(articulation)值。它表示为一个
PropertyBag,其中键由
关节名称、一个空格和阶段(stage)名称组合而成。
clampAnimations : Property|undefined
获取或设置布尔型 Property,指定在没有关键帧的时间段内,glTF 动画是否应保持最后一帧姿态。
-
Default Value:
true
clippingPlanes : Property|undefined
指定用于有选择地禁用模型渲染的
ClippingPlaneCollection 的属性。
color : Property|undefined
获取或设置指定与模型渲染颜色混合的
Color 的 Property。
-
Default Value:
Color.WHITE
colorBlendAmount : Property|undefined
当
colorBlendMode 为 MIX 时,指定颜色强度的数值型 Property。
值为 0.0 时呈现模型的渲染颜色,值为 1.0 时呈现纯色,
介于两者之间的任何值都会产生两者的混合。
-
Default Value:
0.5
colorBlendMode : Property|undefined
获取或设置指定颜色如何与模型混合的枚举型 Property。
-
Default Value:
ColorBlendMode.HIGHLIGHT
customShader : Property|undefined
获取或设置要应用于此模型的
CustomShader。当为 undefined 时,不使用自定义着色器代码。
readonly definitionChanged : Event
获取在任意属性或子属性被更改或修改时触发的事件。
distanceDisplayCondition : Property|undefined
获取或设置
DistanceDisplayCondition Property,指定模型将在距相机多远处显示。
enableVerticalExaggeration : Property|undefined
获取或设置布尔型 Property,指定当
Scene.verticalExaggeration 被设置为 1.0 以外的值时,模型是否沿椭球法线方向被放大。
-
Default Value:
true
environmentMapOptions : PropertyBag
获取或设置要应用于此模型的
DynamicEnvironmentMapManager.ConstructorOptions。它表示为一个 PropertyBag。
heightReference : Property|undefined
获取或设置指定
HeightReference 的 Property。
-
Default Value:
HeightReference.NONE
imageBasedLightingFactor : Property|undefined
指定用于缩放漫反射和镜面反射基于图像的照明对最终颜色贡献的
Cartesian2 的属性。
incrementallyLoadTextures : Property|undefined
获取或设置布尔型 Property,指定在模型加载后
纹理是否可继续流入(stream in)。
lightColor : Property|undefined
指定对模型进行着色时使用的
Cartesian3 光照颜色的属性。当为 undefined 时,改为使用场景的光照颜色。
maximumScale : Property|undefined
获取或设置指定模型最大缩放
尺寸的 numeric Property。该属性用作
ModelGraphics#minimumPixelSize 的上限。
minimumPixelSize : Property|undefined
获取或设置指定模型近似最小
像素尺寸的 numeric Property,与缩放无关。这可用于确保
即使 viewer 缩小,模型也可见。当为
0.0 时,
不强制最小尺寸。
-
Default Value:
0.0
nodeTransformations : PropertyBag
获取或设置要应用于此模型的一组节点变换。它表示为一个
PropertyBag,其中键是
节点名称,值是描述要应用于该节点的变换的 TranslationRotationScale Property。
该变换在 glTF 中指定的节点现有变换之后应用,并不会替换节点的现有变换。
runAnimations : Property|undefined
获取或设置布尔型 Property,指定是否应运行 glTF 动画。
-
Default Value:
true
scale : Property|undefined
获取或设置指定此模型均匀线性缩放
的 numeric Property。大于 1.0 的值会增大模型尺寸,
而小于 1.0 的值会减小尺寸。
-
Default Value:
1.0
shadows : Property|undefined
获取或设置枚举型 Property,指定模型
是否投射或接收来自光源的阴影。
-
Default Value:
ShadowMode.ENABLED
show : Property|undefined
获取或设置指定模型可见性的布尔型 Property。
-
Default Value:
true
silhouetteColor : Property|undefined
获取或设置指定轮廓(silhouette)
Color 的 Property。
-
Default Value:
Color.RED
silhouetteSize : Property|undefined
获取或设置指定轮廓像素大小的 numeric Property。
-
Default Value:
0.0
uri : Property|undefined
获取或设置指定 glTF 资源 URI 的字符串型 Property。
Methods
clone(result) → ModelGraphics
复制此实例。
| Name | Type | Description |
|---|---|---|
result |
ModelGraphics | optional 用于存储结果的物体。 |
Returns:
修改后的结果参数;如果未提供,则为新实例。
将此对象上每个未赋值的属性赋值为
所提供的源对象上相同属性的值。
| Name | Type | Description |
|---|---|---|
source |
ModelGraphics | 要合并到此对象中的对象。 |
Type Definitions
ModelGraphics 构造函数的初始化选项。
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
show |
Property | boolean |
<optional> |
true | 指定模型可见性的布尔型 Property。 |
uri |
Property | string | Resource |
<optional> |
指定 glTF 资源 URI 的字符串或 Resource Property。 | |
scale |
Property | number |
<optional> |
1.0 | 指定均匀线性缩放的 numeric Property。 |
enableVerticalExaggeration |
Property | boolean |
<optional> |
true | 布尔型 Property,指定当 Scene.verticalExaggeration 被设置为 1.0 以外的值时,模型是否沿椭球法线方向被放大。 |
minimumPixelSize |
Property | number |
<optional> |
0.0 | 指定模型近似最小像素尺寸的 numeric Property,与缩放无关。 |
maximumScale |
Property | number |
<optional> |
模型的最大缩放尺寸。minimumPixelSize 的上限。 | |
incrementallyLoadTextures |
Property | boolean |
<optional> |
true | 确定纹理在模型加载后是否可继续流入。 |
runAnimations |
Property | boolean |
<optional> |
true | 布尔型 Property,指定模型中指定的 glTF 动画是否应启动。 |
clampAnimations |
Property | boolean |
<optional> |
true | 布尔型 Property,指定在没有关键帧的时间段内,glTF 动画是否应保持最后一帧姿态。 |
shadows |
Property | ShadowMode |
<optional> |
ShadowMode.ENABLED | 枚举型 Property,指定模型是否投射或接收来自光源的阴影。 |
heightReference |
Property | HeightReference |
<optional> |
HeightReference.NONE | 指定高度相对基准的 Property。 |
silhouetteColor |
Property | Color |
<optional> |
Color.RED | 指定轮廓 Color 的 Property。 |
silhouetteSize |
Property | number |
<optional> |
0.0 | 指定轮廓像素大小的 numeric Property。 |
color |
Property | Color |
<optional> |
Color.WHITE | 指定与模型渲染颜色混合的 Color 的 Property。 |
colorBlendMode |
Property | ColorBlendMode |
<optional> |
ColorBlendMode.HIGHLIGHT | 枚举型 Property,指定颜色如何与模型混合。 |
colorBlendAmount |
Property | number |
<optional> |
0.5 | 当 colorBlendMode 为 MIX 时,指定颜色强度的 numeric Property。值为 0.0 时呈现模型的渲染颜色,值为 1.0 时呈现纯色,介于两者之间的任何值都会产生两者的混合。 |
imageBasedLightingFactor |
Property | Cartesian2 |
<optional> |
new Cartesian2(1.0, 1.0) | 指定来自漫反射和镜面反射基于图像的照明的贡献的属性。 |
environmentMapOptions |
PropertyBag | Object.<string, *> |
<optional> |
用于管理此实体上动态环境贴图的属性。 | |
lightColor |
Property | Color |
<optional> |
指定对模型着色时光照颜色的属性。当为 undefined 时,改为使用场景的光照颜色。 |
|
distanceDisplayCondition |
Property | DistanceDisplayCondition |
<optional> |
指定模型将在距相机多远处显示的 Property。 | |
nodeTransformations |
PropertyBag | Object.<string, TranslationRotationScale> |
<optional> |
一个对象,其中键是节点名称,值是描述要应用于该节点的变换的 TranslationRotationScale Property。该变换在 glTF 中指定的节点现有变换之后应用,并不会替换节点的现有变换。 |
|
articulations |
PropertyBag | Object.<string, number> |
<optional> |
一个对象,其中键由关节名称、一个空格和阶段名称组成,值为 numeric 属性。 | |
clippingPlanes |
Property | ClippingPlaneCollection |
<optional> |
指定用于有选择地禁用模型渲染的 ClippingPlaneCollection 的属性。 |
|
customShader |
Property | CustomShader |
<optional> |
指定要应用于此模型的 CustomShader 的属性。 |
