FillSymbol3DLayer 用于在 SceneView 中渲染平面 2D Polygon 几何和 3D 体积网格的表面。MapView 不支持 3D 符号。
填充的颜色在 material 属性中设置。由于面和网格几何的性质,在此符号图层中,大小不是选项。通过将颜色视觉变量添加到使用此符号图层的任何 Renderer 中,可以对颜色进行数据驱动。
必须将 FillSymbol3DLayer 添加到 PolygonSymbol3D 或 MeshSymbol3D 的 symbolLayers
属性中。可在单个符号中使用多个符号图层。outline 属性在与 MeshSymbol3D 一起使用时没有效果。下图描述了一个面 FeatureLayer,其要素使用包含 FillSymbol3DLayer 的 PolygonSymbol3D 进行符号化。
请参阅 Symbol3DLayer 和 Symbol3D 以阅读有关 3D 符号、符号图层及其相互关系的更多常规信息。
const symbol = {
type: "polygon-3d", // autocasts as new PolygonSymbol3D()
symbolLayers: [{
type: "fill", // autocasts as new FillSymbol3DLayer()
material: { color: "red" }
}]
};
构造函数
属性概述
名称 | 类型 | 描述 | 类 |
---|---|---|---|
Boolean | 表示符号图层几何是否在场景中投射阴影。 更多详情 | FillSymbol3DLayer | |
String | 类的名称。 更多详情 | Accessor | |
Edges3D | 设置 3D 对象上的轮廓边缘。 更多详情 | FillSymbol3DLayer | |
Object | 材质通过将材质中设置的 | FillSymbol3DLayer | |
Object | 用于在填充几何周围绘制线的轮廓。 更多详情 | FillSymbol3DLayer | |
StylePattern3D | 用于渲染多边形填充的图案。 更多详情 | FillSymbol3DLayer | |
String | 符号类型。 更多详情 | FillSymbol3DLayer |
属性详细信息
-
castShadows Boolean起始版本:GeoScene Maps SDK for JavaScript 4.11
-
表示符号图层几何是否在场景中投射阴影。将此属性设置为
false
将禁用符号图层的阴影,即使在 SceneView.environment 中启用了直接阴影也是如此。此属性仅适用于 MeshSymbol3D 符号。
- 默认值:true
示例// disables shadow casting symbolLayer.castShadows = false;
-
起始版本:GeoScene Maps SDK for JavaScript 4.7
-
类的名称。声明的类名称格式化为
geoscene.folder.className
。
-
起始版本:GeoScene Maps SDK for JavaScript 4.7
-
设置 3D 对象上的轮廓边缘。这仅适用于 MeshSymbol3D。
示例const symbol = { type: "mesh-3d", // autocasts as new MeshSymbol3D() symbolLayers: [{ type: "fill", // autocasts as new FillSymbol3DLayer() material: { color: [244, 247, 134] }, edges: { type: "solid", // autocasts as new SolidEdges3D() color: [50, 50, 50, 0.5] } }] };
-
材质通过将材质中设置的
color
属性与要素的几何颜色/纹理信息混合来定义图形的最终颜色。colorMixMode
定义这些颜色如何混合在一起。- 属性
-
color Color默认值:white
填充的颜色。这可以通过 rgb(a) 值数组、命名字符串、十六进制字符串或 hsl(a) 字符串、具有
r
,g
,b
和a
属性的对象或 Color 对象进行自动转换。colorMixMode String默认值:multiply指定如何将材质
color
应用于几何颜色/纹理信息。此属性仅适用于 MeshSymbol3D 符号。值 描述 tint 将材质 color
应用于不饱和的几何体/纹理颜色。replace 移除几何/纹理颜色并应用材质 color
。multiply 将几何图形/纹理颜色值与材质 color
值相乘。结果是颜色变深。与白色相乘可使几何图形颜色保持不变。可能值:"tint"|"replace"|"multiply"
示例// CSS color string symbolLayer.material = { color: "dodgerblue", colorMixMode: "tint" };
// 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 } };
-
用于在填充几何周围绘制线的轮廓。MeshSymbol3D 符号图层中不支持此属性。
- 属性
-
color Color默认值:black
轮廓的颜色。这可以通过 rgb(a) 值数组、命名字符串、十六进制字符串或 hsl(a) 字符串、具有
r
,g
,b
和a
属性的对象或 Color 对象进行自动转换。size Number默认值:1px轮廓的宽度,以磅为单位。此值可以是自动转换的,其字符串以磅或像素表示大小 (例如
12px
)。pattern LineStylePattern3D用于渲染轮廓的描边图案。默认情况下,线显示为实线。
patternCap String默认值:butt此样式应用于沿线的每个图案段的尖端。
可能值:"butt"|"round"|"square"
示例symbolLayer.outline = { color: "white", size: "2px", pattern: { // autocasts as new LineStylePattern3D() type: "style", style: "dash" }, patternCap: "round" };
-
pattern StylePattern3D起始版本:GeoScene Maps SDK for JavaScript 4.17
-
用于渲染多边形填充的图案。此属性仅适用于 PolygonSymbol3D。
示例const symbol = { type: "polygon-3d", // autocasts as new PolygonSymbol3D() symbolLayers: [{ type: "fill", // autocasts as new FillSymbol3DLayer() material: { color: "red" }, outline: { color: "red" }, pattern: { type: "style", style: "cross" } }] };
-
type Stringreadonly
-
符号类型。
对于 FillSymbol3DLayer,类型总是 "fill"。
方法概述
名称 | 返回值类值 | 描述 | 类 |
---|---|---|---|
添加一个或多个与对象的生命周期相关联的句柄。 更多详情 | Accessor | ||
FillSymbol3DLayer | 创建符号图层的深度克隆。 更多详情 | FillSymbol3DLayer | |
* | 创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。 更多详情 | Symbol3DLayer | |
Boolean | 如果存在指定的句柄组,则返回 true。 更多详情 | Accessor | |
移除对象拥有的句柄组。 更多详情 | Accessor | ||
Object | 将此类的实例转换为 GeoScene Portal JSON 表示。 更多详情 | Symbol3DLayer |
方法详细说明
-
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(){FillSymbol3DLayer}
-
创建符号图层的深度克隆。
返回类型 描述 FillSymbol3DLayer 调用此方法的对象的深度克隆。 示例// 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 ObjectGeoScene 格式实例的 JSON 表示。有关各种输入 JSON 对象的结构示例,请参阅 GeoScene REST API 文档。
返回类型 描述 * 返回该类的新实例。
-
起始版本: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");
-
将此类的实例转换为 GeoScene Portal JSON 表示。有关详细信息,请参阅使用 fromJSON() 指南主题。
返回类型 描述 Object 此类实例的 GeoScene Portal JSON 表示。