CIMCubeSDK v3.58.0

Class: GSMMLayer

Glodon.CIMCube.Layer. GSMMLayer

GSMMLayer图层

new GSMMLayer(opts)

GSMMLayer图层构造函数
Parameters:
Name Type Description
opts Object 图层配置参数
Properties
Name Type Argument Default Description
url String .gsmm文件的url;
assetsUrl String assets文件夹位置;
origin Array 图层原点在地球上的位置，用经纬度表示，例：[106.689936, 29.559434, 500.0]
offset Array 偏移量，单位米，例：[1000.0, 500.0, 100.0]
rotation Array 旋转参数（右手坐标系，第一个元素绕X轴旋转指定角度，第二个元素绕Y轴旋转指定角度，第三个元素绕Z轴旋转指定角度）
scale Number <optional>
 1 图层放大与缩小比例
luminanceAtZenith Number <optional>
 0.2 光源亮度
gamma Number <optional>
 1 伽马值,默认为：1
contrast Number <optional>
 1 对比度,默认为：1
hue Number <optional>
 0.0 颜色的色相 (H)SB；值范围：-PI~PI
saturation Number <optional>
 1.0 颜色的饱和度 H(S)B；值范围：0~2
brightness Number <optional>
 1.0 颜色的明度 HS(B)；值范围：0~2
metallicRoughnessFactor Array 金属度|粗糙度调整;建议用在白膜上,会替换材质中原本金属度|粗糙度; 例：[0.5,0.5];取值范围:0~1
doubleSided Boolean <optional>
 图层是否使用双面材质, 会覆盖图层内部材质的双面属性, 该值
shadowMode ShadowMode <optional>
 ShadowMode.DISABLED 阴影模式
color Color 吊绳的颜色,默认#191919
slices Number <optional>
 16 吊绳的绘制精细程度
dynamicPoint Object 动态点特效
Properties
Name Type Argument Default Description
show Boolean 是否显示
type String <optional>
 "breathe" 特效类型,：呼吸特效
color Color 特效颜色,默认rgba(0,127.5,255,1.0)
duration Number <optional>
 2.0 特效时长(单位秒)
delay Number <optional>
 1.0 特效间隔时长(单位秒)
radius Number <optional>
 1 特效半径，m
points Array 特效点坐标数组,模型坐标：[{Cartesian3},Cartesian3,...]

Extends

Members

alpha :Number

透明度 0.0~1.0
Type:
  • Number
Overrides:

boundingVolumeOrigin :*

包围体，取有向包围盒
Type:
  • *

boxColor :Color

包围盒颜色
Type:
  • Color

brightness :Number

明度调整
Type:
  • Number

cacheable :Boolean

是否可缓存
Type:
  • Boolean
Inherited From:
Overrides:

canHighlight :Boolean

可否高亮
Type:
  • Boolean
Inherited From:
Overrides:

canSelected :Boolean

可否被选中
Type:
  • Boolean
Inherited From:
Overrides:

colorMode :String

色彩模式调整
Type:
  • String

contrast :Number

对比度调整
Type:
  • Number

debugShowBoundingSphere :Boolean

是否显示包围球
Type:
  • Boolean

dragCenter :Cartesian3

拖拽中心
Type:
  • Cartesian3

enableMouseMove :Boolean

是否可以触发鼠标移动事件
Type:
  • Boolean
Inherited From:
Overrides:
Default Value:
  • true

gamma :Number

伽马值调整
Type:
  • Number

glowColor :String

发光颜色
Type:
  • String
Inherited From:
Overrides:

glowTimeInterval :number

闪烁的时间间隔
Type:
  • number
Inherited From:
Overrides:

gsmm :GSMM

返回封装的gsmm对象
Type:
  • GSMM

hiddenInLayerTree :Boolean

是否对图层树接口隐藏
Type:
  • Boolean
Inherited From:
Overrides:

hue :Number

色相调整
Type:
  • Number

<readonly> id :String

id
Type:
  • String
Inherited From:
Overrides:

inverseTransformMatrix4 :Matrix4

模型逆变换矩阵
Type:
  • Matrix4

isGSMMLayer :Boolean

标识当前图层为 GSMM 图层
Type:
  • Boolean

isPipeline :Boolean

数据是否是管线类型
Type:
  • Boolean
Inherited From:
Overrides:

lightColor :ArrayList|Color

光颜色调整
Type:
  • ArrayList | Color

loader :GSMM

GSMM 加载器
Type:
  • GSMM

luminanceAtZenith :Number

图层光源亮度
Type:
  • Number

matrix :Object

图层偏移
Type:
  • Object
Inherited From:
Overrides:

metallicRoughnessFactor :ArrayList

金属度与粗糙度调整;建议用在白膜上,会替换材质中原本金属度|粗糙度; 例：[0.5,0.5];取值范围:0~1
Type:
  • ArrayList

name :String

图层名称
Type:
  • String
Inherited From:
Overrides:

offset :Array

获取偏移量,第一个元素表示向东偏移的距离，第二个元素表示向北偏移的距离，第三个元素表示向上偏移的距离，单位米
Type:
  • Array

origin :Array.<Number>

图层原点在地球上的位置，用经纬度表示，例：[106.689936, 29.559434, 500.0]
Type:
  • Array.<Number>

pickable :Boolean

pickable
Type:
  • Boolean
Inherited From:
Overrides:

ready :Boolean

图层是否已就绪
Type:
  • Boolean
Overrides:

root :*

根节点
Type:
  • *

rotation :Array.<Number>

旋转参数（右手坐标系，第一个元素绕X轴旋转指定角度，第二个元素绕Y轴旋转指定角度，第三个元素绕Z轴旋转指定角度）
Type:
  • Array.<Number>

rotationPointOffset :Cartesian3

图层指定的旋转点，模型坐标系下基于原点的偏移点，默认是包围盒中心点
Type:
  • Cartesian3
Inherited From:
Overrides:

saturation :Number

饱和度调整
Type:
  • Number

scale :Number

缩放比例系数
Type:
  • Number
Default Value:
  • 1

selectedColor :String

选中颜色
Type:
  • String
Inherited From:
Overrides:

shadowMode :ShadowMode

阴影模式
Type:
  • ShadowMode

show :Boolean

图层是否显示
Type:
  • Boolean
Overrides:

showOrientedBoundingBox :Boolean

显示|隐藏有向包围盒
Type:
  • Boolean

transform :Matrix4

模型变换矩阵
Type:
  • Matrix4

<readonly> type :String

图层类型
Type:
  • String
Inherited From:
Overrides:

<readonly> url :String

图层url地址
Type:
  • String
Inherited From:
Overrides:

Methods

addDragHandle( [options])

在场景中添加操作句柄
Parameters:
Name Type Argument Description
options Object <optional>
 配置参数
Properties
Name Type Argument Default Description
dragModelTipUI DragModelTipUI <optional>
 自定义的tip ui实例
tips String <optional>
 '单击鼠标左键选择需要操作的模型' 提示字符
showTips Boolean <optional>
 true 是否显示提示字符
dragModelUI DragModelUI <optional>
 自定义的模型实例
enableTranslationX Boolean <optional>
 true X轴平移
enableTranslationY Boolean <optional>
 true Y轴平移
enableTranslationZ Boolean <optional>
 true Z轴平移
enableTranslationXY Boolean <optional>
 true XOY面平移
enableTranslationYZ Boolean <optional>
 true YOZ面平移
enableTranslationXZ Boolean <optional>
 true XOZ面平移
enableRotationX Boolean <optional>
 true X轴旋转
enableRotationY Boolean <optional>
 true Y轴旋转
enableRotationZ Boolean <optional>
 true Z轴旋转
enableScaleX Boolean <optional>
 false X缩放
enableScaleY Boolean <optional>
 false Y缩放
enableScaleZ Boolean <optional>
 false Z缩放
targetScaleRange Array.<Number> <optional>
 默认 [0.1, +infinity]
axisTranslationYColor String <optional>
 "red" axisTranslationYColor
axisTranslationXColor String <optional>
 "green" axisTranslationXColor
axisTranslationZColor String <optional>
 "blue" axisTranslationZColor
axisTranslationXYColor String <optional>
 "red" axisTranslationXYColor
axisTranslationYZColor String <optional>
 "green" axisTranslationYZColor
axisTranslationXZColor String <optional>
 "blue" axisTranslationXZColor
axisRotationXColor String <optional>
 "red" axisRotationXColor
axisRotationYColor String <optional>
 "green" axisRotationYColor
axisRotationZColor String <optional>
 "blue" axisRotationZColor
axisScaleXColor String <optional>
 "red" axisScaleXColor
axisScaleYColor String <optional>
 "green" axisScaleYColor
axisScaleZColor String <optional>
 "blue" axisScaleZColor
continueEdit Boolean <optional>
 false 是否持续编辑，即点击下个对象将会让组件转移到其上
UIScaling Number <optional>
 1.0 缩放UI的系数，engine会忽略小于等于0的数字
noUI Boolean <optional>
 false 是否不创建UI
Overrides:
  • Glodon.CIMCube.Layer.BaseLayer#addDragHandle
Returns:
拖拽句柄
Type
Object

addTo(map)

将图层添加到图层管理器中
Parameters:
Name Type Description
map Glodon.CIMCube 地图实例
Inherited From:
Overrides:

dispatchEvent(event)

在此事件派发器上派发事件.
Parameters:
Name Type Description
event Object 待派发的事件.
Inherited From:
Overrides:

dispose()

释放资源

enableDynamicPointEffect(enable)

动态点特效
Parameters:
Name Type Description
enable Boolean 是否开启动态点特效

flyTo()

摄像机定位到图层

getAllChildren()

获取全部子组件。
Returns:
子组件集合
Type
* | undefined

getBoundingSphere()

获取包围球。
Returns:
包围球
Type
* | undefined

getChildByID(id)

获取图层子组件
Parameters:
Name Type Description
id String 子组件id
Returns:
子组件
Type
Object

getOrientedBoundingBox()

获取有向包围盒。
Returns:
有向包围盒
Type
* | undefined

getOriginWorldCoord()

获取图层原点坐标
Returns:
图层原点坐标
Type
Cartesian3

getParentId()

获取父节点ID
Inherited From:
Overrides:
Returns:
父节点ID
Type
String

localToWorldPosition(localPosition)

通过模型局部坐标获取世界坐标
Parameters:
Name Type Description
localPosition Cartesian3 模型局部坐标
Returns:
模型世界坐标
Type
Cartesian3

move(angle, distance [, mode])

指定角度移动, 顺时针旋转
Parameters:
Name Type Argument Default Description
angle Number 表示指定角度, 单位：度; y-x的0度为正北, z-x的0度为垂直地表向外, z-y的0度为垂直地表向外;
distance Number 移动的距离, 单位：米;
mode String <optional>
 "y-x" 指定平面内进行移动; 枚举值：y-x、z-x、z-y;
Returns:
图层offset
Type
Array

removeDragHandle()

在场景中移除操作句柄
Inherited From:
Overrides:

removeFrom(callByManager)

从地图上移除图层。
Parameters:
Name Type Description
callByManager Boolean 是否由图层管理器调用
Overrides:

setDynamicPointEffect(opts)

设置动态点特效参数
Parameters:
Name Type Description
opts Object 特效参数
Properties
Name Type Argument Default Description
type String <optional>
 "breathe" 特效类型,：呼吸特效
color Color 特效颜色,默认rgba(0,127.5,255,1.0)
duration Number <optional>
 2.0 特效时长(单位秒)
delay Number <optional>
 1.0 特效间隔时长(单位秒)
radius Number <optional>
 1 特效半径，m
points Array 特效点坐标数组,模型坐标,最多支持16个点：[{Cartesian3},Cartesian3,...]

updateModelMatrix()

更新Node的位置

updateWeight(id, repeatCount)

更新配重
Parameters:
Name Type Description
id String ID
repeatCount Number 重复次数

worldPositionToLocal(worldPosition)

通过世界坐标获取模型模型局部坐标
Parameters:
Name Type Description
worldPosition Cartesian3 模型世界坐标
Returns:
模型局部坐标
Type
Cartesian3

Events

LOADED

数据加载完成后触发
Example
layer.on(Glodon.CIMCube.Global.Defines.LayerEventType.LOADED, function (event) {
 console.log(event);
})

TRANSFORM_CHANGED

图层变换矩阵发生变化后触发
Example
layer.on(Glodon.CIMCube.Global.Defines.LayerEventType.TRANSFORM_CHANGED, function (event) {
 console.log(event);
})