3D-City Model
    Preparing search index...

    Class PickedObject

    PickedObject – Normalizes interaction with a scene pick (entity, primitive, or 3D tile feature) in Cesium.

    Provides consistent access to IDs, type, mutable color, reactivity, selectability, and property tables. Designed to make selection/highlight UI and interactive tools generic across different Cesium pickable types.

    The raw result from Cesium's scene.pick or similar.

    getId() - Returns the unique ID for the picked primitive/entity/feature.

    content - Object's core Cesium or primitive instance for detailed property/visual access.

    determineIfDeletable() - Checks and returns whether this entity is deletable (from .properties.deletable).

    determineIfReactive() - Checks if object is currently "reactive."

    determineType() - Classifies object as Entity, Cesium3DTileFeature, or Primitive.

    getColor() - Gets the current color, handling type differences.

    colorize(color, [keep]) - Applies a highlight/temporary color (returns to original on clearColor()).

    clearColor() - Restores the object's previous color (before highlight/selection).

    const picked = new PickedObject(pickedObj);
    picked.colorize(new Color(1,0,0)); // highlight red
    picked.clearColor(); // restore
    Index

    Constructors

    constructor

    Properties

    color originalColor pickedObject reactive selectable type

    Accessors

    content propertyTable

    Methods

    clearColor colorize determineEntityType determineIfDeletable determineIfReactive determineType getColor getId

    Constructors

    Properties

    color: null | Color

    Current highlight/selected color.

    originalColor: any

    The object's color before highlighting.

    pickedObject: any

    The original picked object.

    reactive: boolean

    If true, object can be interacted with.

    selectable: boolean

    If this object is interactively selectable.

    type: undefined | Function

    Object type (Entity, Cesium3DTileFeature, Primitive).

    Accessors

    content

    • get content(): any

      The actual Cesium entity, primitive, or tile feature being interacted with.

      Returns any

    • get propertyTable(): undefined | string | [string, any][]

      Returns a property table representing all displayable info for the picked object. For Cesium3DTileFeature, gathers property IDs and values, using external attributes if provided.

      Returns undefined | string | [string, any][]

    Methods

    • Applies the given highlight/selection color. Stores previous color for later restoration (if keep=true). Throws if color is not instance of Color.

      Parameters

      • color: Color
      • Optionalkeep: boolean = true

        Whether to track the old color for later restoration.

      Returns void

    • Returns the shape type for Cesium entities (polygon, polyline, or point).

      Parameters

      • pickedEntity: any

      Returns any

      Underlying primitive.

    • Checks if this object is deletable (from .properties.deletable, if present).

      Returns boolean

    • Checks if this object is reactive (from .properties.reactive, if present).

      Returns boolean

    • Determines the picked object's high-level type.

      Returns undefined | Function

    • Gets the current color for the feature/entity/primitive.

      Returns undefined | Color

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods