3D-City Model
    Preparing search index...

    Class State

    State – Abstract/base class for representing a UI or application state in an interactive application (such as a Cesium/3D tool).

    Encapsulates state name and relationships to other states (mutual exclusivity, restore, and dependencies) and provides a standardized interface for managing state logic. Designed to be subclassed for concrete state implementations (e.g., measurement, edit, or navigation modes).

    The unique name or identifier of the state (e.g., "default", "polygon", "dimension").

    Names of states that cannot coexist with this one (mutually exclusive).

    Names of states to restore/activate when this state ends.

    Names of other states this state relies on.

    remove() - Removes/deactivates the state (intended to be overridden or extended by subclasses).

    class CustomModeState extends State {
      constructor() {
        super('custom', ['edit', 'default'], ['default'], []);
      }
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    dependentStates exclusiveStates name restoreStates

    Methods

    remove

    Constructors

    • Parameters

      • name: string
      • OptionalexclusiveStates: string[] = []
      • OptionalrestoreStates: string[] = []
      • OptionaldependentStates: string[] = []

      Returns State

    Properties

    dependentStates: string[]

    Required/precondition states.

    exclusiveStates: string[]

    States that are deactivated when this state activates.

    name: string

    Name/identifier for the state.

    restoreStates: string[]

    States that should be restored when this state ends.

    Methods

    • Removes or deactivates this state. May be overridden by subclasses.

      Returns boolean

      Always returns true.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods