OpenSource
/
dc-sdk
镜像自地址 https://github.com/dvt3d/dc-sdk
关注 4
点赞 0
派生 0
代码 工单 0 版本发布 92 百科 动态
您最多选择25个主题 主题必须以字母或数字开头，可以包含连字符 (-)，并且长度不得超过35个字符
544 提交
6 分支
目录树: 03bf5537bd
分支列表 标签列表
${ item.name }
创建分支 ${ searchTerm }
从 '03bf5537bd'
${ noResults }
dc-sdk/docs/overlay/README.md

README.md 43KB
原始文件 Blame 文件历史

Overlays 🌎

An important part of the 3D scene, digitally representing an entity in the three scenes and recording its real-time state

Overlay

base class

:::warning The class cannot be instantiated :::

properties

  • {String} overlayId readonly
  • {String} id
  • {Boolean} show
  • {Object} attr
  • {Array} contextMenu
  • {String} state readonly
  • {String} type readonly
  • {Boolean} allowDrillPicking：Default is false, if true, the overlay selects all the overlays behind it for penetration and triggers a mouse thing for all the overlays behind it 件

methods

  • addTo(layer)

    • parameters
    • {Layer} layer
    • returns this

  • remove()

    • returns this

  • setLabel(text, textStyle)

    • parameters
    • {String} text
    • {String} textStyle DC.Label
    • returns this

:::warning This function is only valid for the following overlays：Point、Circle、Polygon、Billboard、Ellipse、Rectangle :::

  • on(type, callback, context)

Event Subscription

  • parameters
    • {Object} type
    • {Function} callback
    • {Object} context

  • returns this

  • off(type, callback, context)

Event Unsubscribe

  • parameters
    • {Object} type
    • {Function} callback
    • {Object} context

  • returns this

  • fire(type,params)

    • parameters
    • {Object} type
    • {Object} params
    • returns this

static methods

  • registerType(type)

    • parameters
    • {String} type

  • getOverlayType(type)

    • parameters
    • {String} type
    • returns string

DC.Point

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let point = new DC.Point(position)
point.setStyle({
  pixelSize: 10,
})

creation

  • constructor(position)

    • parameters
    • {Position|String|Array|Object} position
    • returns point

properties

  • {Position|String|Array|Object} position

methods

  • setStyle(style)

// style(optional)
{
  "pixelSize": 1,
  "heightReference": 0,
  "color": DC.Color.WHITE,
  "outlineColor": DC.Color.WHITE,
  "outlineWidth": 0,
  "scaleByDistance": {
    "near": 0,
    "nearValue": 0,
    "far": 1,
    "farValue": 0
  },
  "translucencyByDistance": {
    "near": 0,
    "nearValue": 0,
    "far": 1,
    "farValue": 0
  },
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  },
  "disableDepthTestDistance": 0
}

  • fromEntity(entity)

    • parameters
    • {Object} entity
    • returns point

DC.Polyline

Inherited from Overlay

example

let polyline = new DC.Polyline('120,20;120,30')
polyline.setStyle({
  width: 10,
})

creation

  • constructor(positions)

    • parameters
    • {String|Array<Position|Number|String|Object>} positions
    • returns polyline

properties

  • {String|Array<Position|Number|String|Object>} positions
  • {DC.Position} center readonly
  • {Number} distance readonly

methods

// style(optional)
{
  "width": 1,
  "material": DC.Color.WHITE,
  "clampToGround": false,
  "shadows": 0,
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  },
  "classificationType": 2,
  "zIndex": 0
}

  • fromEntity(entity)

    • parameters
    • {Object} entity
    • returns polyline

DC.Polygon

Inherited from Overlay

example

let polygon = new DC.Polygon('120,20;120,30;122,30')
polygon.setStyle({
  height: 10,
})

creation

  • constructor(positions)

    • parameters
    • {String|Array<Position|Number|String|Object>} positions
    • returns polygon

properties

  • {String|Array<Position|Number|String|Object>} positions
  • {String|Array<Position|Number|String|Object>} holes
  • {DC.Position} center readonly
  • {Number} area readonly

methods

// style(optional)
{
  "height": 1,
  "heightReference": 0,
  "extrudedHeight": 0,
  "stRotation": 0,
  "fill": true,
  "material": DC.Color.WHITE,
  "outline": false,
  "outlineColor": DC.Color.BLACK,
  "outlineWidth": 0,
  "closeTop": true,
  "closeBottom": true,
  "shadows": 0,
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  },
  "classificationType": 2,
  "zIndex": 0
}

  • fromEntity(entity)

    • parameters
    • {Object} entity
    • returns polygon

DC.Billboard

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let billboard = new DC.Billboard(position, '***/**.png')
billboard.size = [20, 20]

creation

  • constructor(position,icon)

    • parameters
    • {Position|String|Array|Object} position
    • {String} icon
    • returns billboard

properties

  • {Position|String|Array|Object} position
  • {String} icon
  • {Array<Number>} size: [width,height]

methods

// style(optional)
{
  "heightReference": 0,
  "scale": 1,
  "pixelOffset": { "x": 0, "y": 0 },
  "rotation": 0,
  "translucencyByDistance": {
    "near": 0,
    "nearValue": 0,
    "far": 1,
    "farValue": 0
  },
  "scaleByDistance": {
    "near": 0,
    "nearValue": 0,
    "far": 1,
    "farValue": 0
  },
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  },
  "disableDepthTestDistance": 0
}

  • fromEntity(entity)

    • parameters
    • {Object} entity：
    • returns billboard

DC.Label

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let Label = new DC.Label(position, 'test')

creation

  • constructor(position,text)

    • parameters
    • {Position|String|Array|Object} position
    • {String} text
    • returns label

properties

  • {Position|String|Array|Object} position
  • {String} text

methods

  • setStyle(style)

// style(optional)
{
  "font": "30px sans-serif",
  "scale": 1,
  "pixelOffset": { "x": 0, "y": 0 },
  "heightReference": 0,
  "showBackground": false,
  "backgroundColor": DC.Color.BLACK,
  "backgroundPadding": { "x": 0, "y": 0 },
  "fillColor": DC.Color.BLACK,
  "outlineColor": DC.Color.WHITE,
  "outlineWidth": 0,
  "scaleByDistance": {
    "near": 0,
    "nearValue": 0,
    "far": 1,
    "farValue": 0
  },
  "translucencyByDistance": {
    "near": 0,
    "nearValue": 0,
    "far": 1,
    "farValue": 0
  },
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  },
  "disableDepthTestDistance": 0
}

  • fromEntity(entity,text)

    • parameters
    • {Object} entity
    • {String} text
    • returns label

DC.Circle

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let circle = new DC.Circle(position, 200)

creation

  • constructor(center, radius)

    • parameters
    • {Position|String|Array|Object} center
    • {String} radius
    • returns billboard

properties

  • {Position|String|Array|Object} center
  • {String} radius

methods

// style(optional)
{
  "height": 1,
  "heightReference": 0,
  "extrudedHeight": 0,
  "rotation": 0,
  "stRotation": 0,
  "fill": true, s
  "material": DC.Color.WHITE,
  "outline": false,
  "outlineColor": DC.Color.BLACK,
  "outlineWidth": 0,
  "shadows": 0,
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  },
  "classificationType": 2,
  "zIndex": 0
}

DC.Rectangle

矩形要素，继承于Overlay

example

let rectangle = new DC.Rectangle('-90.0,32.0;-94.0,36.0;')

creation

  • constructor(positions)

构造函数

  • parameters
    • {String|Array<Position|Number|String|Object>} positions：坐标串
  • returns rectangle

properties

  • {String|Array<Position|Number|String|Object>} positions：坐标串

methods

  • setStyle(style)

设置样式

// style(optional)
{
  "height": 1, //高度
  "heightReference": 0, //高度参照，0：位置无参照，位置是绝对的，1：位置固定在地形上 2：位置高度是指地形上方的高度。
  "extrudedHeight": 0, //拉升高度
  "rotation": 0, //顺时针旋转角度
  "stRotation": 0, //逆时针旋转角度
  "fill": true, //是否用提供的材料填充多边形。
  "material": DC.Color.WHITE, //材质
  "outline": false, //是否显示边框
  "outlineColor": DC.Color.BLACK, //边框颜色
  "outlineWidth": 0, //边框宽度
  "shadows": 0, //阴影类型，0：禁用、1：启用 、2：投射、3：接受
  "distanceDisplayCondition": {
    "near": 0, //最近距离
    "far": Number.MAX_VALUE //最远距离
  }, //根据距离设置可见
  "classificationType": 2, //分类 是否影响地形，3D切片或同时影响这两者。0:地形、1:3D切片、2：两者
  "zIndex": 0 //层级
}

DC.Wall

墙体要素，继承于Overlay

example

let wall = new DC.Wall('-90.0,32.0,1000;-94.0,36.0,1000;')

creation

  • constructor(positions)

构造函数

  • parameters
    • {String|Array<Position|Number|String|Object>} positions：坐标串
  • returns wall

properties

  • {String|Array<Position|Number|String|Object>} positions：坐标串

methods

  • setStyle(style)

设置样式

  • parameters
  • returns this
// style(optional)
{
  "fill": true, //是否用提供的材料填充多边形。
  "material": DC.Color.WHITE, //材质
  "outline": false, //是否显示边框
  "outlineColor": DC.Color.BLACK, //边框颜色
  "outlineWidth": 0, //边框宽度
  "shadows": 0, //阴影类型，0：禁用、1：启用 、2：投射、3：接受
  "distanceDisplayCondition": {
    "near": 0, //最近距离
    "far": Number.MAX_VALUE //最远距离
  }, //根据距离设置可见
  "classificationType": 2 //分类 是否影响地形，3D切片或同时影响这两者。0:地形、1:3D切片、2：两者
}
  • fromEntity(entity)

Entity 转换为 Overlay

  • parameters
    • {Object} entity：Cesium 覆盖物
  • returns wall

DC.Model

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let model = new DC.Model(position, '**/**.glb')

creation

  • constructor(position, modelUrl)

    • parameters
    • {Position|String|Array|Object} position
    • {String} modelUrl
    • returns model

properties

  • {Position|String|Array|Object} position
  • {String} modelUrl

methods

  • setStyle(style)

// style(optional)
{
  "scale": 1,
  "minimumPixelSize": 0,
  "maximumScale": 0,
  "heightReference": 0,
  "shadows": 0,
  "silhouetteColor": DC.Color.RED,
  "silhouetteSize": 0,
  "lightColor": DC.Color.RED,
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  }
}

  • fromEntity(entity,modelUrl)

    • parameters
    • {Object} entity
    • {String} modelUrl
    • returns model

DC.Tileset

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let tileset = new DC.Tileset('**/tileset.json')
tileset.setPosition(position)

creation

  • constructor(url,[options])

    • parameters
    • {String} url
    • {Object} options Tileset
    • returns tileset

properties

-{Promise} readyPromise

methods

  • setStyle(style)

    • parameters
    • {Object} style TileStyle
    • returns this
  let style = new DC.TilesetStyle({
    color: {
      conditions: [
        ['${Height} >= 100', 'color("purple", 0.5)'],
        ['${Height} >= 50', 'color("red")'],
        ['true', 'color("blue")'],
      ],
    },
    show: '${Height} > 0',
  })

  • setPosition(position)

    • parameters
    • {Position|Array|String} position
    • returns this

  • setHeadingPitchRoll(heading, pitch, roll)

    • parameters
    • {Number} heading
    • {Number} pitch
    • {Number} roll
    • returns this

  • setHeight(height,isAbsolute)

    • parameters
    • {Number} height
    • {Boolean} isAbsolute
    • returns this

  • setScale(scale)

    • parameters
    • {Number} scale
    • returns this

  • setCustomShader(customShader)

    • parameters
    • {String} customShader
    • returns this

  • setProperties(properties)

    • parameters
    • {Array<Object>} properties
    • returns this
{
  "key": "name",
  "keyValue": "1",
  "propertyName": "highlight",
  "propertyValue": true
}

DC.DivIcon

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let divIcon = new DC.DivIcon(position, '<div></div>')

creation

  • constructor(position, content)

    • parameters
    • {Position|String|Array|Object} position
    • {String|Element} content
    • returns divIcon

properties

  • {Position|String|Array|Object} position
  • {String|Element} content writeonly

methods

  • setStyle(style)

    • parameters
    • {Object} style
    • returns this
// style(optional)
{
  "className": "test",
  "scaleByDistance": {
    "near": 0,
    "nearValue": 0,
    "far": 1,
    "farValue": 0
  },
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  }
}

  • fromEntity(entity,content)

    • parameters
    • {Object} entity
    • {String|Element} content
    • returns divIcon

DC.Box

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let box = new DC.Box(position, 20, 30, 40)

creation

  • constructor(position, length, width, height)

    • parameters
    • {Position|String|Array|Object} position
    • {Number} length
    • {Number} width
    • {Number} height
    • returns box

properties

  • {Position|String|Array|Object} position
  • {Number} length
  • {Number} width
  • {Number} height

methods

  • setStyle(style)

// style(optional)
{
  "heightReference": 0,
  "fill": true,
  "material": DC.Color.WHITE,
  "outline": false,
  "outlineColor": DC.Color.BLACK,
  "outlineWidth": 0,
  "shadows": 0,
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  }
}

DC.Corridor

Inherited from Overlay

example

let corridor = new DC.Corridor('120,20;120,30')
corridor.setStyle({
  width: 10,
})

creation

  • constructor(positions)

    • parameters
    • {String|Array<Position|Number|String|Object>} positions
    • returns corridor

properties

  • {String|Array<Position|Number|String|Object>} positions

methods

// style(optional)
{
  "width": 1,
  "height": 0,
  "heightReference": 0,
  "cornerType": 0,
  "fill": true,
  "material": DC.Color.WHITE,
  "outline": false,
  "outlineColor": DC.Color.BLACK,
  "outlineWidth": 0,
  "shadows": 0,
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  },
  "classificationType": 2,
  "zIndex": 0
}

  • fromEntity(entity)

    • parameters
    • {Object} entity
    • returns corridor

DC.Cylinder

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let cylinder = new DC.Cylinder(position, 20, 30, 40)

creation

  • constructor(position, length, topRadius, bottomRadius)

    • parameters
    • {Position|String|Array|Object} position
    • {Number} length
    • {Number} topRadius
    • {Number} bottomRadius
    • returns cylinder

properties

  • {Position|String|Array|Object} position
  • {Number} length
  • {Number} topRadius
  • {Number} bottomRadius

methods

// style(optional)
{
  "heightReference": 0,
  "fill": true,
  "material": DC.Color.WHITE,
  "outline": false,
  "outlineColor": DC.Color.BLACK,
  "outlineWidth": 0,
  "shadows": 0,
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  }
}

DC.Ellipse

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let ellipse = new DC.Ellipse(position, 20, 30)

creation

  • constructor(position, semiMajorAxis, semiMinorAxis)

    • parameters
    • {Position|String|Array|Object} position
    • {Number} semiMajorAxis
    • {Number} semiMinorAxis
    • returns ellipse

properties

  • {Position|String|Array|Object} position
  • {Number} semiMajorAxis
  • {Number} semiMinorAxis

methods

// style(optional)
{
  "height": 1,
  "heightReference": 0,
  "extrudedHeight": 0,
  "rotation": 0,
  "stRotation": 0,
  "fill": true,
  "material": DC.Color.WHITE,
  "outline": false,
  "outlineColor": DC.Color.BLACK,
  "outlineWidth": 0,
  "shadows": 0,
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  },
  "classificationType": 2,
  "zIndex": 0
}

DC.Ellipsoid

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let ellipsoid = new DC.Ellipsoid(position, { x: 30, y: 30, z: 30 })

creation

  • constructor(position, radius)

    • parameters
    • {Position|String|Array|Object} position
    • {Object} radius：{x: 30, y: 30, z: 30}
    • returns ellipsoid

properties

  • {Position|String|Array|Object} position
  • {Object} radius：{x: 30, y: 30, z: 30}

methods

// style(optional)
{
  "heightReference": 0,
  "fill": true,
  "material": DC.Color.WHITE,
  "outline": false,
  "outlineColor": DC.Color.BLACK,
  "outlineWidth": 0,
  "shadows": 0,
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  }
}

DC.Plane

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let plane = new DC.Plane(position, 20, 30, { normal: 'x' })

creation

  • constructor(position, width, height, direction)

    • parameters
    • {Position|String|Array|Object} position
    • {Number} width
    • {Number} height
    • {Object} plane
    • returns plane
// plane
{
  "normal": "x",
  "distance": 0
}

properties

  • {Position|String|Array|Object} position
  • {Number} width
  • {Number} height
  • {Number} distance

methods

  • setStyle(style)

// style(optional)
{
  "fill": true,
  "material": DC.Color.WHITE,
  "outline": false,
  "outlineColor": DC.Color.BLACK,
  "outlineWidth": 0,
  "shadows": 0,
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  }
}

DC.PolylineVolume

Inherited from Overlay

example

function computeCircle(radius) {
  var positions = []
  for (var i = 0; i < 360; i++) {
    var radians = DC.Math.toRadians(i)
    positions.push({
      x: radius * Math.cos(radians),
      y: radius * Math.sin(radians),
    })
  }
  return positions
}

let polylineVolume = new DC.PolylineVolume(
  '-90.0,32.0,0.0;-90.0,36.0,100000.0;-94.0,36.0,0.0;',
  computeCircle(60000)
)

creation

  • constructor(positions, shape)

    • parameters
    • {String|Array<Position|Number|String|Object>} positions
    • {Array} shape
    • returns polylineVolume

properties

  • {String|Array<Position|Number|String|Object>} positions
  • {Array} shape

methods

// style(optional)
{
  "cornerType": 0,
  "fill": true,
  "material": DC.Color.WHITE,
  "outline": false,
  "outlineColor": DC.Color.BLACK,
  "outlineWidth": 0,
  "shadows": 0,
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  }
}

  • fromEntity(entity)

    • parameters
    • {Object} entity
    • returns polylineVolume

DC.DynamicBillboard

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let billboard = new DC.DynamicBillboard(position, '***/**.png')
billboard.size = [20, 20]

creation

  • constructor(position,icon)

    • parameters
    • {Position|String|Array|Object} position
    • {String} icon
    • returns billboard

properties

  • {Position} position readonly
  • {String} icon
  • {Array<Number>} size

methods

  • addPosition(position,interval)

    • parameters
    • {Position|Array|String|Object} position
    • {Number} interval
    • return’s this

  • setStyle(style)

// style(optional)
{
  "heightReference": 0,
  "scale": 1,
  "pixelOffset": { "x": 0, "y": 0 },
  "rotation": 0,
  "translucencyByDistance": {
    "near": 0,
    "nearValue": 0,
    "far": 1,
    "farValue": 0
  },
  "scaleByDistance": {
    "near": 0,
    "nearValue": 0,
    "far": 1,
    "farValue": 0
  },
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  },
  "disableDepthTestDistance": 0
}

DC.DynamicModel

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let model = new DC.DynamicModel(position, '**/**.glb')

creation

  • constructor(position, modelUrl)

    • parameters
    • {Position|String|Array|Object} position
    • {String} modelUrl
    • returns model

properties

  • {Position} position readonly
  • {String} modelUrl

methods

  • addPosition(position,interval)

    • parameters
    • {Position|Array|String|Object} position
    • {Number} interval
    • returns this

  • setStyle(style)

// style(optional)
{
  "scale": 1,
  "minimumPixelSize": 0,
  "maximumScale": 0,
  "heightReference": 0,
  "shadows": 0,
  "silhouetteColor": DC.Color.RED,
  "silhouetteSize": 0,
  "lightColor": DC.Color.RED,
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  }
}

DC.CustomBillboard

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let billboard = new DC.CustomBillboard(position, '***/**.png')
billboard.size = [20, 20]

creation

  • constructor(position,icon)

    • parameters
    • {Position|String|Array|Object} position
    • {String} icon
    • returns billboard

properties

  • {Position|String|Array|Object} position
  • {String} icon
  • {Array<Number>} size

methods

  • setVLine(style)

  • setBottomCircle(radius,style,rotateAmount)

    • parameters
    • {Number} radius
    • {Object} style EllipseGraphics
    • {Number} rotateAmount
    • returns this

  • setStyle(style)

// style(optional)
{
  "heightReference": 0,
  "scale": 1,
  "pixelOffset": { "x": 0, "y": 0 },
  "rotation": 0,
  "translucencyByDistance": {
    "near": 0,
    "nearValue": 0,
    "far": 1,
    "farValue": 0
  },
  "scaleByDistance": {
    "near": 0,
    "nearValue": 0,
    "far": 1,
    "farValue": 0
  },
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  },
  "disableDepthTestDistance": 0
}

DC.CustomLabel

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let label = new DC.CustomLabel(position, 'test')

creation

  • constructor(position,text)

    • parameters
    • {Position|String|Array|Object} position
    • {String} text
    • returns label

properties

  • {Position|String|Array|Object} position
  • {String} text

methods

  • setVLine(style)

  • setBottomCircle(radius,style,rotateAmount)

    • parameters
    • {Number} radius
    • {Object} style EllipseGraphics
    • {Number} rotateAmount
    • returns this

  • setStyle(style)

// style(optional)
{
  "heightReference": 0,
  "scale": 1,
  "pixelOffset": { "x": 0, "y": 0 },
  "rotation": 0,
  "translucencyByDistance": {
    "near": 0,
    "nearValue": 0,
    "far": 1,
    "farValue": 0
  },
  "scaleByDistance": {
    "near": 0,
    "nearValue": 0,
    "far": 1,
    "farValue": 0
  },
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  },
  "disableDepthTestDistance": 0
}

DC.AttackArrow

Inherited from Overlay

example

let attackArrow = new DC.AttackArrow('-90.0,32.0;-94.0,36.0;-94.0,38.0')

creation

  • constructor(positions)

    • parameters
    • {String|Array<Position|Number|String|Object>} positions
    • returns attackArrow

properties

  • {String|Array<Position|Number|String|Object>} positions

methods

  • setStyle(style)

    • parameters
    • {Object} style Polygon
    • returns this

DC.DoubleArrow

Inherited from Overlay

example

let doubleArrow = new DC.DoubleArrow('-90.0,32.0;-94.0,36.0;-94.0,38.0')

creation

  • constructor(positions)

    • parameters
    • {String|Array<Position|Number|String|Object>} positions
    • returns doubleArrow

properties

  • {String|Array<Position|Number|String|Object>} positions

methods

  • setStyle(style)

    • parameters
    • {Object} style Polygon
    • returns this

DC.FineArrow

Inherited from Overlay

example

let fineArrow = new DC.FineArrow('-90.0,32.0;-94.0,36.0')

creation

  • constructor(positions)

    • parameters
    • {String|Array<Position|Number|String|Object>} positions
    • returns fineArrow

properties

  • {String|Array<Position|Number|String|Object>} positions

methods

  • setStyle(style)

    • parameters
    • {Object} style Polygon
    • returns this

DC.GatheringPlace

Inherited from Overlay

example

let gatheringPlace = new DC.GatheringPlace('-90.0,32.0;-94.0,36.0')

creation

  • constructor(positions)

    • parameters
    • {String|Array<Position|Number|String|Object>} positions
    • returns gatheringPlace

properties

  • {String|Array<Position|Number|String|Object>} positions

methods

  • setStyle(style)

    • parameters
    • {Object} style Polygon
    • returns this

DC.TailedAttackArrow

Inherited from Overlay

example

let tailedAttackArrow = new DC.TailedAttackArrow('-90.0,32.0;-94.0,36.0')

creation

  • constructor(positions)

    • parameters
    • {String|Array<Position|Number|String|Object>} positions
    • returns tailedAttackArrow

properties

  • {String|Array<Position|Number|String|Object>} positions

methods

  • setStyle(style)

    • parameters
    • {Object} style：Polygon
    • returns this

DC.BillboardPrimitive

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let billboard = new DC.BillboardPrimitive(position, '***/**.png')
billboard.size = [20, 20]

creation

  • constructor(position,icon)

    • parameters
    • {Position|String|Array|Object} position
    • {String} icon
    • returns billboard

properties

  • {Position|String|Array|Object} position
  • {String} icon
  • {Array<Number>} size: [width,height]

methods

  • setStyle(style)

    • parameters
    • {Object} style Billboard
    • returns this
// style(optional)
{
  "heightReference": 0,
  "scale": 1,
  "pixelOffset": { "x": 0, "y": 0 },
  "rotation": 0,
  "translucencyByDistance": {
    "near": 0,
    "nearValue": 0,
    "far": 1,
    "farValue": 0
  },
  "scaleByDistance": {
    "near": 0,
    "nearValue": 0,
    "far": 1,
    "farValue": 0
  },
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  },
  "disableDepthTestDistance": 0
}

DC.BounceBillboardPrimitive

Inherited from BillboardPrimitive

example

let position = new DC.Position(120, 20)
let billboard = new DC.BounceBillboardPrimitive(position, '***/**.png')
billboard.size = [20, 20]

creation

  • constructor(position,icon)

    • parameters
    • {Position|Number|String|Object} position
    • {String} icon
    • returns billboard

methods

  • setStyle(style)

    • parameters
    • {Object} style Billboard
    • returns this
// style(optional)
{
  "maxOffsetY": 10, //Maximum translation in vertical direction
  "offsetAmount": 0.1 //Vertical panning per frame
  // Other styles refer to BillboardPrimitive style
}

DC.DiffuseWallPrimitive

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let wall = new DC.DiffuseWallPrimitive(position, 2000, 1000)

creation

  • constructor(center, radius, height)

    • parameters
    • {Position|Number|String|Object} center
    • {Number} radius
    • {Number} height
    • returns wall

properties

  • {Position|Number|String|Object} center
  • {Number} radius
  • {Number} height

methods

  • setStyle(style)

    • parameters
    • {Object} style
    • returns this
// style(optional)
{
  "minRadius": 10,
  "minHeight": 30,
  "color": DC.Color.RED,
  "slices": 128,
  "speed": 10
}

DC.ElecEllipsoidPrimitive

Inherited from Overlay

example

let elecEllipsoid = new DC.ElecEllipsoidPrimitive('120,20',{x:2000,y:2000:z:2000})

creation

  • constructor(center,radius)

    • parameters
    • {String|Position|Array|Object} center
    • {Object} radius: {x:100,y:100,z:100}
    • returns elecEllipsoidPrimitive

properties

  • {String|Position|Array|Object} center
  • {Object} radius

methods

  • setStyle(style)

    • parameters
    • {Object} style
    • returns this
// style(optional)
{
  "speed": 5,
  "color": DC.Color.WHITE
}

DC.FlowLinePrimitive

Inherited from Overlay

example

let flowLinePrimitive = new DC.FlowLinePrimitive('120,20;120,30;122,30')

creation

  • constructor(positions,[asynchronous])

    • parameters
    • {String|Array<Position|Number|String|Object>} positions
    • returns flowLinePrimitive

properties

  • {String|Array<Position|Number|String|Object>} positions

methods

  • setStyle(style)

    • parameters
    • {Object} style
    • returns this
// style(optional)
{
  "speed": 5,
  "color": DC.Color.WHITE,
  "percent": 0.3,
  "gradient": 0.1
}

DC.LabelPrimitive

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let label = new DC.LabelPrimitive(position, 'test')

creation

  • constructor(position,text)

    • parameters
    • {Position|String|Array|Object} position
    • {String} text
    • returns label

properties

  • {Position|String|Array|Object} position
  • {String} text

methods

  • setStyle(style)

    • parameters
    • {Object} style Labels
    • returns this
// style(optional)
{
  "font": "30px sans-serif",
  "scale": 1,
  "pixelOffset": { "x": 0, "y": 0 },
  "heightReference": 0,
  "showBackground": false,
  "backgroundColor": DC.Color.BLACK,
  "backgroundPadding": { "x": 0, "y": 0 },
  "fillColor": DC.Color.BLACK,
  "outlineColor": DC.Color.WHITE,
  "outlineWidth": 0,
  "scaleByDistance": {
    "near": 0,
    "nearValue": 0,
    "far": 1,
    "farValue": 0
  },
  "translucencyByDistance": {
    "near": 0,
    "nearValue": 0,
    "far": 1,
    "farValue": 0
  },
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  },
  "disableDepthTestDistance": 0
}

DC.LightCylinderPrimitive

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let cylinder = new DC.LightCylinderPrimitive(position, 1000,1,100)

creation

  • constructor(center, length, topRadius, bottomRadius)

    • parameters
    • {Position|String|Array|Object} center
    • {Number} length
    • {Number} topRadius
    • {Number} bottomRadius
    • returns cylinder

properties

  • {Position|String|Array|Object} center
  • {Number} length
  • {Number} topRadius
  • {Number} bottomRadius

methods

  • setStyle(style)

    • parameters
    • {Object} style
    • returns this
// style(optional)
{
  "color": DC.Color.BLACK
}

DC.BounceLabelPrimitive

Inherited from LabelPrimitive

example

let position = new DC.Position(120, 20)
let label = new DC.BounceLabelPrimitive(position, 'test')

creation

  • constructor(position,text)

    • parameters
    • {Position|Number|String|Object} position
    • {String} text
    • returns label

methods

  • setStyle(style)

    • parameters
    • {Object} style Label
    • returns this
// style(optional)
{
  "maxOffsetY": 10, //Maximum translation in vertical direction
  "offsetAmount": 0.1 //Vertical panning per frame
  // Other styles refer to LabelPrimitive style
}

DC.ModelPrimitive

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let model = new DC.ModelPrimitive(position, '**/**.glb')

creation

  • constructor(position, modelUrl)

    • parameters
    • {Position|Number|String|Object} position
    • {String} modelUrl
    • returns model

properties

  • {Position|Number|String|Object} position
  • {String} modelUrl
  • {Promise} readyPromise readonly

methods

  • getMaterial(name)

    • parameters
    • {String} name
    • returns modelMaterial

  • getMesh(name)

    • parameters
    • {String} name
    • returns modelMesh

  • getNode(name)

    • parameters
    • {String} name
    • returns modelNode

  • getNodes()

    • returns array<ModelNode>

  • setStyle(style)

    • parameters
    • {Object} style Model
    • returns this
// style(optional)
{
  "scale": 1,
  "minimumPixelSize": 0,
  "maximumScale": 0,
  "heightReference": 0,
  "shadows": 0,
  "silhouetteColor": DC.Color.RED,
  "silhouetteSize": 0,
  "lightColor": DC.Color.RED,
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  }
}

DC.ModelCollectionPrimitive

Inherited from Overlay

example

let positions = '120,20;120,30;122,30'
let model = new DC.ModelCollectionPrimitive(positions, '**/**.glb')

creation

  • constructor(positions, modelUrl)

    • parameters
    • {Array<Position|String|Object>} positions
    • {String} modelUrl
    • returns model

properties

  • {Array<Position|String|Object>} positions
  • {String} modelUrl
  • {Array<Object>} attrs
  • {Promise} readyPromise readonly

methods

  • getModelInstance(instanceId)

    • parameters
    • {String} instanceId：Instance ID, the default is the index of the instance, which can be obtained through mouse events
    • returns modelInstance

  • getAttrByInstanceId(instanceId)

    • parameters
    • {String} instanceId：Instance ID, the default is the index of the instance, which can be obtained through mouse events
    • returns Object

  • setStyle(style)

    • parameters
    • {Object} style Model
    • returns this
// style(optional)
{
  "scale": 1,
  "minimumPixelSize": 0,
  "maximumScale": 0,
  "heightReference": 0,
  "shadows": 0,
  "silhouetteColor": DC.Color.RED,
  "silhouetteSize": 0,
  "lightColor": DC.Color.RED,
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  }
}

DC.PointPrimitive

Inherited from Overlay

example

let position = new DC.Position(120, 20)
let point = new DC.PointPrimitive(position)
point.setStyle({
  pixelSize: 10,
})

creation

  • constructor(position)

    • parameters
    • {Position|Number|String|Object} position：坐标
    • returns point

properties

  • {Position|Number|String|Object} position：坐标

methods

  • setStyle(style)

    • parameters
    • {Object} style Point
    • returns this
// style(optional)
{
  "pixelSize": 1,
  "heightReference": 0,
  "color": DC.Color.WHITE,
  "outlineColor": DC.Color.WHITE,
  "outlineWidth": 0,
  "scaleByDistance": {
    "near": 0,
    "nearValue": 0,
    "far": 1,
    "farValue": 0
  },
  "translucencyByDistance": {
    "near": 0,
    "nearValue": 0,
    "far": 1,
    "farValue": 0
  },
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  },
  "disableDepthTestDistance": 0
}

DC.PolylinePrimitive

Inherited from Overlay

example

let polyline = new DC.PolylinePrimitive('120,20;120,30')
polyline.setStyle({
  width: 10,
})

creation

  • constructor(positions)

    • parameters
    • {String|Array<Position|Number|String|Object>} positions
    • returns polyline

properties

  • {String|Array<Position|Number|String|Object>} positions
  • {Position} center readonly
  • {Number} distance readonly

methods

  • setStyle(style)

    • parameters
    • {Object} style Polyline
    • returns this
// style(optional)
{
  "width": 1,
  "material": DC.Color.WHITE,
  "clampToGround": false,
  "shadows": 0,
  "distanceDisplayCondition": {
    "near": 0,
    "far": Number.MAX_VALUE
  },
  "classificationType": 2,
  "zIndex": 0
}

DC.ScanCirclePrimitive

Inherited from Overlay

example

let scanCirclePrimitive = new DC.ScanCirclePrimitive('120,20', 1000)

creation

  • constructor(position,radius)

    • parameters
    • {String|Position|Array|Object} position
    • {Number} radius
    • returns scanCirclePrimitive

properties

  • {String|Position|Array|Object} position
  • {Number} radius

methods

  • setStyle(style)

    • parameters
    • {Object} style
    • returns this
// style(optional)
{
  "speed": 5,
  "color": DC.Color.WHITE
}

DC.TrailLinePrimitive

Inherited from Overlay

example

let trailLinePrimitive = new DC.TrailLinePrimitive('120,20;120,30;122,30')

creation

  • constructor(positions,[asynchronous])

    • parameters
    • {String|Array<Position|Number|String|Object>} positions
    • returns trailLinePrimitive

properties

  • {String|Array<Position|Number|String|Object>} positions

methods

  • setStyle(style)

    • parameters
    • {Object} style
    • returns this
// style(optional)
{
  "speed": 5,
  "color": DC.Color.WHITE
}

DC.WaterPrimitive

Inherited from Overlay

example

let water = new DC.WaterPrimitive('120,20;120,30;122,30')
water.setStyle({
  baseWaterColor: DC.Color.AQUA.withAlpha(0.3),
  normalMap: 'examples/images/icon/waterNormalsSmall.jpg',
  frequency: 1000.0,
  animationSpeed: 0.01,
  amplitude: 10,
  specularIntensity: 10,
})

creation

  • constructor(positions,[holes])

    • parameters
    • {String|Array<Position|Number|String|Object>} positions
    • {Array<Position|Number|String|Object>} holes
    • returns water

properties

  • {String|Array<Position|Number|String|Object>} positions

methods

  • setStyle(style)

    • parameters
    • {Object} style
    • returns this
// style(optional)
{
  "height": 1,
  "extrudedHeight": 0,
  "stRotation": 0,
  "outline": false,
  "closeTop": true,
  "closeBottom": true,
  "classificationType": 2,
  "baseWaterColor": DC.Color.WHITE,
  "blendColor": DC.Color.WHITE,
  "specularMap": "",
  "normalMap": "",
  "frequency": 1000,
  "animationSpeed": 0.03,
  "amplitude": 10,
  "specularIntensity": 10
}

DC.VideoPrimitive

Inherited from Overlay

example

let videoEl = new document.getElementById('video')
let videoPrimitive = new DC.VideoPrimitive('120,20;120,30;122,30', videoEl)

creation

  • constructor(positions,video)

    • parameters
    • {String|Array<Position|Number|String|Object>} positions
    • {Element} video
    • returns videoPrimitive

properties

  • {String|Array<Position|Number|String|Object>} positions
  • {Element} video