实体实例将多种可视化形式聚合为一个高层次的对象。
它们可以被手动创建并添加到
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
获取在属性或子属性更改或修改时引发的事件。
ellipse : EllipseGraphics|undefined
获取或设置椭圆。
ellipsoid : EllipsoidGraphics|undefined
获取或设置椭球体。
entityCollection : EntityCollection
获取或设置此实体所属的实体集合。
获取与此对象关联的唯一 ID。
获取此实体是否正在显示,考虑到任意祖先实体的可见性。
label : LabelGraphics|undefined
获取或设置标签。
model : ModelGraphics|undefined
获取或设置模型。
获取或设置对象的名称。名称 intended for end-user
consumption and does not need to be unique.
orientation : Property|undefined
获取或设置与地球固定中心(ECEF)相关的方向。
默认为实体位置的东-北-上方向。
parent : Entity|undefined
获取或设置父对象。
path : PathGraphics|undefined
获取或设置路径。
plane : PlaneGraphics|undefined
获取或设置平面。
point : PointGraphics|undefined
获取或设置点图形。
polygon : PolygonGraphics|undefined
获取或设置多边形。
polyline : PolylineGraphics|undefined
获取或设置折线。
polylineVolume : PolylineVolumeGraphics|undefined
获取或设置多线体。
position : PositionProperty|undefined
获取或设置位置。
properties : PropertyBag|undefined
获取或设置与此实体相关联的任意属性的袋子。
获取此实例注册的所有属性的名称。
rectangle : RectangleGraphics|undefined
获取或设置矩形。
获取或设置此实体是否应显示。设置为 true 时,
仅当父实体的 show 属性也为 true 时,此实体才可显示。
tileset : Cesium3DTilesetGraphics|undefined
获取或设置瓦片集。
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> |
一个布尔值,指示实体及其子对象是否可见。 | |
description |
Property | string |
<optional> |
指定此实体的 HTML 描述的字符串属性。 | |
position |
PositionProperty | Cartesian3 | CallbackProperty |
<optional> |
指定实体位置的属性。 | |
orientation |
Property | Quaternion |
<optional> |
Transforms.eastNorthUpToFixedFrame(position) | 指定与地球固定中心(ECEF)相关的实体方向的属性。如果未定义,则使用实体位置的东-北-上方向。 |
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> |
要与此实体相关联的墙。 |
