Entities

Entities and their graphics types.

_base

Base entity classes for cesiumkit.

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.

to_js()

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

to_czml()

Serialize to a CZML-compatible dict.

Entity

Bases: CesiumBase

A CesiumJS Entity with optional graphics attachments.

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.

EntityCollection

A collection of Entity objects, similar to CesiumJS EntityCollection.

add(entity=None, **kwargs)

Add an entity to the collection.

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

remove(entity)

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

remove_all()

Remove all entities from the collection.

get_by_id(id)

Find an entity by its id.

billboard

Billboard graphics for cesiumkit.

BillboardGraphics

Bases: EntityGraphics

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

box

Box graphics for cesiumkit.

BoxGraphics

Bases: EntityGraphics

A box (rectangular cuboid) shape.

corridor

Corridor graphics for cesiumkit.

CorridorGraphics

Bases: EntityGraphics

A corridor (extruded polyline) shape.

cylinder

Cylinder graphics for cesiumkit.

CylinderGraphics

Bases: EntityGraphics

A cylinder or cone shape.

ellipse

Ellipse graphics for cesiumkit.

EllipseGraphics

Bases: EntityGraphics

An ellipse shape on or above the surface.

ellipsoid

Ellipsoid graphics for cesiumkit.

EllipsoidGraphics

Bases: EntityGraphics

An ellipsoid (sphere/egg) shape.

label

Label graphics for cesiumkit.

LabelGraphics

Bases: EntityGraphics

A text label attached to an entity's position.

model

Model (3D) graphics for cesiumkit.

ModelGraphics

Bases: EntityGraphics

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

path

Path graphics for cesiumkit.

PathGraphics

Bases: EntityGraphics

A path showing an entity's trail over time.

point

Point graphics for cesiumkit.

PointGraphics

Bases: EntityGraphics

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

polygon

Polygon graphics for cesiumkit.

PolygonHierarchy

Bases: CesiumBase

A polygon defined by an outer boundary and optional holes.

PolygonGraphics

Bases: EntityGraphics

A polygon shape on or above the surface.

to_js()

Serialize with special handling for list-based hierarchy.

polyline

Polyline graphics for cesiumkit.

PolylineGraphics

Bases: EntityGraphics

A polyline (line strip) shape.

polyline_volume

Polyline volume graphics for cesiumkit.

PolylineVolumeGraphics

Bases: EntityGraphics

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

rectangle

Rectangle graphics for cesiumkit.

RectangleGraphics

Bases: EntityGraphics

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

wall

Wall graphics for cesiumkit.

WallGraphics

Bases: EntityGraphics

A wall shape draped along a path.

tileset

3D Tileset graphics for cesiumkit.

Cesium3DTilesetGraphics

Bases: EntityGraphics

A 3D Tiles tileset attached to an entity.

plane

Plane graphics for cesiumkit — flat surfaces 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.

particle

Scene-level Cesium particle systems.

ParticleSystem

Bases: CesiumBase

A particle primitive for smoke, fire, weather, and similar effects.

Cesium particle systems are scene primitives rather than entity graphics. Add one with :meth:cesiumkit.Viewer.add_particle_system.

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,
)