MapGIS Client for JavaScript API

import Symbol3D from './Symbol3D'
import { defaultValue, toJSON } from '../../util'
import SymbolType from '../enum/SymbolType'
import Zondy from '../Zondy'
import { LineCallout3D, Symbol3DVerticalOffset } from './support'

/**
 * 三维注记符号，用于在三维场景中渲染线几何要素，不支持在二维视图中使用；<br/>
 * 三维注记符号必须包含如下符号图层中的一个或多个，才能在三维场景中显示要素：<br/>
 * [三维文字符号图层]{@link TextSymbol3DLayer}<br/>
 * 示例如下：<br/>
 * <a href='#LabelSymbol3D'>[1、创建一个三维注记符号对象]</a><br/>
 *
 * @class LabelSymbol3D
 * @extends Symbol3D
 * @moduleEX SymbolModule
 * @param {Object} options 构造参数
 * @param {Collection} [options.symbolLayers] symbolLayers 符号图层集合，用于可视化要素对象
 * @param {LineCallout3D} [options.callout] 注记索引线样式，该线会链接注记和所属要素，当一个符号相对于原始位置有偏移时，该符号能显示其真实位置
 * @param {Symbol3DVerticalOffset} [options.verticalOffset] 符号垂直偏移量，将一个符号在竖直世界轴的方向上进行平移
 *
 * @summary <h5>支持如下方法：</h5>
 * <a href='#fromJSON'>[1、通过json数据构造一个LabelSymbol3D对象]</a><br/>
 * <a href='#toJSON'>[2、导出为JSON对象]</a><br/>
 * <a href='#clone'>[3、克隆并返回一个新的LabelSymbol3D对象]</a><br/>
 *
 * @example <caption><h7 id='LabelSymbol3D'>创建一个三维注记符号对象</h7></caption>
 * // ES5引入方式
 * const { Color } = Zondy
 * const { LabelSymbol3D, TextSymbol3DLayer } = Zondy.Symbol
 * // ES6引入方式
 * import { LabelSymbol3D, TextSymbol3DLayer, Color } from "@mapgis/webclient-common"
 *
 * // 创建一个三维点符号
 * const symbol = new LabelSymbol3D({
 *   // 设置符号图层，可以设置多个
 *   symbolLayers: [
 *     // 设置三维文字符号图层
 *     new TextSymbol3DLayer({
 *       // 文字内容
 *       text: '你的文字内容',
 *       // 文字大小
 *       size: 40,
 *       // 文字颜色
 *       material: new ColorMaterial({
 *         color: new Color(255, 1, 1, 1)
 *       })
 *     })
 *   ]
 * })
 * */
class LabelSymbol3D extends Symbol3D {
  constructor(options) {
    super(options)
    options = defaultValue(options, {})
    /**
     * 符号类型
     * @member {String} LabelSymbol3D.prototype.type
     */
    this.type = SymbolType.label3D
    /**
     * 注记索引线样式，该线会链接注记和所属要素，当一个符号相对于原始位置有偏移时，该符号能显示其真实位置
     * @member {LineCallout3D} LabelSymbol3D.prototype.callout
     */
    this.callout = options.callout
      ? LineCallout3D.fromJSON(options.callout)
      : new LineCallout3D()
    /**
     * 符号垂直偏移量，将一个符号在竖直世界轴的方向上进行平移
     * @member {Symbol3DVerticalOffset} LabelSymbol3D.prototype.verticalOffset
     */
    this.verticalOffset = options.verticalOffset
      ? Symbol3DVerticalOffset.fromJSON(options.verticalOffset)
      : new Symbol3DVerticalOffset()
  }

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

  /**
   * <a id='toJSON'></a>
   * 导出为JSON对象
   * @return {Object} JSON对像
   */
  toJSON() {
    const _json = super.toJSON()
    _json.callout = toJSON(this.callout, LineCallout3D)
    _json.verticalOffset = toJSON(this.verticalOffset, Symbol3DVerticalOffset)

    return _json
  }

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

Zondy.Symbol.LabelSymbol3D = LabelSymbol3D
export default LabelSymbol3D