MapGIS Client for JavaScript API

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

/**
 * 三维线符号，用于在三维场景中渲染线几何要素，不支持在二维视图中使用；<br/>
 * 三维线符号必须包含如下符号图层中的一个或多个，才能在三维场景中显示要素：<br/>
 * [三维线符号图层]{@link LineSymbol3DLayer}、[三维管道符号图层]{@link PathSymbol3DLayer}<br/>
 * 示例如下：<br/>
 * <a href='#LineSymbol3D'>[1、创建线三维符号]</a><br/>
 *
 * @class LineSymbol3D
 * @extends Symbol3D
 * @moduleEX SymbolModule
 * @param {Object} options 初始化参数
 * @param {Collection} [options.symbolLayers] symbolLayers 符号图层集合，用于可视化要素对象
 *
 * @summary <h5>支持如下方法：</h5>
 * <a href='#fromJSON'>[1、通过json数据构造一个LineSymbol3D对象]</a><br/>
 * <a href='#toJSON'>[2、导出为JSON对象]</a><br/>
 * <a href='#clone'>[3、克隆并返回一个新的LineSymbol3D对象]</a><br/>
 *
 * @example <caption><h7 id='LineSymbol3D'>创建线三维符号</h7></caption>
 * // ES5引入方式
 * const { Color } = Zondy
 * const { LineSymbol3D, ColorMaterial } = Zondy.Symbol
 * // ES6引入方式
 * import { LineSymbol3D, ColorMaterial, Color} from "@mapgis/webclient-common"
 *
 * // 创建一个三维线符号
 * const symbol = new LineSymbol3D({
 *   // 设置线符号图层，可以设置多个线符号图层
 *   symbolLayers: [
 *     // 设置一个方管道线图层
 *     new PathSymbol3DLayer({
 *       // 管道宽度
 *       width: 40,
 *       // 管道高度
 *       height: 40,
 *       // 管道线材质，设置纯色材质
 *       material: new ColorMaterial({
 *         // 设置颜色
 *         color: new Color(123, 34, 233)
 *       }),
 *       // 设置管道横截面形状为方管道
 *       profile: ProfileType.quad
 *     })
 *   ]
 * })
 * */
class LineSymbol3D extends Symbol3D {
  constructor(options) {
    super(options)
    /**
     * 符号类型
     * @member {String} PolygonSymbol3D.prototype.type
     */
    this.type = SymbolType.line3D
  }

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

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

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

Zondy.Symbol.LineSymbol3D = LineSymbol3D
export default LineSymbol3D