Class: Model

Members

readonly activeAnimationsModelAnimationCollection

当前正在播放的glTF动画。

backFaceCullingboolean

是否剔除背面几何体。当为true时，背面剔除由材质的doubleSided属性确定； 当为false时，禁用背面剔除。如果 Model#color 是半透明的或 Model#silhouetteSize 大于0.0，则不剔除背面。

Default Value:

true

Example

const origin = SuperMap3D.Cartesian3.fromDegrees(-95.0, 40.0, 200000.0);
m.modelMatrix = SuperMap3D.Transforms.eastNorthUpToFixedFrame(origin);

Methods

static fromGltfAsync(options){Promise.<Model>}

从glTF资源异步创建模型。此函数返回一个Promise，当模型准备好渲染时， 即外部二进制文件、图像和着色器文件已下载且WebGL资源已创建时，该Promise将解析。

模型可以是具有.gltf扩展名的传统glTF资源，也可以是使用.glb扩展名的二进制glTF。

Name	Type	Description
options	object	具有以下属性的对象： Name Type Default Description url string | Resource .gltf或.glb文件的url。 basePath string | Resource '' 可选 glTF JSON中的路径相对于的基本路径。 show boolean true 可选 是否渲染模型。 modelMatrix Matrix4 Matrix4.IDENTITY 可选 将模型从模型坐标转换为世界坐标的4x4变换矩阵。 scale number 1.0 可选 应用于此模型的统一缩放。 minimumPixelSize number 0.0 可选 忽略缩放，模型的近似最小像素大小。 maximumScale number 可选 模型的最大缩放大小。是minimumPixelSize的上限。 id object 可选 当使用 Scene#pick 拾取模型时返回的用户定义对象。 allowPicking boolean true 可选 当为 true 时，每个图元都可以使用 Scene#pick 进行拾取。 incrementallyLoadTextures boolean true 可选 确定模型加载后纹理是否可以继续流式传输。 asynchronous boolean true 可选 确定模型WebGL资源创建是分散在几帧中完成，还是在所有glTF文件加载后立即阻塞直到完成。 clampAnimations boolean true 可选 确定模型的动画是否应在没有指定关键帧的帧之间保持姿势。 shadows ShadowMode ShadowMode.ENABLED 可选 确定模型是否投射或接收来自光源的阴影。 releaseGltfJson boolean false 可选 当为true时，一旦glTF加载完成，就会释放glTF JSON。这对于3D Tiles之类的情况特别有用，其中每个.gltf模型都是唯一的，缓存glTF JSON没有效果。 debugShowBoundingVolume boolean false 可选 仅用于调试。为模型中的每个绘制命令绘制包围球。 enableDebugWireframe boolean false 可选 仅用于调试。必须将其设置为true才能在WebGL1中使用debugWireframe。无法在模型加载后设置此属性。 debugWireframe boolean false 可选 仅用于调试。以线框形式绘制模型。如果enableDebugWireframe设置为true，则仅在WebGL1中工作。 cull boolean true 可选 是否使用视锥体/地平线剔除来剔除模型。如果模型是3D Tiles瓦片集的一部分，则此属性将始终为false，因为使用了3D Tiles剔除系统。 opaquePass boolean Pass.OPAQUE 可选 用于模型不透明部分的 DrawCommand 中的通道。 upAxis Axis Axis.Y 可选 glTF模型的向上轴。 forwardAxis Axis Axis.Z 可选 glTF模型的向前轴。 customShader CustomShader 可选 自定义着色器。这将向顶点和片段着色器添加用户定义的GLSL代码。将自定义着色器与 Cesium3DTileStyle 一起使用可能会导致未定义的行为。 content Cesium3DTileContent 可选 此模型所属的瓦片内容。如果模型未作为瓦片集的一部分加载，则此属性将为undefined。 heightReference HeightReference HeightReference.NONE 可选 确定模型相对于地形的绘制方式。 scene Scene 可选 对于使用高度参考属性的模型，必须传入此项。 distanceDisplayCondition DistanceDisplayCondition 可选 指定此模型将在距离相机多远的距离显示的条件。 color Color 可选 与模型渲染颜色混合的颜色。 colorBlendMode ColorBlendMode ColorBlendMode.HIGHLIGHT 可选 定义颜色如何与模型混合。 colorBlendAmount number 0.5 可选 当 colorBlendMode 为 MIX 时用于确定颜色强度的值。值为0.0时产生模型的渲染颜色，值为1.0时产生纯色，中间值产生两者的混合。 silhouetteColor Color Color.RED 可选 轮廓颜色。如果超过256个模型启用了轮廓，则重叠的模型有很小的机会出现轻微的伪影。 silhouetteSize number 0.0 可选 轮廓的大小（以像素为单位）。 enableShowOutline boolean true 可选 是否为使用CESIUM_primitive_outline扩展的模型启用轮廓。可以将其设置为false以避免在加载时额外处理几何体。当为false时，showOutlines和outlineColor选项将被忽略。 showOutline boolean true 可选 是否为使用CESIUM_primitive_outline扩展的模型显示轮廓。当为true时，显示轮廓。当为false时，不显示轮廓。 outlineColor Color Color.BLACK 可选 渲染轮廓时使用的颜色。 clippingPlanes ClippingPlaneCollection 可选 用于选择性地禁用模型渲染的 ClippingPlaneCollection。 lightColor Cartesian3 可选 着色模型时的光源颜色。当为 undefined 时，改用场景的光源颜色。 imageBasedLighting ImageBasedLighting 可选 用于管理此模型上基于图像的光照的属性。 backFaceCulling boolean true 可选 是否剔除背面几何体。当为true时，背面剔除由材质的doubleSided属性确定；当为false时，禁用背面剔除。如果模型的颜色是半透明的，则不剔除背面。 credit Credit | string 可选 数据源的版权信息，显示在画布上。 showCreditsOnScreen boolean false 可选 是否在屏幕上显示此模型的版权信息。 splitDirection SplitDirection SplitDirection.NONE 可选 应用于此模型的 SplitDirection 分割。 projectTo2D boolean false 可选 是否在2D中准确投影模型的位置。如果为true，模型将准确投影到2D，但会使用更多内存。如果为false，模型将使用更少内存，仍将在2D/CV模式下渲染，但其位置可能不准确。这会禁用minimumPixelSize并阻止将来对模型矩阵的修改。也无法在模型加载后设置此属性。 enablePick boolean false 可选 是否允许在不使用WebGL 2或更高版本时使用pick进行CPU拾取。如果使用WebGL 2或更高版本，此选项将被忽略。如果使用WebGL 1且此项为true，则pick操作将正常工作，但会使用更多内存。如果在WebGL 1下运行且此项为false，则模型将使用更少内存，但pick将始终返回undefined。无法在模型加载后设置此属性。 featureIdLabel string | number "featureId_0" 可选 用于拾取和样式化的要素ID集的标签。对于EXT_mesh_features，这是要素ID的label属性，未指定时为"featureId_N"（其中N是featureIds数组中的索引）。EXT_feature_metadata没有标签字段，因此此类要素ID集始终标记为"featureId_N"，其中N是所有要素ID列表中的索引，其中要素ID属性列在要素ID纹理之前。如果featureIdLabel是整数N，则会自动转换为字符串"featureId_N"。如果同时存在每个图元和每个实例的要素ID，则实例要素ID优先。 instanceFeatureIdLabel string | number "instanceFeatureId_0" 可选 用于拾取和样式化的实例要素ID集的标签。如果instanceFeatureIdLabel设置为整数N，则会自动转换为字符串"instanceFeatureId_N"。如果同时存在每个图元和每个实例的要素ID，则实例要素ID优先。 pointCloudShading object 可选 用于构造 PointCloudShading 对象的选项，以控制点衰减和光照。 classificationType ClassificationType 可选 确定此模型将对地形、3D Tiles还是两者进行分类。无法在模型加载后设置此属性。 gltfCallback Model.GltfCallback 可选 加载后调用已加载gltf对象的函数。

Throws:

• 模型加载失败。

  Type

  RuntimeError

• 不支持的glTF版本。

  Type

  RuntimeError

• 不支持的glTF扩展。

  Type

  RuntimeError

Returns:

Type	Description
Promise.<Model>	一个Promise，当创建的模型准备好渲染时，它将解析为该模型。

Examples

// 加载模型并将其添加到场景中
try {
 const model = await SuperMap3D.Model.fromGltfAsync({
   url: "./duck/duck.glb"
 });
 viewer.scene.primitives.add(model);
} catch (error) {
 console.log(`模型加载失败。${error}`);
}

// 使用modelMatrix定位模型，并以128像素的最小大小显示
const position = SuperMap3D.Cartesian3.fromDegrees(
  -123.0744619,
  44.0503706,
  5000.0
);
const headingPositionRoll = new SuperMap3D.HeadingPitchRoll();
const fixedFrameTransform = SuperMap3D.Transforms.localFrameToFixedFrameGenerator(
  "north",
  "west"
);
try {
 const model = await SuperMap3D.Model.fromGltfAsync({
   url: "./duck/duck.glb",
   modelMatrix: SuperMap3D.Transforms.headingPitchRollToFixedFrame(
     position,
     headingPositionRoll,
     SuperMap3D.Ellipsoid.WGS84,
     fixedFrameTransform
   ),
   minimumPixelSize: 128,
 });
 viewer.scene.primitives.add(model);
} catch (error) {
 console.log(`模型加载失败。${error}`);
}

// 加载模型并以半速播放最后一个动画
let animations;
try {
 const model = await SuperMap3D.Model.fromGltfAsync({
   url: "./duck/duck.glb",
   gltfCallback: gltf => {
     animations = gltf.animations
   }
 });
 viewer.scene.primitives.add(model);
 model.readyEvent.addEventListener(() => {
   model.activeAnimations.add({
     index: animations.length - 1,
     loop: SuperMap3D.ModelAnimationLoop.REPEAT,
     multiplier: 0.5,
   });
 });
} catch (error) {
 console.log(`模型加载失败。${error}`);
}

applyArticulations()

将任何已修改的关节阶段应用于参与任何关节的每个节点的矩阵。 请注意，这将覆盖参与节点上的任何节点变换。

Throws:

模型未加载。使用Model.readyEvent或等待Model.ready为true。

Type

DeveloperError

destroy()

销毁此对象持有的WebGL资源。销毁对象允许以确定性的方式释放WebGL资源， 而不是依赖垃圾收集器来销毁此对象。

一旦对象被销毁，就不应再使用它；调用除 isDestroyed 以外的 任何函数将导致 DeveloperError 异常。因此， 像示例中那样将返回值 (undefined) 分配给对象。

See:

• Model#isDestroyed

Throws:

此对象已被销毁，即已调用destroy()。

Type

DeveloperError

Example

model = model && model.destroy();

getNode(name){ModelNode}

返回glTF中具有给定 name 的节点。这用于修改节点的变换以进行用户定义的动画。

Name	Type	Description
name	string	glTF中节点的名称。

Throws:

模型未加载。使用Model.readyEvent或等待Model.ready为true。

Type

DeveloperError

Returns:

Type	Description
ModelNode	节点，如果不存在具有 name 的节点，则返回 undefined。

Example

// 对节点"Hand"应用非统一缩放
const node = model.getNode("Hand");
node.matrix = SuperMap3D.Matrix4.fromScale(new SuperMap3D.Cartesian3(5.0, 1.0, 1.0), node.matrix);

isDestroyed(){boolean}

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.

See:

• Model#destroy

Returns:

Type	Description
boolean	true if this object was destroyed; otherwise, false.

makeStyleDirty()

将模型的 Model#style 标记为脏，这会强制所有要素 在模型可见的下一帧中重新评估样式。

setArticulationStage(articulationStageKey, value)

设置关节阶段的当前值。在设置一个或多个阶段值后， 调用Model.applyArticulations()以重新计算节点矩阵。

Name	Type	Description
articulationStageKey	string	关节名称，一个空格，以及阶段名称。
value	number	此关节阶段的数值。

See:

• Model#applyArticulations

Throws:

模型未加载。使用Model.readyEvent或等待Model.ready为true。

Type

DeveloperError

Example

// 设置属于名为"SampleArticulation"的关节的名为"MoveX"的阶段的值
model.setArticulationStage("SampleArticulation MoveX", 50.0);

Type Definitions

GltfCallback(gltf)

加载完成后使用已加载的gltf对象调用的函数的接口。

Name	Type	Description
gltf	object	gltf对象