ObjectSymbol3DLayer

// symbol using a cylinder as a resource
const symbol = {
  type: "point-3d",  // autocasts as new PointSymbol3D()
  symbolLayers: [{
    type: "object",  // autocasts as new ObjectSymbol3DLayer()
    width: 5,  // diameter of the object from east to west in meters
    height: 20,  // height of the object in meters
    depth: 15,  // diameter of the object from north to south in meters
    resource: { primitive: "cylinder" },
    material: { color: "red" }
  }]
};

// symbol using a glTF 3D model as a resource
const symbol = {
  type: "point-3d",  // autocasts as new PointSymbol3D()
  symbolLayers: [{
    type: "object",  // autocasts as new ObjectSymbol3DLayer()
    resource: {
      href: "../3d-assets/model.gltf"
    },
    height: 3,
    material: {
      color: "red"
    }
  }
};

属性概述

属性详细信息

anchor String

符号相对于几何的位置。默认行为 (origin) 取决于资源：

• 对于 sphere、cube 和 diamond 基元，原点位于中心。
• 对于 cylinder、cone、inverted-cone 和 tetrahedron 基元，原点位于底部。
• 对于 href 资源，原点与 3D 模型的原点一致。

如果 anchor 设置为 relative，则锚点由 anchorPosition 定义为符号边界框的一小部分。

可能值："center"|"top"|"bottom"|"origin"|"relative"

默认值：origin

anchorPosition Object

起始版本：GeoScene Maps SDK for JavaScript 4.10

定义相对于符号图层资源中心的 anchor。将其指定为资源边界框尺寸的比率。例如，{ x: 0, y: 0, z: 0 } 值表示中心，而 { x: -0.5, y: -0.5, z: -0.5 } 值将符号置于符号边界框的左下角。

仅当 anchor 设置为 relative 时，此属性才适用。

属性

x Number 用于定义相对于边界框的 x 轴位置的值。

y Number 用于定义相对于边界框的 y 轴位置的值。

z Number 用于定义相对于边界框的 z 轴位置的值。

示例

symbolLayer.anchor = "relative";
symbolLayer.anchorPosition = { x: 0, y: 0, z: -0.5 }; // equivalent to `anchor: "bottom"`

symbolLayer.anchor = "relative";
symbolLayer.anchorPosition = { x: 1.5, y: 1, z: 0 }; // the anchor can be placed outside of the symbol's bounding box

castShadows Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.11

表示符号图层几何是否在场景中投射阴影。将此属性设置为 false 将禁用符号图层的阴影，即使在 SceneView.environment 中启用了直接阴影也是如此。

默认值：true

示例

// disables shadow casting
symbolLayer.castShadows = false;

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

类的名称。声明的类名称格式化为 geoscene.folder.className。

depth Number

对象的深度或从北到南的直径，以米为单位。如果为 undefined，则将计算深度以保持对象的原始比例。

默认值：10

示例

// depth of the symbol in meters
symbolLayer.depth = 5000;

heading Number

符号在水平面中的顺时针旋转 (即围绕 z 轴)。旋转以度为单位指定，并且相对于 y 轴。

如果符号资源是对齐的，其前向侧指向 y 轴方向 (y 轴在 WGS84 或 WebMercator 坐标中始终指向北)，其向上侧指向 z 轴方向，其右侧指向 x 轴方向 (x 轴在 WGS84 或 WebMercator 坐标中始终指向东)，则此角度对应于符号的标题。

示例

// heading of the symbol in degrees
symbolLayer.heading = 180;

height Number

对象的高度，以米为单位。如果为 undefined，则将计算高度以保持对象的原始比例。

默认值：10

示例

// height of the symbol in meters
symbolLayer.height = 1000;

material Objectautocast

用于为对象着色的材质。此属性定义对象的颜色。

属性

color Color optional 默认值：white 自动转换自 Object|Number[]|String 对象的填充色。如果对象具有纹理，则纹理将与颜色相乘。这可以通过 rgb(a) 值数组、命名字符串、十六进制字符串或 hsl(a) 字符串、具有 r, g, b 和 a 属性的对象或 Color 对象进行自动转换。

示例

// CSS color string
symbolLayer.material = {
  color: "dodgerblue"
};

// HEX string
symbolLayer.material = {
  color: "#33cc33";
}

// array of RGBA values
symbolLayer.material = {
  color: [51, 204, 51, 0.3];
}

// object with rgba properties
symbolLayer.material = {
  color: {
    r: 51,
    g: 51,
    b: 204,
    a: 0.7
  }
};

resource Object

用于可视化点的基元形状 (primitive) 或外部 3D 模型 (href)。如果两个属性均存在，则优先 primitive 并忽略 href。使用 href 属性时，外部 3D 模型必须以 glTF 格式存在。

属性

primitive String optional 使用内置形状。有关可能的值，请参见下表。 值 描述 sphere cylinder cube cone inverted-cone diamond tetrahedron

href String optional glTF 格式的 3D 模型的 URL。URL 应指向 glTF 文件 (.gltf 或 .glb)，该文件可引用其他二进制文件 (.bin) 和图像文件 (.jpg, .png)。请参阅有关使用 3D 符号可视化点的指南主题，以了解如何使用自定义 3D 模型。

默认值：{ primitive: "sphere" }

roll Number

起始版本：GeoScene Maps SDK for JavaScript 4.4

符号在横向垂直平面中的旋转 (即围绕 y 轴)。旋转以度为单位指定，并且相对于 x 轴。为 0 度时，模型是水平的。正值提升模型的左侧部分并降低右侧部分。

如果符号资源是对齐的，其前向侧指向 y 轴方向 (y 轴在 WGS84 或 WebMercator 坐标中始终指向北)，其向上侧指向 z 轴方向，其右侧指向 x 轴方向 (x 轴在 WGS84 或 WebMercator 坐标中始终指向东)，则此角度对应于符号的滚动。

示例

// roll of the symbol in degrees
symbolLayer.roll = 90;

tilt Number

起始版本：GeoScene Maps SDK for JavaScript 4.4

符号在纵向垂直平面中的旋转 (即围绕 x 轴)。旋转以度为单位指定，并且相对于 y 轴。为 0 度时，模型是水平的。正值点将提升模型的前端并降低模型的背面。

如果符号资源是对齐的，其前向侧指向 y 轴方向 (y 轴在 WGS84 或 WebMercator 坐标中始终指向北)，其向上侧指向 z 轴方向，其右侧指向 x 轴方向 (x 轴在 WGS84 或 WebMercator 坐标中始终指向东)，则此角度对应于符号的倾斜度。

示例

// tilt of the symbol in degrees
symbolLayer.tilt = 45;

type Stringreadonly

对象类型。

对于 ObjectSymbol3DLayer，类型总是 "object"。

width Number

对象的宽度或从东到西的直径，以米为单位。如果为 undefined，则将计算宽度以保持对象的原始比例。

默认值：10

示例

// width of the symbol in meters
symbolLayer.width = 5000;

方法概述

方法详细说明

addHandles(handleOrHandles, groupKey)inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

添加一个或多个与对象的生命周期相关联的句柄。当对象被销毁时，将移除句柄。

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);

参数

handleOrHandles WatchHandle|WatchHandle[] 对象销毁后，标记为要移除的句柄。

groupKey * optional 标识句柄应添加到的组的键。组中的所有句柄稍后都可使用 Accessor.removeHandles() 进行删除。如果未提供键，则句柄将被添加到默认组。

clone(){ObjectSymbol3DLayer}

创建符号图层的深度克隆。

返回

类型	描述
ObjectSymbol3DLayer	调用此方法的对象的深度克隆。

示例

// Creates a deep clone of the graphic's first symbol layer
let symLyr = graphic.symbol.symbolLayers.getItemAt(0).clone();

fromJSON(json){*}static

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。传入到输入 json 参数的对象通常来自对 REST API 中查询操作的响应或来自另一个 GeoScene 产品的 toJSON() 方法。有关何时以及如何使用该函数的详细信息和示例，请参阅指南中的使用 fromJSON() 主题。

参数

json Object GeoScene 格式实例的 JSON 表示。有关各种输入 JSON 对象的结构示例，请参阅 GeoScene REST API 文档。

返回

类型	描述
*	返回该类的新实例。

hasHandles(groupKey){Boolean}inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

如果存在指定的句柄组，则返回 true。

参数

groupKey * optional 组键。

返回

类型	描述
Boolean	如果存在指定的句柄组，则返回 true。

示例

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles(groupKey)inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

移除对象拥有的句柄组。

参数

groupKey * optional 要移除的组键或组键的数组或集合。

示例

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON(){Object}inherited

将此类的实例转换为 GeoScene Portal JSON 表示。有关详细信息，请参阅使用 fromJSON() 指南主题。

返回

类型	描述
Object	此类实例的 GeoScene Portal JSON 表示。