MapGIS Client for JavaScript API

import Zondy from '../Zondy'
import { defaultValue } from '../../util'
import { SymbolType } from '../enum'
import Symbol3D from './Symbol3D'

/**
 * 三维体符号，用于在三维场景视图中渲染几何要素，不支持二维视图<br/>
 * 三维体符号必须包含如下符号图层中的一个或多个，才能在三维场景中显示要素：<br/>
 * [三维区符号图层]{@link FillSymbol3DLayer}、[三维拉伸区符号图层]{@link ExtrudeSymbol3DLayer}、[三维线符号图层]{@link LineSymbol3DLayer}、[三维图标符号图层]{@link IconSymbol3DLayer}、[三维体对象符号图层]{@link ObjectSymbol3DLayer}、[三维注记符号图层]{@link TextSymbol3DLayer}<br/>
 * 示例如下：<br/>
 * <a href='#PolygonSymbol3D'>[1、创建一个三维体符号对象]</a><br/>
 *
 * @class PolygonSymbol3D
 * @extends Symbol3D
 * @moduleEX SymbolModule
 * @param {Object} options 初始化参数
 * @param {Collection} [options.symbolLayers] symbolLayers 符号图层集合，用于可视化要素对象
 *
 * @summary <h5>支持如下方法：</h5>
 * <a href='#fromJSON'>[1、通过json构造并返回一个新的PolygonSymbol3D对象]</a>
 * <a href='#toJSON'>[2、导出为JSON对象]</a>
 * <a href='#clone'>[3、克隆并返回新的符号对象]</a>
 *
 * @example <caption><h7 id='PolygonSymbol3D'>创建一个三维体符号对象</h7></caption>
 * // ES5引入方式
 * const { Color } = Zondy
 * const { PolygonSymbol3D, ExtrudeSymbol3DLayer, ColorMaterial } = Zondy.Symbol
 * // ES6引入方式
 * import { PolygonSymbol3D, ExtrudeSymbol3DLayer, ColorMaterial, Color } from "@mapgis/webclient-common"
 *
 * // 创建一个三维体符号对象
 * const polygonSymbol3D = new PolygonSymbol3D({
 *   symbolLayers: [
 *     // 创建一个三维拉伸区符号突出
 *     new ExtrudeSymbol3DLayer({
 *       // 覆盖物颜色
 *       material: new ColorMaterial({
 *         color: new Color(255, 1, 1, 1)
 *       }),
 *       // 拉伸高度
 *       size: 1000
 *     })
 *   ]
 * })
 * */
class PolygonSymbol3D extends Symbol3D {
  constructor(options) {
    super(options)
    /**
     * 符号类型
     * @member {String} PolygonSymbol3D.prototype.type
     */
    this.type = SymbolType.polygon3D
  }

  /**
   * <a id='fromJSON'></a>
   * 通过json构造并返回一个新的PolygonSymbol3D对象
   * @param {Object} json 符号的实例化JSON
   * @return {PolygonSymbol3D} 新的PolygonSymbol3D对象
   */
  static fromJSON(json) {
    json = defaultValue(json, {})
    return new PolygonSymbol3D(json)
  }

  /**
   * <a id='toJSON'></a>
   * 导出为JSON对象
   * @return {Object} JSON对像
   */
  toJSON() {
    return super.toJSON()
  }

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

Zondy.Symbol.PolygonSymbol3D = PolygonSymbol3D
export default PolygonSymbol3D