Entity 实例将多种可视化形式聚合为一个高层对象。
它们可以手动创建并添加到
Viewer#entities,也可由
数据源(如 CzmlDataSource 和 GeoJsonDataSource)生成。
| Name | Type | Description |
|---|---|---|
options |
Entity.ConstructorOptions | optional 描述初始化选项的对象 |
See:
Members
availability : TimeIntervalCollection|undefined
与此对象相关联的可用时间范围(如果有)。
如果可用时间范围未定义,则假定此对象的
其他属性在任意给定时间都返回有效数据。
如果存在可用时间范围,则对象的其他属性
仅在给定区间内查询时才提供有效数据。
billboard : BillboardGraphics|undefined
获取或设置广告牌(billboard)。
box : BoxGraphics|undefined
获取或设置盒子(box)。
corridor : CorridorGraphics|undefined
获取或设置走廊(corridor)。
cylinder : CylinderGraphics|undefined
获取或设置圆柱体(cylinder)。
readonly definitionChanged : Event
获取当某个属性或子属性被更改或修改时触发的事件。
description : Property|undefined
获取或设置描述。
ellipse : EllipseGraphics|undefined
获取或设置椭圆(ellipse)。
ellipsoid : EllipsoidGraphics|undefined
获取或设置椭球(ellipsoid)。
entityCollection : EntityCollection
获取或设置此实体所属的实体集合。
获取与此对象关联的唯一 ID。
获取此实体是否正在显示,同时考虑任何祖先实体的可见性。
label : LabelGraphics|undefined
获取或设置标签(label)。
model : ModelGraphics|undefined
获取或设置模型(model)。
获取或设置对象的名称。该名称面向最终用户,无需唯一。
orientation : Property|undefined
获取或设置相对于地心地固(ECEF)坐标系的朝向。
默认使用实体位置处的东-北-上(east-north-up)朝向。
parent : Entity|undefined
获取或设置父对象。
path : PathGraphics|undefined
获取或设置路径(path)。
plane : PlaneGraphics|undefined
获取或设置平面(plane)。
point : PointGraphics|undefined
获取或设置点图形(point)。
polygon : PolygonGraphics|undefined
获取或设置多边形(polygon)。
polyline : PolylineGraphics|undefined
获取或设置折线(polyline)。
polylineVolume : PolylineVolumeGraphics|undefined
获取或设置管状折线(polylineVolume)。
position : PositionProperty|undefined
获取或设置位置。
properties : PropertyBag|undefined
获取或设置与此实体关联的任意属性集合。
获取此实例上注册的所有属性的名称。
rectangle : RectangleGraphics|undefined
获取或设置矩形(rectangle)。
获取或设置此实体是否应被显示。当设置为 true 时,仅当父实体的 show 属性也为 true 时实体才会显示。
tileset : Cesium3DTilesetGraphics|undefined
获取或设置瓦片集(tileset)。
trackingReferenceFrame : TrackingReferenceFrame
获取或设置实体的跟踪参考坐标系。
viewFrom : Property|undefined
获取或设置跟踪此对象时建议的初始偏移量。
该偏移通常定义在东-北-上(east-north-up)参考坐标系中,
但也可能根据对象的速度使用其他坐标系。
wall : WallGraphics|undefined
获取或设置墙(wall)。
Methods
检查给定的 Scene 是否支持在覆盖于地形或 3D Tiles 上的实体上使用除 Color 以外的材质。
如果不支持此特性,则具有非颜色材质但没有 `height` 的实体
将被渲染为高度等于 0 的样子。
| Name | Type | Description |
|---|---|---|
scene |
Scene | 当前的场景。 |
Returns:
当前场景是否支持地形上实体的材质。
检查给定的 Scene 是否支持贴附于地形或 3D Tiles 的折线。
如果不支持此特性,则具有 PolylineGraphics 的实体将以所提供的高度渲染顶点,
并使用 `arcType` 参数,而不是贴附到地面。
| Name | Type | Description |
|---|---|---|
scene |
Scene | 当前的场景。 |
Returns:
当前场景是否支持地形或 3D Tiles 上的折线。
向此对象添加一个属性。一旦添加了属性,就可以
通过
Entity#definitionChanged 观察它,并与
CompositeEntityCollection 组合。
| Name | Type | Description |
|---|---|---|
propertyName |
string | 要添加的属性的名称。 |
Throws:
-
DeveloperError : "propertyName" 是一个保留属性名。
-
DeveloperError : "propertyName" 已经是已注册的属性。
computeModelMatrix(time, result) → Matrix4
计算在指定时间处实体变换的模型矩阵。如果位置未定义则返回 undefined。
| Name | Type | Description |
|---|---|---|
time |
JulianDate | 要获取模型矩阵的时间。 |
result |
Matrix4 | optional 用于存储结果的对象。 |
Returns:
被修改的结果参数;如果未提供,则为一个新的 Matrix4 实例。如果位置未定义,则结果为 undefined。
给定一个时间,如果此对象在该时间应拥有数据,则返回 true。
| Name | Type | Description |
|---|---|---|
time |
JulianDate | 要检查可用性的时间。 |
Returns:
如果对象在所提供的时间内应拥有数据则为 true,否则为 false。
将此对象上每个未赋值的属性,赋值为所提供源对象上相同属性的值。
| Name | Type | Description |
|---|---|---|
source |
Entity | 要合并到此对象中的对象。 |
移除之前通过 addProperty 添加的属性。
| Name | Type | Description |
|---|---|---|
propertyName |
string | 要移除的属性的名称。 |
Throws:
-
DeveloperError : "propertyName" 是一个保留属性名。
-
DeveloperError : "propertyName" 不是已注册的属性。
Type Definitions
Entity 构造函数的初始化选项。
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
id |
string |
<optional> |
此对象的唯一标识符。如果未提供,则生成一个 GUID。 | |
name |
string |
<optional> |
显示给用户的可读名称。它不必是唯一的。 | |
availability |
TimeIntervalCollection |
<optional> |
与此对象相关联的可用时间范围(如果有)。 | |
show |
boolean |
<optional> |
一个布尔值,指示实体及其子级是否显示。 | |
trackingReferenceFrame |
TrackingReferenceFrame |
<optional> |
TrackingReferenceFrame.AUTODETECT | 跟踪此实体时使用的参考坐标系。 如果为 undefined,则参考坐标系根据实体速度确定:近地表缓慢移动的实体使用局部东-北-上(east-north-up)参考坐标系进行跟踪,而快速移动的实体(如卫星)则使用 VVLH(车体速度、当地水平,Vehicle Velocity, Local Horizontal)进行跟踪。 |
description |
Property | string |
<optional> |
指定此实体 HTML 描述的字符串 Property。 | |
position |
PositionProperty | Cartesian3 | CallbackPositionProperty |
<optional> |
指定实体位置的 Property。 | |
orientation |
Property | Quaternion |
<optional> |
Transforms.eastNorthUpToFixedFrame(position) | 指定实体相对于地心地固(ECEF)坐标系朝向的 Property。如果未定义,则使用实体位置处的东-北-上(east-north-up)朝向。 |
viewFrom |
Property | Cartesian3 |
<optional> |
查看此对象时建议的初始偏移量。 | |
parent |
Entity |
<optional> |
与此实体关联的父实体。 | |
billboard |
BillboardGraphics | BillboardGraphics.ConstructorOptions |
<optional> |
与此实体关联广告牌(billboard)。 | |
box |
BoxGraphics | BoxGraphics.ConstructorOptions |
<optional> |
与此实体关联的盒子(box)。 | |
corridor |
CorridorGraphics | CorridorGraphics.ConstructorOptions |
<optional> |
与此实体关联的走廊(corridor)。 | |
cylinder |
CylinderGraphics | CylinderGraphics.ConstructorOptions |
<optional> |
与此实体关联的圆柱体(cylinder)。 | |
ellipse |
EllipseGraphics | EllipseGraphics.ConstructorOptions |
<optional> |
与此实体关联的椭圆(ellipse)。 | |
ellipsoid |
EllipsoidGraphics | EllipsoidGraphics.ConstructorOptions |
<optional> |
与此实体关联的椭球(ellipsoid)。 | |
label |
LabelGraphics | LabelGraphics.ConstructorOptions |
<optional> |
与此实体关联的 options.label。 | |
model |
ModelGraphics | ModelGraphics.ConstructorOptions |
<optional> |
与此实体关联的模型(model)。 | |
tileset |
Cesium3DTilesetGraphics | Cesium3DTilesetGraphics.ConstructorOptions |
<optional> |
与此实体关联的 3D Tiles 瓦片集(tileset)。 | |
path |
PathGraphics | PathGraphics.ConstructorOptions |
<optional> |
与此实体关联的路径(path)。 | |
plane |
PlaneGraphics | PlaneGraphics.ConstructorOptions |
<optional> |
与此实体关联的平面(plane)。 | |
point |
PointGraphics | PointGraphics.ConstructorOptions |
<optional> |
与此实体关联的点(point)。 | |
polygon |
PolygonGraphics | PolygonGraphics.ConstructorOptions |
<optional> |
与此实体关联的多边形(polygon)。 | |
polyline |
PolylineGraphics | PolylineGraphics.ConstructorOptions |
<optional> |
与此实体关联的折线(polyline)。 | |
properties |
PropertyBag | Object.<string, *> |
<optional> |
与此实体关联的任意属性。 | |
polylineVolume |
PolylineVolumeGraphics | PolylineVolumeGraphics.ConstructorOptions |
<optional> |
与此实体关联的管状折线(polylineVolume)。 | |
rectangle |
RectangleGraphics | RectangleGraphics.ConstructorOptions |
<optional> |
与此实体关联的矩形(rectangle)。 | |
wall |
WallGraphics | WallGraphics.ConstructorOptions |
<optional> |
与此实体关联的墙(wall)。 |
