MapGIS Client for JavaScript API

import Zondy from '../../Zondy'
import { defaultValue, toJSON } from '../../../util'
import { Symbol3DLayerType } from '../../enum'
import { Color } from '../..'
import Font from '../../Font'
import HorizontalAlignment from '../../enum/HorizontalAlignment'
import VerticalAlignment from '../../enum/VerticalAlignment'
import TextHalo from '../support/TextHalo'
import Symbol3DLayer from './Symbol3DLayer'
import { ColorMaterial } from '../support'

/**
 * 三维注记符号图层，定义如何在三维场景中显示文字，不支持二维视图<br/>
 * 示例如下：<br/>
 * <a href='#TextSymbol3DLayer'>[1、创建一个三维注记符号图层对象]</a><br/>
 *
 * @class TextSymbol3DLayer
 * @moduleEX SymbolModule
 * @extends Symbol3DLayer
 * @param {Object} options 构造参数
 * @param {String} [options.text = null] 文字内容
 * @param {Font} [options.font = new Font()] 字体
 * @param {Number} [options.size = 9] 文字大小，在字体中设置文字大小无效
 * @param {ColorMaterial} [options.material = new ColorMaterial()] 文字材质目前支持的材质有：<br/>
 * ColorMaterial: 纯色材质，通过设置纯色材质来设置文字颜色
 * @param {Color} [options.background = new Color()] 文字背景颜色
 * @param {TextHalo} [options.halo = new TextHalo()] 文字光晕样式
 * @param {HorizontalAlignment} [options.horizontalAlignment = HorizontalAlignment.center] 文字水平对齐方式
 * @param {VerticalAlignment} [options.verticalAlignment = VerticalAlignment.baseline] 文字垂直对齐方式
 * @param {Number} [options.lineHeight = 1] 文字行高
 *
 * @summary <h5>支持如下方法：</h5>
 * <a href='#fromJSON'>[1、通过json数据构造一个TextSymbol3DLayer对象]</a><br/>
 * <a href='#toJSON'>[2、导出为JSON对象]</a><br/>
 * <a href='#clone'>[3、克隆并返回一个新的TextSymbol3DLayer对象]</a><br/>
 *
 * @example <caption><h7 id='TextSymbol3DLayer'>创建一个三维注记符号图层对象</h7></caption>
 * // ES5引入方式
 * const { Color } = Zondy
 * const { TextSymbol3DLayer, ColorMaterial } = Zondy.Symbol
 * // ES6引入方式
 * import { TextSymbol3DLayer, ColorMaterial, Color } from "@mapgis/webclient-common"
 *
 * // 创建一个三维注记符号图层对象
 * const symbol = new TextSymbol3DLayer({
 *   // 文字内容
 *   text: '你的文字内容',
 *   // 文字大小
 *   size: 40,
 *   // 文字颜色
 *   material: new ColorMaterial({
 *     color: new Color(255, 1, 1, 1)
 *   })
 * })
 * */
class TextSymbol3DLayer extends Symbol3DLayer {
  constructor(options) {
    super(options)
    options = defaultValue(options, {})
    /**
     * 三维符号图层类型
     * @member {Symbol3DLayerType} TextSymbol3DLayer.prototype.type
     */
    this.type = Symbol3DLayerType.text
    /**
     * 背景颜色
     * @member {Color} TextSymbol3DLayer.prototype.background
     */
    this.background = options.background
      ? Color.fromJSON(options.background)
      : new Color()
    /**
     * 字体
     * @member {Font} TextSymbol3DLayer.prototype.background
     */
    this.font = options.font ? Font.fromJSON(options.font) : new Font()
    /**
     * 文字光晕样式
     * @member {TextHalo} TextSymbol3DLayer.prototype.halo
     */
    this.halo = options.halo ? TextHalo.fromJSON(options.halo) : new TextHalo()
    /**
     * 文字水平对齐方式
     * @member {HorizontalAlignment} TextSymbol3DLayer.prototype.horizontalAlignment
     */
    this.horizontalAlignment = defaultValue(
      options.horizontalAlignment,
      HorizontalAlignment.center
    )
    /**
     * 文字垂直对齐方式
     * @member {VerticalAlignment} TextSymbol3DLayer.prototype.verticalAlignment
     */
    this.verticalAlignment = defaultValue(
      options.verticalAlignment,
      VerticalAlignment.baseline
    )
    /**
     * 文字行高
     * @member {Number} TextSymbol3DLayer.prototype.lineHeight
     */
    this.lineHeight = defaultValue(options.lineHeight, 1)
    /**
     * 材质
     * @member {ColorMaterial} TextSymbol3DLayer.prototype.material
     */
    this.material = options.material
      ? ColorMaterial.fromJSON(options.material)
      : new ColorMaterial()
    /**
     * 文字大小
     * @member {Number} TextSymbol3DLayer.prototype.size
     */
    this.size = defaultValue(options.size, 9)
    /**
     * 文字内容
     * @member {String} TextSymbol3DLayer.prototype.text
     */
    this.text = defaultValue(options.text, undefined)
  }

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

  /**
   * <a id='toJSON'></a>
   * 导出为JSON对象
   * @return {Object} JSON对像
   */
  toJSON() {
    return {
      type: this.type,
      background: toJSON(this.background, Color),
      font: toJSON(this.font, Font),
      halo: toJSON(this.halo, TextHalo),
      horizontalAlignment: this.horizontalAlignment,
      verticalAlignment: this.verticalAlignment,
      lineHeight: this.lineHeight,
      material: toJSON(this.material, ColorMaterial),
      size: this.size,
      text: this.text
    }
  }

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

Zondy.Symbol.TextSymbol3DLayer = TextSymbol3DLayer
export default TextSymbol3DLayer