Appearance
KBE3D / KBCore / Cesium / Entity
类: Entity
Entity instances aggregate multiple forms of visualization into a single high-level object. They can be created manually and added to Viewer#entities or be produced by data sources, such as CzmlDataSource and GeoJsonDataSource.
参数
Object describing initialization options
属性
entityCollection
entityCollection:
EntityCollection
Gets or sets the entity collection that this entity belongs to.
availability
availability:
TimeIntervalCollection|undefined
The availability, if any, associated with this object. If availability is undefined, it is assumed that this object's other properties will return valid data for any provided time. If availability exists, the objects other properties will only provide valid data if queried within the given interval.
id
id:
string
Gets the unique ID associated with this object.
definitionChanged
readonlydefinitionChanged:Event
Gets the event that is raised whenever a property or sub-property is changed or modified.
name
name:
string|undefined
Gets or sets the name of the object. The name is intended for end-user consumption and does not need to be unique.
show
show:
boolean
Gets or sets whether this entity should be displayed. When set to true, the entity is only displayed if the parent entity's show property is also true.
trackingReferenceFrame
trackingReferenceFrame:
TrackingReferenceFrame
Gets or sets the entity's tracking reference frame.
isShowing
isShowing:
boolean
Gets whether this entity is being displayed, taking into account the visibility of any ancestor entities.
parent
parent:
Entity|undefined
Gets or sets the parent object.
propertyNames
propertyNames:
string[]
Gets the names of all properties registered on this instance.
billboard
billboard:
BillboardGraphics|undefined
Gets or sets the billboard.
box
box:
BoxGraphics|undefined
Gets or sets the box.
corridor
corridor:
CorridorGraphics|undefined
Gets or sets the corridor.
cylinder
cylinder:
CylinderGraphics|undefined
Gets or sets the cylinder.
description
description:
Property|undefined
Gets or sets the description.
ellipse
ellipse:
EllipseGraphics|undefined
Gets or sets the ellipse.
ellipsoid
ellipsoid:
EllipsoidGraphics|undefined
Gets or sets the ellipsoid.
label
label:
LabelGraphics|undefined
Gets or sets the label.
model
model:
ModelGraphics|undefined
Gets or sets the model.
tileset
tileset:
Cesium3DTilesetGraphics|undefined
Gets or sets the tileset.
orientation
orientation:
Property|undefined
Gets or sets the orientation in respect to Earth-fixed-Earth-centered (ECEF). Defaults to east-north-up at entity position.
path
path:
PathGraphics|undefined
Gets or sets the path.
plane
plane:
PlaneGraphics|undefined
Gets or sets the plane.
point
point:
PointGraphics|undefined
Gets or sets the point graphic.
polygon
polygon:
PolygonGraphics|undefined
Gets or sets the polygon.
polyline
polyline:
PolylineGraphics|undefined
Gets or sets the polyline.
polylineVolume
polylineVolume:
PolylineVolumeGraphics|undefined
Gets or sets the polyline volume.
properties
properties:
PropertyBag|undefined
Gets or sets the bag of arbitrary properties associated with this entity.
position
position:
PositionProperty|undefined
Gets or sets the position.
rectangle
rectangle:
RectangleGraphics|undefined
Gets or sets the rectangle.
viewFrom
viewFrom:
Property|undefined
Gets or sets the suggested initial offset when tracking this object. The offset is typically defined in the east-north-up reference frame, but may be another frame depending on the object's velocity.
wall
wall:
WallGraphics|undefined
Gets or sets the wall.
方法
supportsMaterialsforEntitiesOnTerrain()
staticsupportsMaterialsforEntitiesOnTerrain(scene:Scene):boolean
Checks if the given Scene supports materials besides Color on Entities draped on terrain or 3D Tiles. If this feature is not supported, Entities with non-color materials but no height will instead be rendered as if height is 0.
参数
scene
The current scene.
返回
boolean
Whether or not the current scene supports materials for entities on terrain.
supportsPolylinesOnTerrain()
staticsupportsPolylinesOnTerrain(scene:Scene):boolean
Checks if the given Scene supports polylines clamped to terrain or 3D Tiles. If this feature is not supported, Entities with PolylineGraphics will be rendered with vertices at the provided heights and using the arcType parameter instead of clamped to the ground.
参数
scene
The current scene.
返回
boolean
Whether or not the current scene supports polylines on terrain or 3D TIles.
isAvailable()
isAvailable(
time:JulianDate):boolean
Given a time, returns true if this object should have data during that time.
参数
time
The time to check availability for.
返回
boolean
true if the object should have data during the provided time, false otherwise.
addProperty()
addProperty(
propertyName:string):void
Adds a property to this object. Once a property is added, it can be observed with Entity#definitionChanged and composited with CompositeEntityCollection
参数
propertyName
string
The name of the property to add.
返回
void
removeProperty()
removeProperty(
propertyName:string):void
Removed a property previously added with addProperty.
参数
propertyName
string
The name of the property to remove.
返回
void
merge()
merge(
source:Entity):void
Assigns each unassigned property on this object to the value of the same property on the provided source object.
参数
source
Entity
The object to be merged into this object.
返回
void
computeModelMatrix()
computeModelMatrix(
time:JulianDate,result?:Matrix4):Matrix4
Computes the model matrix for the entity's transform at specified time. Returns undefined if position is undefined
参数
time
The time to retrieve model matrix for.
result?
The object onto which to store the result.
返回
The modified result parameter or a new Matrix4 instance if one was not provided. Result is undefined if position is undefined.
构造函数
构造函数
new Entity(
options?:ConstructorOptions):Entity
参数
options?
返回
Entity