Class: M3DModelCacheLayer

M3DModelCacheLayer

new M3DModelCacheLayer(options)

document/layer/M3DModelCacheLayer.js, line 12

M3D 模型缓存图层。

该图层用于加载文件服务或 IGS 发布的 M3D 服务,支持时间范围、高程模式、体元过滤和专题渲染等能力。 当 Cesium 版本为 10.7.2.x 及以下时,仅支持设置 token 参数,不支持自定义请求头。

Name Type Description
options Object

构造参数

Name Type Default Description
elevationInfo ElevationInfo 可选

高程模式。目前仅支持栅格体元设置高程模式,且如果设置featureExpressionInfo ,则必须按照$feature.z的方式索引高程值,且目前仅支持简单的表达式,例如可以设置将每个高程值替换为原来的10倍,可以设置表达式'$feature.z * 10'

timeExtent TimeExtent 可选

时间范围,具有明确开始和结束日期的一段时间。时间范围用于显示或查询指定时间段内的要素。要表示某个时刻,需要将开始时间和结束时间设置为同一日期。

clientFilters Array.<VoxelFilter> [] 可选

客户端过滤器,当前仅支持数据的第一个VoxelFilter过滤器。

fillClip Boolean false 可选

是否开启模型缓存剖切封边

enableSection Boolean false 可选

是否支持生成剖面

url String 可选

服务基地址,支持文件服务和IGS的M3D服务
文件服务基地址格式:http://{ip}:{port}/{folder}/{serviceName}.mcj
M3D服务基地址格式(IGS1.0):无此服务
M3D服务基地址格式(IGS2.0):http://{ip}:{port}/igs/rest/services/{服务名}/M3dServer

renderer BaseRenderer | Array | RendererCollection 可选

渲染器,
目前支持如下样式:
1、单值专题图
2、分段专题图
参考示例:
[1、单值专题图]
[2、分段专题图]
[3、单值专题图-Cesium原生方式]
[4、分段专题图-Cesium原生方式]

Examples

初始化模型缓存图层

// ES5引入方式
const { M3DModelCacheLayer } = zondy.layer

// ES6引入方式
import { M3DModelCacheLayer } from "@mapgis/webclient-common"
const layer = new M3DModelCacheLayer({
  // 服务基地址
  url: '服务基地址'
  // Cesium引擎的额外初始化参数
  extensionOptions: {
    // 开启自动跳转
    autoReset: true
  }
});

单值专题图

// ES5引入方式
const { M3DModelCacheLayer } = zondy.layer
const { UniqueValueRenderer } = zondy.renderer
const { SimpleFillSymbol,SimpleLineSymbol } = zondy.symbol
const { Color } = zondy

// ES6引入方式
import { M3DModelCacheLayer,UniqueValueRenderer,SimpleFillSymbol,SimpleLineSymbol,Color } from "@mapgis/webclient-common"
// 构造单值渲染器
const renderer = new UniqueValueRenderer({
  // 专题图过滤字段名
  field: "字段名",
  // 单值专题图过滤条件数组
  uniqueValueInfos: [
    {
      // 指定字段值
      value: '过滤字段值1',
      // 匹配到该值后的样式
      // M3D专题图仅支持SimpleFillSymbol符号
      symbol: new SimpleFillSymbol({
        // 填充颜色
        color: new Color(255, 0, 0)
      })
    },
    {
      // 指定字段值
      value: '过滤字段值2',
      // 匹配到该值后的样式
      // M3D专题图仅支持SimpleFillSymbol符号
      symbol: new SimpleFillSymbol({
        // 填充颜色
        color: 'rgb(255, 123, 220)'
      })
    }
  ]
})
// 构造模型缓存图层
const layer = new M3DModelCacheLayer({
  // 服务基地址
  url: '服务基地址',
  // 设置专题图渲染器
  renderer: renderer,
  // Cesium引擎的额外初始化参数
  extensionOptions: {
    // 开启自动跳转
    autoReset: true
  }
});

分段专题图

// ES5引入方式
const { M3DModelCacheLayer } = zondy.layer
const { ClassBreakRenderer } = zondy.renderer
const { SimpleFillSymbol } = zondy.symbol
const { Color } = zondy

// ES6引入方式
import { M3DModelCacheLayer,ClassBreakRenderer,SimpleFillSymbol,Color } from "@mapgis/webclient-common"
// 构造分段渲染器
const renderer = new ClassBreakRenderer({
  // 专题图过滤字段名
  field: "字段名",
  // 分段专题图过滤条件数组
  classBreakInfos: [
    {
      // 最小过滤范围,field对应的值大于等于minValue
      minValue: 0,
      // 最大过滤范围,field对应的值小于maxValue
      maxValue: 2,
      // 匹配到该值后的样式
      // M3D专题图仅支持SimpleFillSymbol符号
      symbol: new SimpleFillSymbol({
        // 填充颜色
        color: new Color(255, 0, 0)
      })
    },
    {
      // 最小过滤范围,field对应的值大于等于minValue
      minValue: 3,
      // 最大过滤范围,field对应的值小于maxValue
      maxValue: 5,
      // 匹配到该值后的样式
      // M3D专题图仅支持SimpleFillSymbol符号
      symbol: new SimpleFillSymbol({
        // 填充颜色
        color: 'rgb(255, 123, 220)'
      })
    }
  ]
})
// 构造模型缓存图层
const layer = new M3DModelCacheLayer({
  // 服务基地址
  url: '服务基地址',
  // 设置专题图渲染器
  renderer: renderer,
  // Cesium引擎的额外初始化参数
  extensionOptions: {
    // 开启自动跳转
    autoReset: true
  }
});

单值专题图-Cesium原生方式

// ES5引入方式
const { M3DModelCacheLayer } = zondy.layer

// ES6引入方式
import { M3DModelCacheLayer } from "@mapgis/webclient-common"
// 构造Cesium原生渲染器
const renderer = {
  // 专题图过滤字段名
  field: "字段名",
  // 专题图类型-分段
  type: "class-breaks",
  // 分段专题图过滤条件数组
  classBreakInfos: [{
    // 最小过滤范围,field对应的值大于等于minValue
    minValue: 1,
    // 最大过滤范围,field对应的值小于maxValue
    maxValue: 7,
    // 渲染符号
    symbol: {
      // 渲染类型为M3D
      type: 'mesh-3d',
      // 覆盖物图层
      symbolLayers: [{
        // 图层类型-颜色填充
        type: "fill",
        // 图层材质
        material: {
          // 填充颜色
          color: Cesium.Color.ANTIQUEWHITE
        }
      }]
    }
  }]
}
// 构造模型缓存图层
const layer = new M3DModelCacheLayer({
  // 服务基地址
  url: '服务基地址',
  // Cesium引擎的额外初始化参数
  extensionOptions: {
    // 开启自动跳转
    autoReset: true,
    // 设置专题图渲染器
    renderer: renderer
  }
});

分段专题图-Cesium原生方式

// ES5引入方式
const { M3DModelCacheLayer } = zondy.layer

// ES6引入方式
import { M3DModelCacheLayer } from "@mapgis/webclient-common"
// 构造Cesium原生渲染器
const renderer = {
  // 专题图过滤字段名
  field: "字段名",
  // 专题图类型-单值
  type: "unique-value",
  // 单值专题图过滤条件数组
  uniqueValueInfos: [
    // 指定字段值
    value: '过滤字段值',
    // 渲染符号
    symbol: {
      // 渲染类型为M3D
      type: 'mesh-3d',
      // 覆盖物图层
      symbolLayers: [{
        // 图层类型-颜色填充
        type: "fill",
        // 图层材质
        material: {
          // 填充颜色
          color: new Cesium.Color(0.0, 0.0, 1.0, 0.5)
        }
      }]
    }
  ]
};
// 构造模型缓存图层
const layer = new M3DModelCacheLayer({
  // 服务基地址
  url: '服务基地址',
  // Cesium引擎的额外初始化参数
  extensionOptions: {
    // 开启自动跳转
    autoReset: true,
    // 设置专题图渲染器
    renderer: renderer
  }
});

Extends

Members

boundingVolumeObject null

模型外包盒信息。

该属性通常来源于服务元信息,用于描述模型缓存的空间包围范围。

capabilitiesObject

图层支持能力。

默认仅 Cesium 引擎支持加载,Leaflet/MapboxGL 等非三维引擎会被标记为 loaded=false

clientFiltersArray.<VoxelFilter>

客户端过滤器集合。

当前仅支持使用数组中的第一个 VoxelFilter 过滤器,其余过滤器不会参与实际渲染过滤。

descriptionString

图层描述信息。

该属性可用于图层列表展示或序列化输出。

elevationInfoElevationInfo

高程模式。

当前仅支持栅格体元设置高程模式;若配置 featureExpressionInfo,必须通过 $feature.z 引用高程值, 且当前仅支持简单表达式,例如 $feature.z * 10

enableSectionBoolean

是否支持剖面分析。

该属性用于声明当前图层是否启用剖面相关业务能力。

fieldInfoArray.<String>

服务包含的字段名称数组。

该属性通常由服务端返回,可用于构建专题图、筛选条件或属性面板。

fillClipBoolean

是否启用模型缓存剖切封边。

该属性用于控制剖切分析后是否自动补齐封边效果。

positionObject

模型位置

rendererBaseRenderer RendererCollection Array Object null

图层渲染器。

支持 BaseRendererRendererCollection、数组或普通对象配置。 其中数组类型仅为兼容旧版本保留,不支持响应式更新;如需响应式修改渲染器,建议优先使用 RendererCollection

sceneNameString

场景名称或服务名。

该属性通常来自服务配置,用于图层标题生成或业务侧标识。

timeExtentTimeExtent

当前图层的时间范围。

用于约束显示或查询的时间区间;若要表示单一时刻,应将开始时间和结束时间设置为同一日期。

timeInfoTimeInfo null

数据时间维度描述信息。

该属性来源于初始化配置或服务元信息,用于描述当前图层可用的时间字段和时间行为。

typeString

图层类型。

该属性在构造时固定设置,用于标识当前图层为 M3D 模型缓存图层。

urlString

服务基地址

versionString

服务版本号

Methods

clone(){M3DModelCacheLayer}

document/layer/M3DModelCacheLayer.js, line 654

克隆当前 M3D 模型缓存图层。

会基于当前实例的序列化结果创建新的图层对象。

Returns:
Type Description
M3DModelCacheLayer 克隆后的图层对象。

load(){Promise.<M3DModelCacheLayer>}

document/layer/M3DModelCacheLayer.js, line 534

加载图层资源。

调用后会请求服务元信息,并在成功后更新图层标题、加载状态及解密配置等运行时信息。

Returns:
Type Description
Promise.<M3DModelCacheLayer> Promise 对象,resolve 时返回当前图层实例。
Example

不加载图层,仅获取图层信息

// ES5引入方式
const { M3DModelCacheLayer } = zondy.layer

// ES6引入方式
import { M3DModelCacheLayer } from "@mapgis/webclient-common"
// 初始化图层
const layer = new M3DModelCacheLayer({
  // 服务基地址
  url: '服务基地址',
});
layer.load().then((result) => {
  // 获取完图层信息
  console.log(result)
})

toJSON(){Object}

document/layer/M3DModelCacheLayer.js, line 611

导出为 JSON 配置。

返回结果包含当前图层的基础属性、时间信息、高程模式、客户端过滤器和渲染器等配置。

Returns:
Type Description
Object 图层配置对象。

M3DModelCacheLayer.fromJSON(json){M3DModelCacheLayer}

document/layer/M3DModelCacheLayer.js, line 637

通过 JSON 配置创建一个 M3D 模型缓存图层实例。

适用于从持久化配置恢复图层对象;返回实例会被直接标记为已加载状态。

Name Type Default Description
json Object {} 可选

图层配置对象。

Returns:
Type Description
M3DModelCacheLayer 新的 M3D 模型缓存图层实例。

M3DModelCacheLayer.fromServerUrl(url){M3DModelCacheLayer}

document/layer/M3DModelCacheLayer.js, line 667

通过服务地址快速创建一个 M3D 模型缓存图层。

适用于仅已知服务地址、后续再补充其他配置的场景。

Name Type Description
url String

服务基地址。

Returns:
Type Description
M3DModelCacheLayer 新的 M3D 模型缓存图层对象。