Entity 实例将多种可视化形式聚合为单个高级对象。
它们可以手动创建并添加到
Viewer#entities,或由
数据源生成,例如 CzmlDataSource 和 GeoJsonDataSource。
| Name | Type | Description |
|---|---|---|
options |
Entity.ConstructorOptions | optional 描述初始化选项的对象 |
See:
Members
availability : TimeIntervalCollection|undefined
与对象关联的可用性(如果有)。
如果可用性未定义,则假定此对象的
其他属性将为任何提供的时间返回有效数据。
如果存在可用性,则对象的其他属性
仅在给定时间间隔内查询时提供有效数据。
billboard : BillboardGraphics|undefined
获取或设置广告牌。
box : BoxGraphics|undefined
获取或设置盒子。
corridor : CorridorGraphics|undefined
获取或设置走廊。
cylinder : CylinderGraphics|undefined
获取或设置圆柱体。
readonly definitionChanged : Event
获取每当属性或子属性被更改或修改时引发的事件。
description : Property|undefined
获取或设置描述。
ellipse : EllipseGraphics|undefined
获取或设置椭圆。
ellipsoid : EllipsoidGraphics|undefined
获取或设置椭球体。
entityCollection : EntityCollection
Gets or sets the entity collection that this entity belongs to.
获取与此对象关联的唯一 ID。
获取是否显示此实体,同时考虑
任何祖先实体的可见性。
label : LabelGraphics|undefined
获取或设置标签。
model : ModelGraphics|undefined
获取或设置模型。
获取或设置对象的名称。名称面向最终用户,
不需要唯一。
orientation : Property|undefined
获取或设置相对于地固地球中心(ECEF)的方向。
默认为实体位置处的东-北-上方向。
parent : Entity|undefined
Gets or sets the parent object.
path : PathGraphics|undefined
获取或设置路径。
plane : PlaneGraphics|undefined
获取或设置平面。
point : PointGraphics|undefined
获取或设置点图形。
polygon : PolygonGraphics|undefined
获取或设置多边形。
polyline : PolylineGraphics|undefined
获取或设置折线。
polylineVolume : PolylineVolumeGraphics|undefined
获取或设置折线体。
position : PositionProperty|undefined
获取或设置位置。
properties : PropertyBag|undefined
获取或设置与此实体关联的任意属性包。
Gets the names of all properties registered on this instance.
rectangle : RectangleGraphics|undefined
获取或设置矩形。
获取或设置是否应显示此实体。设置为 true 时,
仅当父实体的 show 属性也为 true 时,实体才会显示。
tileset : Cesium3DTilesetGraphics|undefined
获取或设置瓦片集。
trackingReferenceFrame : TrackingReferenceFrame
获取或设置实体的跟踪参考帧。
Demo:
viewFrom : Property|undefined
获取或设置跟踪此对象时建议的初始偏移量。
偏移量通常在东-北-上参考帧中定义,
但也可能根据对象的速度使用其他帧。
wall : WallGraphics|undefined
获取或设置墙。
Methods
检查给定场景是否支持在贴地实体或 3D Tiles 上使用除颜色外的材质。
如果此功能不受支持,则具有非颜色材质但没有 `height` 的实体
将改为以高度为 0 的方式渲染。
| Name | Type | Description |
|---|---|---|
scene |
Scene | 当前场景。 |
Returns:
当前场景是否支持地形上的实体材质。
检查给定场景是否支持贴地或 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,参考帧根据实体速度确定:近地面慢速移动实体使用局部东-北-上参考帧跟踪,而快速移动实体(如卫星)使用 VVLH(车辆速度,局部水平)跟踪。 |
description |
Property | string |
<optional> |
字符串属性,指定此实体的 HTML 描述。 | |
position |
PositionProperty | Cartesian3 | CallbackPositionProperty |
<optional> |
指定实体位置的属性。 | |
orientation |
Property | Quaternion |
<optional> |
Transforms.eastNorthUpToFixedFrame(position) | 指定实体相对于地固地球中心(ECF)方向的属性。如果未定义,则使用实体位置处的东-北-上方向。 |
viewFrom |
Property | Cartesian3 |
<optional> |
建议的查看此对象的初始偏移量。 | |
parent |
Entity |
<optional> |
与此实体关联的父实体。 | |
billboard |
BillboardGraphics | BillboardGraphics.ConstructorOptions |
<optional> |
与此实体关联的广告牌。 | |
box |
BoxGraphics | BoxGraphics.ConstructorOptions |
<optional> |
与此实体关联的盒子。 | |
corridor |
CorridorGraphics | CorridorGraphics.ConstructorOptions |
<optional> |
与此实体关联的走廊。 | |
cylinder |
CylinderGraphics | CylinderGraphics.ConstructorOptions |
<optional> |
与此实体关联的圆柱体。 | |
ellipse |
EllipseGraphics | EllipseGraphics.ConstructorOptions |
<optional> |
与此实体关联的椭圆。 | |
ellipsoid |
EllipsoidGraphics | EllipsoidGraphics.ConstructorOptions |
<optional> |
与此实体关联的椭球体。 | |
label |
LabelGraphics | LabelGraphics.ConstructorOptions |
<optional> |
与此实体关联的标签。 | |
model |
ModelGraphics | ModelGraphics.ConstructorOptions |
<optional> |
与此实体关联的模型。 | |
tileset |
Cesium3DTilesetGraphics | Cesium3DTilesetGraphics.ConstructorOptions |
<optional> |
与此实体关联的 3D Tiles 瓦片集。 | |
path |
PathGraphics | PathGraphics.ConstructorOptions |
<optional> |
与此实体关联的路径。 | |
plane |
PlaneGraphics | PlaneGraphics.ConstructorOptions |
<optional> |
与此实体关联的平面。 | |
point |
PointGraphics | PointGraphics.ConstructorOptions |
<optional> |
与此实体关联的点。 | |
polygon |
PolygonGraphics | PolygonGraphics.ConstructorOptions |
<optional> |
与此实体关联的多边形。 | |
polyline |
PolylineGraphics | PolylineGraphics.ConstructorOptions |
<optional> |
与此实体关联的折线。 | |
properties |
PropertyBag | Object.<string, *> |
<optional> |
与此实体关联的任意属性。 | |
polylineVolume |
PolylineVolumeGraphics | PolylineVolumeGraphics.ConstructorOptions |
<optional> |
与此实体关联的折线体。 | |
rectangle |
RectangleGraphics | RectangleGraphics.ConstructorOptions |
<optional> |
与此实体关联的矩形。 | |
wall |
WallGraphics | WallGraphics.ConstructorOptions |
<optional> |
与此实体关联的墙。 |
