实体实例将多种形式的可视化聚合到单个高级对象中。
它们可以手动创建并添加到
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
获取或设置description.
ellipse : EllipseGraphics|undefined
获取或设置ellipse.
ellipsoid : EllipsoidGraphics|undefined
获取或设置ellipsoid.
entityCollection : EntityCollection
获取或设置entity collection that this entity belongs to.
获取与此对象关联的唯一 ID。
获取是否显示此实体,同时考虑
任何祖先实体的可见性。
label : LabelGraphics|undefined
获取或设置label.
model : ModelGraphics|undefined
获取或设置model.
获取或设置对象的名称。 该名称适用于最终用户
消耗,并且不需要是唯一的。
orientation : Property|undefined
获取或设置orientation in respect to Earth-fixed-Earth-centered (ECEF).
Defaults to east-north-up at entity position.
parent : Entity|undefined
获取或设置parent 对象。
path : PathGraphics|undefined
获取或设置path.
plane : PlaneGraphics|undefined
获取或设置plane.
point : PointGraphics|undefined
获取或设置point graphic.
polygon : PolygonGraphics|undefined
获取或设置polygon.
polyline : PolylineGraphics|undefined
获取或设置polyline.
polylineVolume : PolylineVolumeGraphics|undefined
获取或设置polyline volume.
position : PositionProperty|undefined
获取或设置position.
properties : PropertyBag|undefined
获取或设置bag 的任意属性。
获取在此实例上注册的所有属性的名称。
rectangle : RectangleGraphics|undefined
获取或设置rectangle.
获取或设置是否应显示此实体。当设置为 true 时,
仅当父实体的 show 属性也为 true 时,才会显示实体。
tileset : Cesium3DTilesetGraphics|undefined
获取或设置tileset.
trackingReferenceFrame : TrackingReferenceFrame
获取或设置实体的跟踪参考帧。
viewFrom : Property|undefined
获取或设置跟踪此对象时建议的初始偏移量。
偏移量通常在东北向上的参考系中定义,
但可能是另一帧,具体取决于对象的速度。
wall : WallGraphics|undefined
获取或设置wall.
Methods
检查给定场景是否支持除 Color 之外的 Entity on Overlay on terrain 或 3D Tiles 上的材质。
如果不支持此功能,则具有非颜色材质但没有“高度”的实体将
的渲染方式为 height 为 0。
Name | Type | Description |
---|---|---|
scene |
Scene | 当前场景。 |
Returns:
当前场景是否支持地形上实体的材质。
检查给定场景是否支持固定到地形或 3D 瓦片的折线。
如果不支持此功能,则具有 PolylineGraphics 的实体将以
提供的高度,并使用 'arcType' 参数而不是固定到地面。
Name | Type | Description |
---|---|---|
scene |
Scene | 当前场景。 |
Returns:
当前场景是否支持地形上的折线或 3D 图块。
向此对象添加属性。 添加属性后,它可以
使用
Entity#definitionChanged
观察到并合成
替换为 CompositeEntityCollection
Name | Type | Description |
---|---|---|
propertyName |
string | 要添加的属性的名称。 |
Throws:
-
DeveloperError : "propertyName" is a reserved property name.
-
DeveloperError : "propertyName" is already a registered property.
computeModelMatrix(time, result) → Matrix4
计算实体在指定时间的转换的模型矩阵。如果 position 未定义,则返回 undefined
Name | Type | Description |
---|---|---|
time |
JulianDate | 检索模型矩阵的时间。 |
result |
Matrix4 | optional 要在其上存储结果的对象。 |
Returns:
修改后的结果参数或者一个新的 Matrix4 实例(如果未提供)。如果位置未定义,则结果为 undefined。
给定时间,如果此对象在该时间内应有数据,则返回 true。
Name | Type | Description |
---|---|---|
time |
JulianDate | 检查可用性的时间。 |
Returns:
true 如果对象在提供的时间内应该有数据,则为 否则 false 。
将此对象上每个未分配的属性分配给值
的 API 值。
Name | Type | Description |
---|---|---|
source |
Entity | 要合并到此对象中的对象。 |
删除了以前使用 addProperty 添加的属性。
Name | Type | Description |
---|---|---|
propertyName |
string | 要删除的属性的名称。 |
Throws:
-
DeveloperError : "propertyName" is a reserved property name.
-
DeveloperError : "propertyName" is not a registered property.
Type Definitions
Entity 构造函数的初始化选项
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
id |
string |
<optional> |
此对象的唯一标识符。如果未提供任何 GUID,则会生成 GUID。 | |
name |
string |
<optional> |
向用户显示的可读名称。它不必是唯一的。 | |
availability |
TimeIntervalCollection |
<optional> |
与此对象关联的可用性 (如果有)。 | |
show |
boolean |
<optional> |
一个布尔值,指示是否显示实体及其子项。 | |
trackingReferenceFrame |
TrackingReferenceFrame |
<optional> |
TrackingReferenceFrame.AUTODETECT | 跟踪此实体时使用的参考帧。 如果 undefined ,参考系是根据实体速度确定的:使用本地东西向北向上的参考系跟踪近表面缓慢移动的实体,而使用 VVLH(车辆速度,局部水平)跟踪卫星等快速移动的实体。 |
description |
Property | string |
<optional> |
一个 string 属性,用于指定此实体的 HTML 描述。 | |
position |
PositionProperty | Cartesian3 | CallbackPositionProperty |
<optional> |
指定实体位置的 Property。 | |
orientation |
Property | Quaternion |
<optional> |
Transforms.eastNorthUpToFixedFrame(position) | 一个属性,用于指定相对于地球固定地球中心 (ECEF) 的实体方向。如果未定义,则在实体位置使用 east-north-up。 |
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> |
与此实体关联的 options.label。 | |
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> |
要与此实体关联的 polylineVolume。 | |
rectangle |
RectangleGraphics | RectangleGraphics.ConstructorOptions |
<optional> |
要与此实体关联的矩形。 | |
wall |
WallGraphics | WallGraphics.ConstructorOptions |
<optional> |
要与此实体关联的墙。 |