Entity (CesiumJS GWT Wrapper 1.59.4 API)

java.lang.Object
- org.cesiumjs.cs.datasources.Entity

@JsType(isNative=true,
        namespace="Cesium",
        name="Entity")
public class Entity
extends Object

Author:: Serge Silaev aka iSergio

Field Summary

Fields
Modifier and Type	Field and Description
`TimeIntervalCollection`	`availability` The availability, if any, associated with this object.
`BillboardGraphics`	`billboard` A billboard to associate with this entity.
`BoxGraphics`	`box` A box to associate with this entity.
`CorridorGraphics`	`corridor` A corridor to associate with this entity.
`CylinderGraphics`	`cylinder` A cylinder to associate with this entity.
`Property`	`description` A string Property specifying an HTML description for this entity.
`EllipseGraphics`	`ellipse` A ellipse to associate with this entity.
`EllipsoidGraphics`	`ellipsoid` A ellipsoid to associate with this entity.
`EntityCollection`	`entityCollection` Gets or sets the entity collection that this entity belongs to.
`String`	`id` A unique identifier for this object.
`boolean`	`isShowing` Gets whether this entity is being displayed, taking into account the visibility of any ancestor entities.
`LabelGraphics`	`label` A options.label to associate with this entity.
`ModelGraphics`	`model` A model to associate with this entity.
`String`	`name` A human readable name to display to users.
`Property`	`orientation` A Property specifying the entity orientation.
`Entity`	`parent` A parent entity to associate with this entity.
`PathGraphics`	`path` A path to associate with this entity.
`PlaneGraphics`	`plane` Gets or sets the plane.
`PointGraphics`	`point` A point to associate with this entity.
`PolygonGraphics`	`polygon` A polygon to associate with this entity.
`PolylineGraphics`	`polyline` A polyline to associate with this entity.
`PolylineVolumeGraphics`	`polylineVolume` A polylineVolume to associate with this entity.
`PositionProperty`	`position` A Property specifying the entity position.
`String[]`	`propertyNames` Gets the names of all properties registered on this instance.
`RectangleGraphics`	`rectangle` A rectangle to associate with this entity.
`boolean`	`show` A boolean value indicating if the entity and its children are displayed.
`Property`	`viewFrom` A suggested initial offset for viewing this object.
`WallGraphics`	`wall` A wall to associate with this entity.

Constructor Summary

Constructors
Constructor and Description
`Entity()` Entity instances aggregate multiple forms of visualization into a single high-level object.
`Entity(EntityOptions options)` Entity instances aggregate multiple forms of visualization into a single high-level object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addProperty(String propertyName)` Adds a property to this object.
`Matrix4`	`computeModelMatrix(JulianDate time)` Computes the model matrix for the entity's transform at specified time.
`Matrix4`	`computeModelMatrix(JulianDate time, Matrix4 result)` Computes the model matrix for the entity's transform at specified time.
`Event`	`definitionChanged()` Gets the event that is raised whenever a property or sub-property is changed or modified.
`boolean`	`isAvailable(JulianDate time)` Given a time, returns true if this object should have data during that time.
`void`	`merge(Entity source)` Assigns each unassigned property on this object to the value of the same property on the provided source object.
`void`	`removeProperty(String propertyName)` Removed a property previously added with addProperty.
`static boolean`	`supportsMaterialsforEntitiesOnTerrain(Scene scene)` Checks if the given Scene supports materials besides Color on Entities draped on terrain.
`static boolean`	`supportsPolylinesOnTerrain(Scene scene)` Checks if the given Scene supports polylines clamped to the ground..

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - entityCollection
```
@JsProperty
public EntityCollection entityCollection
```
    Gets or sets the entity collection that this entity belongs to.
  - isShowing
```
@JsProperty
public boolean isShowing
```
    Gets whether this entity is being displayed, taking into account the visibility of any ancestor entities.
  - id
```
@JsProperty
public String id
```
    A unique identifier for this object. If none is provided, a GUID is generated.
  - name
```
@JsProperty
public String name
```
    A human readable name to display to users. It does not have to be unique.
  - availability
```
@JsProperty
public TimeIntervalCollection availability
```
    The availability, if any, associated with this object.
  - show
```
@JsProperty
public boolean show
```
    A boolean value indicating if the entity and its children are displayed.
  - description
```
@JsProperty
public Property description
```
    A string Property specifying an HTML description for this entity.
  - position
```
@JsProperty
public PositionProperty position
```
    A Property specifying the entity position.
  - propertyNames
```
@JsProperty
public String[] propertyNames
```
    Gets the names of all properties registered on this instance.
  - orientation
```
@JsProperty
public Property orientation
```
    A Property specifying the entity orientation.
  - viewFrom
```
@JsProperty
public Property viewFrom
```
    A suggested initial offset for viewing this object.
  - parent
```
@JsProperty
public Entity parent
```
    A parent entity to associate with this entity.
  - billboard
```
@JsProperty
public BillboardGraphics billboard
```
    A billboard to associate with this entity.
  - box
```
@JsProperty
public BoxGraphics box
```
    A box to associate with this entity.
  - corridor
```
@JsProperty
public CorridorGraphics corridor
```
    A corridor to associate with this entity.
  - cylinder
```
@JsProperty
public CylinderGraphics cylinder
```
    A cylinder to associate with this entity.
  - ellipse
```
@JsProperty
public EllipseGraphics ellipse
```
    A ellipse to associate with this entity.
  - ellipsoid
```
@JsProperty
public EllipsoidGraphics ellipsoid
```
    A ellipsoid to associate with this entity.
  - label
```
@JsProperty
public LabelGraphics label
```
    A options.label to associate with this entity.
  - model
```
@JsProperty
public ModelGraphics model
```
    A model to associate with this entity.
  - path
```
@JsProperty
public PathGraphics path
```
    A path to associate with this entity.
  - plane
```
@JsProperty
public PlaneGraphics plane
```
    Gets or sets the plane.
  - point
```
@JsProperty
public PointGraphics point
```
    A point to associate with this entity.
  - polygon
```
@JsProperty
public PolygonGraphics polygon
```
    A polygon to associate with this entity.
  - polyline
```
@JsProperty
public PolylineGraphics polyline
```
    A polyline to associate with this entity.
  - polylineVolume
```
@JsProperty
public PolylineVolumeGraphics polylineVolume
```
    A polylineVolume to associate with this entity.
  - rectangle
```
@JsProperty
public RectangleGraphics rectangle
```
    A rectangle to associate with this entity.
  - wall
```
@JsProperty
public WallGraphics wall
```
    A wall to associate with this entity.
- Constructor Detail
  - Entity
```
@JsConstructor
public 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.
  - Entity
```
@JsConstructor
public Entity(EntityOptions options)
```
    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.
    
    Parameters:
    
    options - EntityOptions
- Method Detail
  - definitionChanged
```
@JsProperty(name="definitionChanged")
public Event definitionChanged()
```
    Gets the event that is raised whenever a property or sub-property is changed or modified.
  - supportsMaterialsforEntitiesOnTerrain
```
@JsMethod
public static boolean supportsMaterialsforEntitiesOnTerrain(Scene scene)
```
    Checks if the given Scene supports materials besides Color on Entities draped on terrain. If this feature is not supported, Entities with non-color materials but no `height` will instead be rendered as if height is 0.
    
    Parameters:
    
    scene - The current scene.
    
    Returns:
    
    Whether or not the current scene supports materials for entities on terrain.
  - supportsPolylinesOnTerrain
```
@JsMethod
public static boolean supportsPolylinesOnTerrain(Scene scene)
```
    Checks if the given Scene supports polylines clamped to the ground.. If this feature is not supported, Entities with PolylineGraphics will be rendered with vertices at the provided heights and using the `followSurface` parameter instead of clamped to the ground.
    
    Parameters:
    
    scene - The current scene.
    
    Returns:
    
    Whether or not the current scene supports Polylines on Terrain.
  - addProperty
```
@JsMethod
public void addProperty(String propertyName)
```
    Adds a property to this object. Once a property is added, it can be observed with definitionChanged() and composited with CompositeEntityCollection
    
    Parameters:
    
    propertyName - The name of the property to add.
  - computeModelMatrix
```
@JsMethod
public Matrix4 computeModelMatrix(JulianDate time)
```
    Computes the model matrix for the entity's transform at specified time. Returns undefined if orientation or position are undefined.
    
    Parameters:
    
    time - The time to retrieve model matrix for.
    
    Returns:
    
    The modified result parameter or a new Matrix4 instance if one was not provided. Result is undefined if position or orientation are undefined.
  - computeModelMatrix
```
@JsMethod
public Matrix4 computeModelMatrix(JulianDate time,
                                            Matrix4 result)
```
    Computes the model matrix for the entity's transform at specified time. Returns undefined if orientation or position are undefined.
    
    Parameters:
    
    time - The time to retrieve model matrix for.
    
    result - The object onto which to store the result.
    
    Returns:
    
    The modified result parameter or a new Matrix4 instance if one was not provided. Result is undefined if position or orientation are undefined.
  - isAvailable
```
@JsMethod
public boolean isAvailable(JulianDate time)
```
    Given a time, returns true if this object should have data during that time.
    
    Parameters:
    
    time - The time to check availability for.
    
    Returns:
    
    true if the object should have data during the provided time, false otherwise.
  - merge
```
@JsMethod
public void merge(Entity source)
```
    Assigns each unassigned property on this object to the value of the same property on the provided source object.
    
    Parameters:
    
    source - The object to be merged into this object.
  - removeProperty
```
@JsMethod
public void removeProperty(String propertyName)
```
    Removed a property previously added with addProperty.
    
    Parameters:
    
    propertyName - The name of the property to remove.

Class Entity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

entityCollection

isShowing

id

name

availability

show

description

position

propertyNames

orientation

viewFrom

parent

billboard

box

corridor

cylinder

ellipse

ellipsoid

label

model

path

plane

point

polygon

polyline

polylineVolume

rectangle

wall

Constructor Detail

Entity

Entity

Method Detail

definitionChanged

supportsMaterialsforEntitiesOnTerrain

supportsPolylinesOnTerrain

addProperty

computeModelMatrix

computeModelMatrix

isAvailable

merge

removeProperty