MapGIS Client for JavaScript API

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

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

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

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

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

Zondy.Symbol.FillSymbol3DLayer = FillSymbol3DLayer
export default FillSymbol3DLayer