TilesetLayer

new mars3d.layer.TilesetLayer(options)

3dtiles 三维模型图层。

参数名称 类型 默认值 描述信息
options object {} 可选

参数对象, 构造参数建议从模型编辑页面设置后保存参数后拷贝json参数即可。参数包括以下:

参数名称 类型 默认值 描述信息
url string | Cesium.Resource 可选

tileset的主JSON文件的 url

maximumScreenSpaceError number 16 可选

用于驱动细化细节级别的最大屏幕空间错误。可以简单理解为:数值加大,能让最终成像变模糊。

assetId number 可选

ion资源时对应的assetId

ionToken string Cesium.Ion.defaultAccessToken 可选

ion资源时对应的token

ionServer string | Cesium.Resource Cesium.Ion.defaultServer 可选

ion资源时对应的server

maxMemory number 1024 可选

最大缓存内存大小(MB), 内部换算给 cacheBytes = maxMemory10241024、maximumCacheOverflowBytes = cacheBytes * 1.5 (另:如果同时配置了cacheBytes、maximumMemoryUsage时该参数无效)

cacheBytes number 可选

如果缓存包含当前视图不需要的块,则块缓存将被修剪到的大小(以字节为单位)。

maximumCacheOverflowBytes number 可选

最大显存大小(以字节为单位)。

maximumMemoryUsage number 可选

【cesium 1.107+弃用】数据集可以使用的最大内存量(以MB计),这个参数要根据当前客户端显卡显存来配置,如果我们场景只显示这一个模型数据,这个可以设置到显存的50% 左右,比如我的显存是4G,这个可以设置到2048左右。那么既保证不超过显存限制,又可以最大利用显存缓存。

position object 可选

自定义新的中心点位置(移动模型)

参数名称 类型 描述信息
lng number 可选

经度值, -180 至 180

lat number 可选

纬度值, -90 至 90

alt number 可选

高度值(单位:米)

alt_offset number 可选

相对于模型本身高度的偏移值(单位:米) ,如果有alt时已alt优先。

rotation object 可选

自定义旋转方向(旋转模型)

参数名称 类型 描述信息
x number

X方向,角度值0至360

y number

Y方向,角度值0至360

z number

四周方向,角度值0至360

modelMatrix Cesium.Matrix4 可选

模型的矩阵位置,内部无坐标位置的模型使用,此时position和rotation等参数均无效。

updateMatrix function 可选

外部自定义修复模型矩阵位置

scale number 1 可选

自定义缩放比例,整体等比例缩放

scaleX number 1 可选

单独自定义缩放X轴方向比例

scaleY number 1 可选

单独自定义缩放Y轴方向比例

scaleZ number 1 可选

单独自定义缩放Z轴方向比例

axis string | Cesium.Axis 可选

自定义轴方向

style object | Cesium.Cesium3DTileStyle | function 可选

模型样式, 使用3D Tiles Styling language.

marsJzwStyle boolean | object | string false 可选

开启或设置建筑物特效样式,object时可以修改内置shader的3个变量,比如: { baseHeight: 50.0, heightRange: 380.0, glowRange: 400.0 },

customShader Cesium.CustomShader 可选

自定义shader效果

editUpAxis Cesium.Axis Cesium.Axis.Z 可选

标识模型的轴方向(建筑物特效、模型压平等功能中使用)

matrixMove MatrixMove.Options 可选

右键菜单中,按轴平移时,传入给MatrixMove对象的构造参数

matrixRotate MatrixRotate.Options 可选

右键菜单中,按轴旋转时,传入给MatrixRotate对象的构造参数

highlight object | Outline.Options 可选

高亮及其样式配置

参数名称 类型 默认值 描述信息
type string 可选

鼠标移入高亮 或 单击高亮(type:'click')

enabled boolean true 可选

是否启用

color string | function '#FFFF00' 可选

颜色,支持rgba字符串

outlineEffect boolean false 可选

默认为修改矢量对象本身的style高亮,true时采用Outline方式高亮。

filter function 可选

可以设置筛选排除一些构件, 排除的构件在filter方法内返回false

all boolean 可选

是否按整体高亮, true:模型整体全部高亮,false:单个构件高亮

uniqueKey string 可选

按指定字段进行对应相关构件的整体高亮,对outlineEffect时无效

allowDrillPick boolean | function | string 可选

是否允许鼠标穿透拾取. 字符串时为固定内置判断,目前有: "alpha":鼠标不拾取前面遮挡的透明的构件,穿透拾取其后方不透明构件。

clampToGround boolean 可选

是否贴地,为 true 时自动调用贴地计算,但此属性只适合标准的与地形数据匹配的模型,并不精确,建议通过模型编辑页面调试给具体高度值。

chinaCRS ChinaCRS 可选

标识模型的国内坐标系(用于自动纠偏或加偏)

clip object 可选

模型裁剪 对象, 可传入TilesetClip构造参数

flat object 可选

模型压平 对象, 可传入TilesetFlat构造参数

flood object 可选

模型淹没 对象, 可传入TilesetFlood构造参数

planClip object 可选

模型Plan裁剪 对象, 可传入TilesetPlanClip构造参数

colorCorrection object 可选

颜色校正 对象, 可传入TilesetColorCorrection构造参数

modelUpAxis Cesium.Axis Cesium.Axis.Y 可选

加载瓦片内容中的模型时,哪个轴被视为上方向。

modelForwardAxis Cesium.Axis Cesium.Axis.X 可选

加载瓦片内容中的模型时,哪个轴被视为前方向。

shadows Cesium.ShadowMode ShadowMode.ENABLED 可选

确定瓦片集是否投射或接收来自光源的阴影。

cullWithChildrenBounds boolean true 可选

优化选择。是否使用子包围盒的并集来剔除瓦片。

cullRequestsWhileMoving boolean true 可选

优化选择。相机移动时不要请求瓦片,因为返回时可能已不再使用。此优化仅适用于固定瓦片集。

cullRequestsWhileMovingMultiplier number 60.0 可选

优化选择。相机移动时用于剔除请求的乘数。值越大剔除越激进,值越小剔除越宽松。

preloadWhenHidden boolean false 可选

为 true 时,即使 tileset.show 为 false 也预加载数据。

preloadFlightDestinations boolean true 可选

优化选择。相机飞行时,在飞行目的地预加载瓦片。

preferLeaves boolean false 可选

优化选择。优先加载叶子节点数据。默认 false。同等条件下叶子节点会优先加载,但 Cesium 的瓦片加载优先级还受其他条件影响;如果 skipLevelOfDetail=false,此参数几乎无意义,需配合 skipLevelOfDetail=true 使用,以便尽快看到符合当前视觉精度的瓦片。

dynamicScreenSpaceError boolean true 可选

优化选择。在街景/地平线视角下,对远离相机的瓦片使用较低分辨率,从而减少加载数据量、缩短瓦片集加载时间,代价是远处视觉质量略有下降。

dynamicScreenSpaceErrorDensity number 2.0e-4 可选

与 Cesium.Fog#density 类似,控制 dynamicScreenSpaceError 优化生效的相机距离。值越大,受影响的瓦片离相机越近。

dynamicScreenSpaceErrorFactor number 24.0 可选

控制 dynamicScreenSpaceError 优化对地平线附近瓦片的强度。值越大,加载的瓦片分辨率越低,可提升运行时性能,但视觉质量略有下降。

dynamicScreenSpaceErrorHeightFalloff number 0.25 可选

瓦片集高度的比例,用于确定“街景”相机的出现位置。相机低于此高度时,dynamicScreenSpaceError 优化效果最大;高于此值后逐渐减弱。

progressiveResolutionHeightFraction number 0.3 可选

优化选择。取值在 (0.0, 0.5] 之间时,屏幕空间误差达到 progressiveResolutionHeightFraction*screenHeight 缩小分辨率阈值的瓦片会优先加载,从而快速显示一层瓦片,同时继续加载全分辨率瓦片。

foveatedScreenSpaceError boolean true 可选

优化选择。通过临时提高屏幕边缘瓦片的屏幕空间误差,优先加载屏幕中央的瓦片。当由 Cesium.Cesium3DTileset#foveatedConeSize 确定的屏幕中央瓦片全部加载后,屏幕空间误差恢复正常。

foveatedConeSize number 0.1 可选

优化选择。当 foveatedScreenSpaceError 为 true 时使用,控制决定哪些瓦片延迟加载的锥体大小。锥体内的瓦片会立即加载;锥体外的瓦片可能根据其偏离锥体的距离和屏幕空间误差被延迟,由 Cesium.Cesium3DTileset#foveatedInterpolationCallback 和 Cesium.Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation 控制。设为 0.0 时,锥体退化为相机位置与视线方向形成的线;设为 1.0 时,锥体覆盖相机整个视场,效果关闭。

foveatedMinimumScreenSpaceErrorRelaxation number 0.0 可选

优化选择。当 foveatedScreenSpaceError 为 true 时使用,控制中心锥体以外瓦片的初始屏幕空间误差松弛量。屏幕空间误差会从瓦片集的值开始,根据 foveatedInterpolationCallback 逐步提高到 Cesium.Cesium3DTileset#maximumScreenSpaceError。

foveatedInterpolationCallback Cesium.Cesium3DTileset.foveatedInterpolationCallback Math.lerp 可选

优化选择。当 foveatedScreenSpaceError 为 true 时使用,控制中心锥体以外瓦片屏幕空间误差的提高幅度,在 Cesium.Cesium3DTileset#foveatedMinimumScreenSpaceErrorRelaxation 和 Cesium.Cesium3DTileset#maximumScreenSpaceError 之间插值。

foveatedTimeDelay number 0.2 可选

优化选择。当 foveatedScreenSpaceError 为 true 时使用,控制相机停止移动后等待多少秒再开始加载被延迟的瓦片。该延迟可避免相机移动时请求屏幕边缘的瓦片;设为 0.0 会立即请求当前视图中的所有瓦片。

skipLevelOfDetail boolean false 可选

优化选择。确定遍历过程中是否应用细节级别跳过。开启后可跳过部分层级,提升加载效率、减少数据占用,但可能出现加载过程中的闪烁或异常面片(相邻 LOD 数据差异较大导致)。设为 false 时过渡更平滑,但清晰数据等待更久;若某个瓦片请求失败,还可能一直无法细化。建议网络条件好、数据量小时设为 false 以提升显示质量。

baseScreenSpaceError number 1024 可选

当 skipLevelOfDetail 为 true 时,跳过细节级别之前必须达到的屏幕空间误差。

skipScreenSpaceErrorFactor number 16 可选

当 skipLevelOfDetail 为 true 时,定义跳过所需最小屏幕空间误差的乘数,与 skipLevels 配合决定加载哪些瓦片。

skipLevels number 1 可选

当 skipLevelOfDetail 为 true 时,定义加载瓦片时最少跳过的层级数;为 0 时不跳过任何层级。与 skipScreenSpaceErrorFactor 配合决定加载哪些瓦片。

immediatelyLoadDesiredLevelOfDetail boolean false 可选

当 skipLevelOfDetail 为 true 时,只下载满足最大屏幕空间误差的瓦片,忽略跳过系数,仅加载所需瓦片。

loadSiblings boolean false 可选

当 skipLevelOfDetail 为 true 时,确定遍历过程中是否总是下载可见瓦片的兄弟瓦片。

clippingPlanes Cesium.ClippingPlaneCollection 可选

Cesium.ClippingPlaneCollection 用于选择性地禁用瓦片集的渲染。

clippingPolygons Cesium.ClippingPolygonCollection 可选

Cesium.ClippingPolygonCollection 用于选择性地禁用瓦片集的渲染。

classificationType Cesium.ClassificationType 可选

确定地形、3D Tiles 还是两者都要被此瓦片集分类。关于限制和约束的详细信息,请参阅 Cesium.Cesium3DTileset#classificationType。

heightReference Cesium.HeightReference 可选

为矢量瓦片中的要素设置高度参考。贴地/贴模型时还需同时传入 scene。

scene Cesium.Scene 可选

渲染瓦片集的场景;矢量瓦片按 heightReference 贴地/贴模型时必传,通常为 map.scene。

ellipsoid Cesium.Ellipsoid Ellipsoid.WGS84 可选

确定地球大小和形状的椭球体。

pointCloudShading object 可选

用于构造 Cesium.PointCloudShading 对象以控制点云衰减和光照的选项。

lightColor Cesium.Cartesian3 可选

为模型着色时使用的光源颜色;为 undefined 时使用场景的光源颜色。该值表示 RGB 倍数,例如 new Cesium.Cartesian3(100.0, 100.0, 100.0) 表示白光增强到 100 倍。对 PBR 材质有效,倾斜摄影不生效。

imageBasedLighting Cesium.ImageBasedLighting 可选

用于管理基于图像的光源的属性。

environmentMapOptions object 可选

动态环境贴图的配置,用于 PBR 光照,可传入 Cesium.DynamicEnvironmentMapManager 构造参数(Cesium 1.146)。

backFaceCulling boolean true 可选

是否剔除背面几何体。为 true 时,背面剔除由 glTF 材质的 doubleSided 属性决定;为 false 时禁用背面剔除。

enableCollision boolean false 可选

是否启用拾取碰撞,贴模型时需要开启。当 Cesium.ScreenSpaceCameraController#enableCollisionDetection 为 true 时,相机会被阻止进入模型表面以下。

opaquePass object | number Cesium.Pass.OPAQUE 可选

设置渲染通道,在实际使用中,对于模型的不透明部分,应该将DrawCommand的pass属性设置为Cesium.Pass.OPAQUE,这样 Cesium 的渲染器就会在处理不透明物体的阶段渲染该部分,保证渲染顺序和深度检测等机制正常工作。

renderState object 可选

可选渲染状态,以覆盖模型内部默认渲染状态。

enableShowOutline boolean true 可选

是否启用模型的轮廓 CESIUM_primitive_outline 扩展。设为 false 可避免在加载时对几何体进行额外处理;为 false 时,showOutline 和 outlineColor 选项将被忽略。

showOutline boolean true 可选

是否显示模型的轮廓 CESIUM_primitive_outline 扩展。为 true 时显示轮廓,为 false 时不显示。

outlineColor Cesium.Color Color.BLACK 可选

渲染轮廓时使用的颜色。

vectorClassificationOnly boolean false 可选

是否只应使用瓦片集的向量瓦片进行分类。

vectorKeepDecodedPositions boolean false 可选

矢量瓦片是否在内存中保留解码后的位置。与 Cesium.Cesium3DTileFeature#getPolylinePositions 配合使用。

vectorBlendOption Cesium.BlendOption Cesium.BlendOption.TRANSLUCENT 可选

矢量图元与场景的混合方式,取值为 OPAQUE 或 TRANSLUCENT;不支持 OPAQUE_AND_TRANSLUCENT。

featureIdLabel string | number "featureId_0" 可选

用于拾取和样式的要素 ID 集标签。对于 EXT_mesh_features,它是要素 ID 的 label 属性;未指定时为 "featureId_N"(N 为 featureIds 数组中的索引)。EXT_feature_metadata 没有 label 字段,因此此类要素 ID 集始终标记为 "featureId_N",其中 N 为所有要素 ID 列表中的索引,要素 ID 属性排在要素 ID 纹理之前。如果 featureIdLabel 是整数 N,会自动转换为字符串 "featureId_N"。如果同时存在逐图元和逐实例的要素 ID,则实例要素 ID 优先。

instanceFeatureIdLabel string | number "instanceFeatureId_0" 可选

用于拾取和样式的实例要素 ID 集标签。如果 instanceFeatureIdLabel 设置为整数 N,会自动转换为字符串 "instanceFeatureId_N"。如果同时存在逐图元和逐实例的要素 ID,则实例要素 ID 优先。

showCreditsOnScreen boolean false 可选

是否在屏幕上显示此瓦片集的版权信息。

splitDirection Cesium.SplitDirection SplitDirection.NONE 可选

卷帘对比时,设置所在的屏幕,NONE 时不分屏

projectTo2D boolean false 可选

是否将瓦片集精确投影到 2D。为 true 时,瓦片集会精确投影到 2D,但会占用更多内存;为 false 时,内存占用更少,仍可在 2D/CV 模式下渲染,但投影位置可能不准确。瓦片集加载后不能再设置此选项。

enablePick boolean false 可选

是否在 WebGL1 下允许 CPU 拾取;WebGL2+ 会忽略。开启会增加内存占用,瓦片集加载后不能再设置。

asynchronouslyLoadImagery boolean false 可选

覆盖在瓦片集上的影像是否异步加载。为 true 时先显示原始纹理,影像就绪后再替换;为 false 时等影像就绪后才显示瓦片内容。

debugHeatmapTilePropertyName string 可选

作为热力图着色的瓦片变量名。所有渲染的瓦片都会相对于彼此的指定变量值着色。

debugFreezeFrame boolean false 可选

仅供调试。确定是否只使用上一帧的瓦片进行渲染。

debugColorizeTiles boolean false 可选

仅供调试。为 true 时,为每个瓦片分配随机颜色。

enableDebugWireframe boolean false 可选

仅供调试。在 WebGL1 中必须为 true,debugWireframe 才能生效;瓦片集创建后不能再设置。

debugWireframe boolean false 可选

仅供调试。为 true 时,将每个瓦片的内容渲染为线框。

edgeDisplayMode Cesium.EdgeDisplayMode Cesium.EdgeDisplayMode.SURFACES_ONLY 可选

控制 glTF EXT_mesh_primitive_edge_visibility 扩展的边缘相对于表面几何的渲染方式。

debugShowBoundingVolume boolean false 可选

仅供调试。为 true 时,渲染每个瓦片的包围盒。

debugShowContentBoundingVolume boolean false 可选

仅供调试。为 true 时,渲染每个瓦片内容的包围盒。

debugShowViewerRequestVolume boolean false 可选

仅供调试。为 true 时,渲染每个瓦片的查看者请求包围盒。

debugShowGeometricError boolean false 可选

仅供调试。为 true 时,绘制标签以显示每个瓦片的几何误差。

debugShowRenderingStatistics boolean false 可选

仅供调试。为 true 时,绘制标签以显示每个瓦片的命令、点、三角形和要素数量。

debugShowMemoryUsage boolean false 可选

仅供调试。为 true 时,绘制标签以显示每个瓦片使用的纹理和几何体内存(MB)。

debugShowUrl boolean false 可选

仅供调试。为 true 时,绘制标签以显示每个瓦片的 URL。

popup string | Array.<Globe.getTemplateHtml_template> | function 可选

绑定的 popup 弹窗值,也可以bindPopup方法绑定,支持:'all'、数组、字符串模板

popupOptions Popup.StyleOptions 可选

popup弹窗时的配置参数,也支持如 pointerEvents 等 Popup 构造参数,还包括:

参数名称 类型 默认值 描述信息
title string 可选

固定的标题名称

titleField string 可选

标题对应的属性字段名称

noTitle string 可选

不显示标题

showNull string false 可选

是否显示空值

tooltip string | Array.<Globe.getTemplateHtml_template> | function | object 可选

绑定的tooltip弹窗值,也可以bindTooltip方法绑定,参数与popup属性完全相同。

tooltipOptions Tooltip.StyleOptions 可选

tooltip弹窗时的配置参数,也支持如pointerEvents等Tooltip构造参数,还包括:

参数名称 类型 默认值 描述信息
title string 可选

固定的标题名称

titleField string 可选

标题对应的属性字段名称

noTitle string 可选

不显示标题

showNull string false 可选

是否显示空值

contextmenuItems object 可选

绑定的右键菜单值,也可以bindContextMenu方法绑定

hasEdit boolean true 可选

是否允许编辑

isAutoEditing boolean false 可选

是否自动激活编辑

hasEditContextMenu boolean true 可选

编辑时,是否绑定右键编辑菜单

hasEditRevoke boolean true 可选

编辑时,是否记录编辑步骤中坐标记录,用于还原或撤销编辑,且需要transform是true的模型才支持编辑

proxy string 可选

加载资源时要使用的代理服务url。

queryParameters object 可选

一个对象,其中包含在检索资源时将发送的查询参数。比如:queryParameters: {'access_token': '123-435-456-000'},

headers object 可选

一个对象,将发送的其他HTTP标头。比如:headers: { 'X-My-Header': 'valueOfHeader' },

id string | number mars3d.Util.createGuid() 可选

图层id标识

pid string | number 可选

图层父级的id,一般图层管理中使用

name string 可选

图层名称

show boolean true 可选

图层是否显示

eventParent BaseClass | boolean 可选

指定的事件冒泡对象,默认为map对象,false时不冒泡

center object 可选

图层自定义定位视角 Map#setCameraView

参数名称 类型 描述信息
lng number

经度值, -180至180

lat number

纬度值, -90至90

alt number 可选

高度值

heading number 可选

方向角度值,绕垂直于地心的轴旋转角度, 0至360

pitch number 可选

俯仰角度值,绕纬度线旋转角度, -90至90

roll number 可选

翻滚角度值,绕经度线旋转角度, -90至90

flyTo boolean 可选

加载完成数据后是否自动飞行定位到数据所在的区域。

flyToOptions object 可选

加载完成数据后是否自动飞行定位到数据所在的区域的对应 BaseLayer#flyTo方法参数。

参考:

继承自

属性值

allowDrillPick : boolean|function

是否允许鼠标穿透拾取

alt : number

调整修改模型高度

availability : Cesium.TimeIntervalCollection

指定时间范围内显示该对象 [提示:仅部分子类实现,非所有对象都支持]

继承自:
使用示例:
// 普通传值方式,多个【建议】
layer.availability = [
  { start: "2017-08-25 08:00:00", stop: "2017-08-25 08:01:20", isStartIncluded: true, isStopIncluded: false },
  { start: "2017-08-25 09:00:00", duration: 10 } //支持不配置stop,直接配置duration秒数时长
]
// 也支持相对时间的 秒数 传值(相对于map.clock.startTime)
layer.availability = [
  { start: 0, stop: 10, isStartIncluded: true, isStopIncluded: false },
  { start:30, duration: 10 } //支持不配置stop,直接配置duration秒数时长
]

// 普通传值方式,单个
layer.availability = { start: "2017-08-25 08:00:00", stop: "2017-08-25 08:01:20", isStartIncluded: true, isStopIncluded: false }


// cesium原生写法, 多个
layer.availability = new Cesium.TimeIntervalCollection([
  new Cesium.TimeInterval({
    start: Cesium.JulianDate.fromDate(new Date("2017-08-25 08:00:00")),
    stop: Cesium.JulianDate.fromDate(new Date("2017-08-25 08:00:20")),
    isStartIncluded: true,
    isStopIncluded: false
  }),
])

// cesium原生写法,单个
layer.availability = new Cesium.TimeInterval({
  start: Cesium.JulianDate.fromDate(new Date("2017-08-25 08:00:00")),
  stop: Cesium.JulianDate.fromDate(new Date("2017-08-25 08:00:20")),
  isStartIncluded: true,
  isStopIncluded: false
})

axis : string|Cesium.Axis

轴方向

只读 boundingSphere : Cesium.BoundingSphere

模型的边界球体。

center : LngLatPoint

模型当前中心点坐标

使用示例:
tiles3dLayer.readyPromise.then(() => {
  console.log("模型加载完成", tiles3dLayer)
  const center = tiles3dLayer.center
})

只读 clip : TilesetClip

模型裁剪 对象

只读 colorCorrection : TilesetColorCorrection

颜色校正 对象

customShader : Cesium.CustomShader

自定义shader效果,
如果默认无customShader,加载模型后动态修改customShader值

enabledEvent : boolean

设置事件的启用和禁用状态

继承自:

只读 flat : TilesetFlat

模型压平 对象

只读 flood : TilesetFlood

模型淹没 对象

hasEdit : boolean

判断是否允许编辑(可以外部传入禁用编辑,部分模型没有transform矩阵时是不允许编辑的)

只读 hasOpacity : boolean

是否可以调整透明度

继承自:

height : number

调整修改模型高度, 同alt

highlight : object

鼠标移入或单击(type:'click')后的对应高亮的部分样式,空值时不高亮

id : string|number

对象的id标识

继承自:

只读 inverseMatrix : Cesium.Matrix4

逆变换矩阵。

只读 isAdded : boolean

是否已添加到地图

继承自:

isAutoEditing : boolean

是否自动激活编辑(true时,单击后自动激活编辑)

只读 isDestroy : boolean

是否已经销毁了

继承自:

只读 isEditing : boolean

是否正在编辑状态

只读 isPrivate : boolean

是否Mars3D内部的私有对象,如标绘拖拽点等

继承自:

只读 map : Map

当前图层所在的地图对象

继承自:

marsJzwStyle : boolean|object|string

开启或设置建筑物特效样式。

只读 modelMatrix : Cesium.Matrix4

变换矩阵。

只读 modelUpAxis : Cesium.Axis

模型的向上轴,比如Cesium.Axis.Z 或 Cesium.Axis.Y

name : string

名称

继承自:

opacity : number

透明度,取值范围:0.0-1.0

继承自:

只读 options : object

当前类的构造参数

继承自:

只读 orginCenterPoint : LngLatPoint

模型原始的中心点坐标

只读 orginCenterPosition : Cesium.Cartesian3

模型原始的中心点坐标 (笛卡尔坐标)

只读 orginMatrix : Cesium.Matrix4

模型原始矩阵

只读 orginRotation : object

原始的旋转角度,示例:{ x: 0, y: 0, z: 0 }

pid : string|number

对象的pid标识

继承自:

只读 planClip : TilesetPlanClip

模型裁剪 对象

position : Cesium.Cartesian3

模型当前中心点坐标 (笛卡尔坐标)

只读 readyPromise : Promise.<(BaseLayer|object)>

获取图层完成解析加载完成的Promise承诺, 等价于load事件(区别在于load事件必须在load完成前绑定才能监听)。

继承自:
使用示例:
tiles3dLayer.readyPromise.then(function(layer) {
    console.log("load完成", layer)
  })

rotation : object

旋转方向,示例:{ x: 0, y: 0, z: 0 }

rotation_x : number

X轴上的旋转方向

rotation_y : number

Y轴上的旋转方向

rotation_z : number

Z轴上的旋转方向

scale : number

缩放比例

scaleX : number

单独自定义缩放X轴方向比例

scaleY : number

单独自定义缩放Y轴方向比例

scaleZ : number

单独自定义缩放Z轴方向比例

show : boolean

显示隐藏状态

继承自:

splitDirection : Cesium.SplitDirection

卷帘对比时,设置所在的屏幕,NONE 时不分屏

只读 state : State

当前对象的状态

继承自:

style : object|Cesium.Cesium3DTileStyle|function

模型样式, 使用3D Tiles Styling language.

只读 tileset : Cesium.Cesium3DTileset

模型对应的 Cesium3DTileset对象

只读 transform : boolean

是否存在世界矩阵

只读 type : string

图层类型

继承自:

方法

abstract _mountedHook() → void

对象添加到地图前创建一些对象的钩子方法, 只会调用一次

返回值:

无

继承自:

addEventParent(obj) → BaseClass

添加抛出事件到父类,它将接收传播的事件

参数名称 类型 描述信息
obj object

父类对象

返回值:

当前对象本身,可以链式调用

继承自:

addTo(map) → BaseLayer

添加到地图上,同 map.addThing

参数名称 类型 描述信息
map Map

地图对象

返回值:

当前对象本身,可以链式调用

继承自:

bindContextMenu(content, options) → BaseGraphicLayer

绑定右键菜单

参数名称 类型 默认值 描述信息
content Array.<object>

右键菜单配置数组,数组中每一项包括:

参数名称 类型 描述信息
text string | function 可选

菜单文字

icon string 可选

图标,可以是:图片url路径、base64字符串、svg字符串、字体图标class名

show function | boolean 可选

菜单项是否显示的回调方法

callback function 可选

菜单项单击后的回调方法

children Array.<object> 可选

当有二级子菜单时,配置数组。

options object {} 可选

控制参数

参数名称 类型 描述信息
mergeMap boolean 可选

是否合并一起显示map默认右键菜单

offsetX number 可选

用于非规则对象时,横向偏移的px像素值

offsetY number 可选

用于非规则对象时,垂直方向偏移的px像素值

返回值:

当前对象本身,可以链式调用

继承自:
使用示例:
//在layer上绑定右键菜单
      graphicLayer.bindContextMenu([
        {
          text: '删除对象',
          icon: 'fa fa-trash-o',
          callback: function (e) {
            let graphic = e.graphic
            if (graphic) {
              graphicLayer.removeGraphic(graphic)
            }
          },
        },
        {
          text: '计算长度',
          icon: 'fa fa-medium',
          show: function (e) {
            let graphic = e.graphic
            return graphic.type === 'polyline'
          },
          callback: function (e) {
            let graphic = e.graphic
            let strDis = mars3d.MeasureUtil.formatDistance(graphic.distance)
            alert('该对象的长度为:' + strDis)
          },
        },
      ])

bindHighlight(options) → void

绑定鼠标移入或单击后的 对象高亮

参数名称 类型 描述信息
options object 可选

参数:

参数名称 类型 默认值 描述信息
type string 'mouseOver' 可选

事件类型,默认为鼠标移入高亮,也可以指定'click'单击高亮。

多个参数 string 可选

高亮的样式,具体见各GraphicType矢量数据的style参数。

返回值:

无

继承自:

bindPopup(content, options) → TilesetLayer

绑定鼠标单击对象后的弹窗。

参数名称 类型 描述信息
content string | Array | function

弹窗内容html字符串,或者回调方法。

options Popup.StyleOptions 可选

控制参数

返回值:

当前对象本身,可以链式调用

bindTooltip(content, options) → BaseGraphicLayer

绑定鼠标移入的弹窗

参数名称 类型 描述信息
content string | function

弹窗内容html字符串,或者回调方法。

options Tooltip.StyleOptions 可选

控制参数

返回值:

当前对象本身,可以链式调用

继承自:

clampToGround(addHeight) → void

模型自动贴地计算及处理, 因为模型在设计或生产时,模型的视角中心位置不一定在0,0,0点,此方法不是唯一准确的。

参数名称 类型 默认值 描述信息
addHeight number 1 可选

计算完成的贴地高度基础上增加的高度值。

返回值:

无

closeContextMenu() → BaseGraphicLayer

关闭右键菜单

返回值:

当前对象本身,可以链式调用

继承自:

closeHighlight() → void

清除已选中的高亮,原有style的配置项需要与highlightStyle配置有一一对应关系,否则无法清除

返回值:

无

closePopup() → TilesetLayer

关闭弹窗

返回值:

当前对象本身,可以链式调用

closeSmallTooltip() → BaseGraphicLayer

关闭小提示窗

返回值:

当前对象本身,可以链式调用

继承自:

closeTooltip() → BaseGraphicLayer

关闭弹窗

返回值:

当前对象本身,可以链式调用

继承自:

destroy(noDel) → void

销毁当前对象

参数名称 类型 默认值 描述信息
noDel boolean false 可选

false:会自动delete释放所有属性,true:不delete绑定的变量

返回值:

无

继承自:

fire(type, data, propagate) → BaseClass

触发指定类型的事件。

参数名称 类型 默认值 描述信息
type EventType | string

事件类型

data object 可选

传输的数据或对象,可在事件回调方法中event对象中获取进行使用

propagate boolean false 可选

将事件传播给父类 (用addEventParent设置)

返回值:

当前对象本身,可以链式调用

继承自:

async flyTo(options) → Promise.<boolean>

飞行定位至图层数据所在的视角

参数名称 类型 默认值 描述信息
options object {} 可选

参数对象:

参数名称 类型 默认值 描述信息
radius number 可选

点状数据时,相机距离目标点的距离(单位:米)

scale number 1.2 可选

线面数据时,缩放比例,可以控制视角比矩形略大一些,这样效果更友好。

heading number 可选

方向角度值,绕垂直于地心的轴旋转角度, 0至360, 提示:该参数仅3D视图下有效

pitch number 可选

俯仰角度值,绕纬度线旋转角度, -90至90, 提示:该参数仅3D视图下有效

roll number 可选

翻滚角度值,绕经度线旋转角度, -90至90, 提示:该参数仅3D视图下有效

minHeight number 可选

定位时相机的最小高度值,用于控制避免异常数据

maxHeight number 可选

定位时相机的最大高度值,用于控制避免异常数据

height number 可选

矩形区域时的高度值, 默认取地形高度值

duration number 可选

飞行时间(单位:秒)。如果省略,SDK内部会根据飞行距离计算出理想的飞行时间。

onBefore function 可选

飞行前对相关坐标等参数做额外的回调处理,比如目标点做自定义偏移处理。【部分图层支持】

complete Cesium.Camera.FlightCompleteCallback 可选

飞行完成后要执行的函数。

cancel Cesium.Camera.FlightCancelledCallback 可选

飞行取消时要执行的函数。

endTransform Cesium.Matrix4 可选

变换矩阵表示飞行结束时相机所处的参照系。

maximumHeight number 可选

飞行高峰时的最大高度。

pitchAdjustHeight number 可选

如果相机飞得比这个值高,在飞行过程中调整俯仰以向下看,并保持地球在视口。

flyOverLongitude number 可选

地球上的两点之间总有两条路。这个选项迫使相机选择战斗方向飞过那个经度。

flyOverLongitudeWeight number 可选

仅在通过flyOverLongitude指定的lon上空飞行,只要该方式的时间不超过flyOverLongitudeWeight的短途时间。

convert boolean true 可选

是否将目的地从世界坐标转换为场景坐标(仅在不使用3D时相关)。

easingFunction Cesium.EasingFunction.Callback 可选

控制在飞行过程中如何插值时间。

返回值:

如果飞行成功则解析为true的承诺,如果当前未在场景中可视化目标或取消飞行,则为false的Promise

继承自:

getAvailabilityJson() → Array.<object>

获取时间范围的简单对象数组(转为相对map.clock.startTime的相对数字)

返回值:

时间对象列表

继承自:

getAvailabilityShow(time) → boolean

获取指定时间下的时序对应的 显示隐藏 状态

参数名称 类型 描述信息
time Cesium.JulianDate

指定时间

返回值:

显示隐藏 状态

继承自:

getContextMenu() → Array.<object>

获取绑定的右键菜单数组

返回值:

右键菜单数组

继承自:

getHeight(position) → number

获取贴当前模型高度值。 PS: 该方法将只考虑已加载的LOD数据,而不一定是LOD集中最详细的最底层数据。 当采样点云时,此函数将始终返回undefined。

参数名称 类型 描述信息
position string | Array | LngLatPoint | Cesium.Cartesian3 | *

坐标位置

返回值:

贴模型的高度

getPositionByOrginMatrix(position) → Cesium.Cartesian3

获取构件节点位置,现对于原始矩阵变化后的新位置

参数名称 类型 描述信息
position Cesium.Cartesian3

原始位置

返回值:

新位置

getRealShow(time) → boolean

获取当前对象真实实际的显示状态

参数名称 类型 描述信息
time Cesium.JulianDate

当前时间

返回值:

真实的实时显示状态,当时序范围外,被聚合时返回的是false

继承自:

hasContextMenu() → boolean

是否有绑定的右键菜单

返回值:

是否有绑定

继承自:

hasEventParent(obj) → boolean

是否绑定了抛出事件到指定父类

参数名称 类型 描述信息
obj object

父类对象

返回值:

是否绑定了抛出事件

继承自:

hasPopup() → boolean

是否存在Popup绑定

返回值:

是否存在Popup绑定

hasTooltip() → boolean

是否绑定了tooltip

返回值:

是否绑定

继承自:

listens(type, propagate) → boolean

是否有绑定指定的事件

参数名称 类型 默认值 描述信息
type EventType | string

事件类型

propagate boolean false 可选

是否判断指定的父类 (用addEventParent设置的)

返回值:

是否存在

继承自:

off(types, fn, context) → BaseClass

解除绑定指定类型事件监听器

参数名称 类型 描述信息
types string | EventType | Array.<string> | Array.<EventType> 可选

事件类型,tip:多个事件也可以数组或空格间隔的字符串 , 传入空值时解绑所有事件

fn function 可选

绑定的监听器回调方法,未传值时解绑所有指定类型对应事件,特殊说明:map.on监听的Cesium相关原生事件时必须传入该参数

context object 可选

侦听器的上下文(this关键字将指向的对象)。

返回值:

当前对象本身,可以链式调用

继承自:

on(types, fn, context) → BaseClass

绑定指定类型事件监听器, 支持在监听中调用 event.stopPropagation(); 阻止事件冒泡

参数名称 类型 描述信息
types string | EventType | Array.<string> | Array.<EventType>

事件类型,tip:多个事件也可以数组或空格间隔的字符串

fn function

绑定的监听器回调方法

context object 可选

侦听器的上下文(this关键字将指向的对象)。

返回值:

当前对象本身,可以链式调用

继承自:

once(types, fn, context) → BaseClass

绑定一次性执行的指定类型事件监听器 与on类似,监听器只会被触发一次,然后被删除。

参数名称 类型 描述信息
types EventType | string | Array.<EventType>

事件类型

fn function

绑定的监听器回调方法

context object 可选

侦听器的上下文(this关键字将指向的对象)。

返回值:

当前对象本身,可以链式调用

继承自:

openContextMenu(position) → BaseGraphicLayer

打开右键菜单

参数名称 类型 描述信息
position BaseGraphic | Cesium.Cartesian3

矢量对象 或 显示的位置

返回值:

当前对象本身,可以链式调用

继承自:

openHighlight(highlightStyle, closeLast, pickedObject) → void

高亮对象。 提示:该方法不支持 outlineEffect: true 高亮,因为outlineEffect需要鼠标拾取构件。

参数名称 类型 默认值 描述信息
highlightStyle object 可选

高亮的样式,具体见各GraphicType矢量数据的style参数。

closeLast boolean true 可选

是否清除地图上一次的高亮对象

pickedObject Cesium.Cesium3DTileFeature 可选

需要高亮的构件, 如果是mars3d的相关事件内时,可以取 event.pickedObject

返回值:

无

openPopup(position) → BaseGraphicLayer

打开绑定的弹窗

参数名称 类型 描述信息
position BaseGraphic | LngLatPoint | Cesium.Cartesian3

矢量对象 或 显示的位置

返回值:

当前对象本身,可以链式调用

继承自:

openSmallTooltip(position, message) → BaseGraphicLayer

显示小提示窗,一般用于鼠标操作的提示。

参数名称 类型 描述信息
position Cesium.Cartesian2 | Cesium.Cartesian3

显示的屏幕坐标位置 或 笛卡尔坐标位置

message *

显示的内容

返回值:

当前对象本身,可以链式调用

继承自:

openTooltip(position) → BaseGraphicLayer

打开绑定的tooltip弹窗

参数名称 类型 描述信息
position BaseGraphic | LngLatPoint | Cesium.Cartesian3

graphic矢量对象 或 显示的位置

返回值:

当前对象本身,可以链式调用

继承自:

reload() → void

重新加载模型

返回值:

remove(destroy) → void

从地图上移除,同map.removeThing

参数名称 类型 描述信息
destroy boolean 可选

是否调用destroy释放

返回值:

无

继承自:

removeEventParent(obj) → BaseClass

移除抛出事件到父类

参数名称 类型 描述信息
obj object

父类对象

返回值:

当前对象本身,可以链式调用

继承自:

setOpacity(value) → void

设置透明度

参数名称 类型 描述信息
value number

透明度

返回值:

无

setOptions(options, funOptions) → BaseLayer

更新图层参数

参数名称 类型 描述信息
options object

与类的构造方法参数相同

funOptions object 可选

方法参数

参数名称 类型 默认值 描述信息
merge boolean true 可选

是否合并参数, 如是完整覆盖不合并老的options,请传入false

返回值:

当前对象本身,可以链式调用

继承自:

startEditing() → TilesetLayer|undefined

开始编辑对象

返回值:

已在编辑或不支持启动时返回当前对象;实际启动编辑时无返回值。

Throws:
  • Error :

    编辑时_map不能为空,请将对象添加到Map

stopEditing() → TilesetLayer|undefined

停止编辑,释放正在编辑的对象。

返回值:

无需停止编辑时返回当前对象;实际停止编辑时无返回值。

toJSON(options) → object|undefined

将图层转为Json简单对象,用于存储后再传参加载

参数名称 类型 描述信息
options object 可选

参数对象:

参数名称 类型 默认值 描述信息
full boolean false 可选

(tileset模型时)导出冗余的完整参数,包含完整position、transform等信息。

noAlt boolean 可选

(矢量图层中)不导出高度值

toNum boolean 可选

(矢量图层中)坐标是time时序坐标时,time值是否转为数字秒数

stopEdit boolean false 可选

(矢量图层中)是否停止绘制或编辑

返回值:

Json简单对象;未满足执行条件时可能无返回值。

继承自:

unbindContextMenu(bubbling) → BaseGraphicLayer

解除绑定的右键菜单

参数名称 类型 默认值 描述信息
bubbling boolean false 可选

单击事件中是否继续冒泡查找

返回值:

当前对象本身,可以链式调用

继承自:

unbindHighlight() → void

解绑鼠标移入或单击后的高亮处理

返回值:

无

继承自:

unbindPopup() → TilesetLayer

解除绑定的鼠标单击对象后的弹窗。

返回值:

当前对象本身,可以链式调用

unbindTooltip(bubbling) → BaseGraphicLayer

解除绑定的鼠标移入对象后的弹窗。

参数名称 类型 默认值 描述信息
bubbling boolean false 可选

单击事件中是否继续冒泡查找

返回值:

当前对象本身,可以链式调用

继承自:

updateMatrix() → Cesium.Matrix4|undefined

重新计算当前矩阵(需要是否存在世界矩阵时)

返回值:

计算完成的矩阵

updateMatrix2() → Cesium.Matrix4|undefined

重新计算当前矩阵,普通方式, 此种方式[x,y不能多次更改]

返回值:

计算完成的矩阵;未满足执行条件时可能无返回值。

定义的类型

mars3d.layer.TilesetLayer.EventType

当前类支持的EventType事件类型

属性:
属性名称 类型 描述信息
add string

添加对象

remove string

移除对象

show string

显示了对象

hide string

隐藏了对象

click string

左键单击 鼠标事件

rightClick string

右键单击 鼠标事件

mouseOver string

鼠标移入 鼠标事件

mouseOut string

鼠标移出 鼠标事件

popupOpen string

popup弹窗打开后

popupClose string

popup弹窗关闭

tooltipOpen string

tooltip弹窗打开后

tooltipClose string

tooltip弹窗关闭

initialTilesLoaded string

3dtiles模型,模型瓦片初始化完成 该回调只执行一次

allTilesLoaded string

3dtiles模型

loadBefore string

完成加载,但未做任何其他处理前

load string

完成加载,执行所有内部处理后

highlightOpen string

highlight高亮后

highlightClose string

highlight关闭后

使用示例:
//绑定监听事件
layer.on(mars3d.EventType.load, function (event) {
  console.log('矢量数据对象加载完成', event)
})
参考: