MapGIS Client for JavaScript API

import Zondy from '../../Zondy'
import { defaultValue, toJSON } from '../../../util'
import { Symbol3DLayerType } from '../../enum'
import { ColorMaterial, Edges3D } from '../support'
import Symbol3DLayer from './Symbol3DLayer'

/**
 * 三维拉伸区符号图层，用来在三维场景中绘制拉伸的区几何，不支持二维地图视图<br/>
 * 示例如下：<br/>
 * <a href='#ExtrudeSymbol3DLayer'>[1、创建三维拉伸区符号图层]</a><br/>
 *
 * @class ExtrudeSymbol3DLayer
 * @moduleEX SymbolModule
 * @extends Symbol3DLayer
 * @param {Object} options 构造参数
 * @param {ColorMaterial} [options.material = new ColorMaterial()] 拉伸区材质，目前支持的材质有：<br/>
 * ColorMaterial: 纯色材质，通过设置纯色材质来改变拉伸区区的颜色
 * @param {Number} [options.size = 1] 拉伸高度
 * @param {Boolean} [options.castShadows = true] 是否显示阴影
 * @param {Edges3D} [options.edges = new Edges3D()] 轮廓线样式
 *
 * @summary <h5>支持如下方法：</h5>
 * <a href='#fromJSON'>[1、通过json数据构造一个ExtrudeSymbol3DLayer对象]</a><br/>
 * <a href='#toJSON'>[2、导出为json数据]</a><br/>
 * <a href='#clone'>[3、克隆并返回一个新的ExtrudeSymbol3DLayer对象]</a><br/>
 *
 * @example <caption><h7 id='ExtrudeSymbol3DLayer'>创建三维拉伸区符号图层</h7></caption>
 * // ES5引入方式
 * const { Color } = Zondy
 * const { ExtrudeSymbol3DLayer, ColorMaterial } = Zondy.Symbol
 * // ES6引入方式
 * import { ExtrudeSymbol3DLayer, ColorMaterial, Color } from "@mapgis/webclient-common"
 *
 * // 创建三维区符号图层
 * const extrudeSymbol3DLayer = new ExtrudeSymbol3DLayer({
 *   // 覆盖物颜色
 *   material: new ColorMaterial({
 *     color: new Color(255, 1, 1, 1)
 *   }),
 *   // 拉伸高度
 *   size: 1000
 * })
 * */
class ExtrudeSymbol3DLayer extends Symbol3DLayer {
  constructor(options) {
    super(options)
    options = defaultValue(options, {})
    /**
     * 三维符号图层类型
     * @member {Symbol3DLayerType} ExtrudeSymbol3DLayer.prototype.type
     */
    this.type = Symbol3DLayerType.extrude
    /**
     * 是否显示阴影
     * @member {Boolean} ExtrudeSymbol3DLayer.prototype.castShadows
     */
    this.castShadows = defaultValue(options.castShadows, true)
    /**
     * 材质
     * @member {ColorMaterial} ExtrudeSymbol3DLayer.prototype.material
     */
    this.material = options.material
      ? ColorMaterial.fromJSON(options.material)
      : new ColorMaterial()
    /**
     * 拉伸高度
     * @member {Number} ExtrudeSymbol3DLayer.prototype.size
     */
    this.size = defaultValue(options.size, 1)
    /**
     * 轮廓线样式
     * @member {Edges3D} ExtrudeSymbol3DLayer.prototype.edges
     */
    this.edges = options.edges ? Edges3D.fromJSON(options.edges) : new Edges3D()
  }

  /**
   * <a id='fromJSON'/>
   * 通过json数据构造一个ExtrudeSymbol3DLayer对象
   * @param {Object} json json数据
   * @return {LineCallout3D} 新的ExtrudeSymbol3DLayer对象
   * */
  static fromJSON(json) {
    return new ExtrudeSymbol3DLayer(json)
  }

  /**
   * <a id='toJSON'/>
   * 导出为json数据
   * @return {Object} 导出的json数据
   * */
  toJSON() {
    return {
      type: this.type,
      castShadows: this.castShadows,
      material: toJSON(this.material, ColorMaterial),
      size: this.size,
      pattern: toJSON(this.edges, Edges3D)
    }
  }

  /**
   * <a id='clone'/>
   * 克隆并返回一个新的ExtrudeSymbol3DLayer对象
   * @return {ExtrudeSymbol3DLayer} 新的ExtrudeSymbol3DLayer对象
   * */
  clone() {
    return new ExtrudeSymbol3DLayer(this.toJSON())
  }
}

Zondy.Symbol.ExtrudeSymbol3DLayer = ExtrudeSymbol3DLayer
export default ExtrudeSymbol3DLayer