Entities¶

Entities and their graphics types.

_base ¶

Base entity classes for cesiumkit.

Classes:

Name	Description
`EntityGraphics`	Base class for all entity graphics types (PointGraphics, PolygonGraphics, etc.).
`Entity`	A CesiumJS Entity with optional graphics attachments.
`EntityCollection`	A collection of Entity objects, similar to CesiumJS EntityCollection.

EntityGraphics ¶

Bases: CesiumBase

Base class for all entity graphics types (PointGraphics, PolygonGraphics, etc.).

Subclasses define the specific properties for each graphics type. Serializes as a plain JS object literal (not a constructor call) because CesiumJS Entity.add() accepts plain option objects for graphics.

Methods:

Name	Description
`to_js`	Serialize as a JS object literal for use inside Entity options.
`to_czml`	Serialize to a CZML-compatible dict.

to_js ¶

to_js() -> str

Serialize as a JS object literal for use inside Entity options.

to_czml ¶

to_czml() -> dict

Serialize to a CZML-compatible dict.

Entity ¶

Bases: CesiumBase

A CesiumJS Entity with optional graphics attachments.

Methods:

Name	Description
`to_js`	Serialize to a JS object literal for use with viewer.entities.add().
`to_czml_packet`	Build a CZML packet dict for this entity.

to_js ¶

to_js() -> str

Serialize to a JS object literal for use with viewer.entities.add().

to_czml_packet ¶

to_czml_packet() -> dict

Build a CZML packet dict for this entity.

EntityCollection ¶

EntityCollection()

A collection of Entity objects, similar to CesiumJS EntityCollection.

Methods:

Name	Description
`add`	Add an entity to the collection.
`remove`	Remove an entity from the collection. Returns True if found.
`remove_all`	Remove all entities from the collection.
`get_by_id`	Find an entity by its id.

add ¶

add(entity: Entity | None = None, **kwargs: Any) -> Entity

Add an entity to the collection.

Can pass an Entity instance or keyword arguments to construct one.

remove ¶

remove(entity: Entity) -> bool

Remove an entity from the collection. Returns True if found.

remove_all ¶

remove_all() -> None

Remove all entities from the collection.

get_by_id ¶

get_by_id(id: str) -> Entity | None

Find an entity by its id.

billboard ¶

Billboard graphics for cesiumkit.

Classes:

Name	Description
`BillboardGraphics`	A billboard (2D image) attached to an entity's position.

BillboardGraphics ¶

Bases: EntityGraphics

A billboard (2D image) attached to an entity's position.

box ¶

Box graphics for cesiumkit.

Classes:

Name	Description
`BoxGraphics`	A box (rectangular cuboid) shape.

BoxGraphics ¶

Bases: EntityGraphics

A box (rectangular cuboid) shape.

corridor ¶

Corridor graphics for cesiumkit.

Classes:

Name	Description
`CorridorGraphics`	A corridor (extruded polyline) shape.

CorridorGraphics ¶

Bases: EntityGraphics

A corridor (extruded polyline) shape.

cylinder ¶

Cylinder graphics for cesiumkit.

Classes:

Name	Description
`CylinderGraphics`	A cylinder or cone shape.

CylinderGraphics ¶

Bases: EntityGraphics

A cylinder or cone shape.

ellipse ¶

Ellipse graphics for cesiumkit.

Classes:

Name	Description
`EllipseGraphics`	An ellipse shape on or above the surface.

EllipseGraphics ¶

Bases: EntityGraphics

An ellipse shape on or above the surface.

ellipsoid ¶

Ellipsoid graphics for cesiumkit.

Classes:

Name	Description
`EllipsoidGraphics`	An ellipsoid (sphere/egg) shape.

EllipsoidGraphics ¶

Bases: EntityGraphics

An ellipsoid (sphere/egg) shape.

label ¶

Label graphics for cesiumkit.

Classes:

Name	Description
`LabelGraphics`	A text label attached to an entity's position.

LabelGraphics ¶

Bases: EntityGraphics

A text label attached to an entity's position.

model ¶

Model (3D) graphics for cesiumkit.

Classes:

Name	Description
`ModelGraphics`	A 3D model (glTF/glb) attached to an entity.

ModelGraphics ¶

Bases: EntityGraphics

A 3D model (glTF/glb) attached to an entity.

path ¶

Path graphics for cesiumkit.

Classes:

Name	Description
`PathGraphics`	A path showing an entity's trail over time.

PathGraphics ¶

Bases: EntityGraphics

A path showing an entity's trail over time.

point ¶

Point graphics for cesiumkit.

Classes:

Name	Description
`PointGraphics`	A point (pixel-sized dot) attached to an entity's position.

PointGraphics ¶

Bases: EntityGraphics

A point (pixel-sized dot) attached to an entity's position.

polygon ¶

Polygon graphics for cesiumkit.

Classes:

Name	Description
`PolygonHierarchy`	A polygon defined by an outer boundary and optional holes.
`PolygonGraphics`	A polygon shape on or above the surface.

PolygonHierarchy ¶

Bases: CesiumBase

A polygon defined by an outer boundary and optional holes.

PolygonGraphics ¶

Bases: EntityGraphics

A polygon shape on or above the surface.

Methods:

Name	Description
`to_js`	Serialize with special handling for list-based hierarchy.

to_js ¶

to_js() -> str

Serialize with special handling for list-based hierarchy.

polyline ¶

Polyline graphics for cesiumkit.

Classes:

Name	Description
`PolylineGraphics`	A polyline (line strip) shape.

PolylineGraphics ¶

Bases: EntityGraphics

A polyline (line strip) shape.

polyline_volume ¶

Polyline volume graphics for cesiumkit.

Classes:

Name	Description
`PolylineVolumeGraphics`	A polyline with a 2D cross-section shape extruded along it.

PolylineVolumeGraphics ¶

Bases: EntityGraphics

A polyline with a 2D cross-section shape extruded along it.

rectangle ¶

Rectangle graphics for cesiumkit.

Classes:

Name	Description
`RectangleGraphics`	A rectangle (lat/lon extent) shape on or above the surface.

RectangleGraphics ¶

Bases: EntityGraphics

A rectangle (lat/lon extent) shape on or above the surface.

wall ¶

Wall graphics for cesiumkit.

Classes:

Name	Description
`WallGraphics`	A wall shape draped along a path.

WallGraphics ¶

Bases: EntityGraphics

A wall shape draped along a path.

tileset ¶

3D Tileset graphics for cesiumkit.

Classes:

Name	Description
`Cesium3DTilesetGraphics`	A 3D Tiles tileset attached to an entity.

Cesium3DTilesetGraphics ¶

Bases: EntityGraphics

A 3D Tiles tileset attached to an entity.

plane ¶

Plane graphics for cesiumkit — flat surfaces in 3D space.

Classes:

Name	Description
`Plane`	A plane represented by a normal vector and signed distance.
`PlaneGraphics`	A plane (flat surface) positioned in 3D space.

Plane ¶

Bases: CesiumBase

A plane represented by a normal vector and signed distance.

PlaneGraphics ¶

Bases: EntityGraphics

A plane (flat surface) positioned in 3D space.

Useful for flight paths, range rings, radar coverage, and UI panels rendered in the 3D scene.

Planes¶

PlaneGraphics is a normal entity graphic. Construct its geometric plane from a normal vector and signed distance:

plane = cesiumkit.Plane(normal=cesiumkit.Cartesian3(x=0, y=0, z=1), distance=0)
entity = cesiumkit.Entity(
    plane=cesiumkit.PlaneGraphics(
        plane=plane,
        dimensions=cesiumkit.Cartesian2(x=100, y=100),
        material=cesiumkit.Color.RED,
    )
)

Particle systems¶

Cesium particle systems are scene primitives, not entity graphics:

viewer.add_particle_system(
    image="smoke.png",
    emission_rate=10,
    particle_life=2,
    start_scale=1,
    end_scale=0.1,
)