JME - Application Documentation
    Preparing search index...

    Type Alias JModellerState

    Central application state provided by JModellerContext

    type JModellerState = {
        carsReady: boolean;
        confirmConfig: () => void;
        followedVehicleId: number | null;
        followedVehicleStats: FollowedVehicleStats | null;
        haltSim: () => void;
        isConfigConfirmed: boolean;
        junction: JunctionConfig;
        junctionObjectRefs: React.RefObject<THREE.Group<THREE.Object3DEventMap>[]>;
        objectCounter: number;
        pauseSim: () => void;
        registerJunctionObject: (group: THREE.Group) => void;
        removeObject: (objID: string) => void;
        resetConfig: () => void;
        resumeSim: () => void;
        selectedExits: ExitRef[];
        selectedObjects: string[];
        setCarsReady: React.Dispatch<React.SetStateAction<boolean>>;
        setFollowedVehicleId: React.Dispatch<React.SetStateAction<number | null>>;
        setFollowedVehicleStats: React.Dispatch<
            React.SetStateAction<FollowedVehicleStats | null>,
        >;
        setJunction: (
            junction: JunctionConfig | ((prev: JunctionConfig) => JunctionConfig),
        ) => void;
        setObjectCounter: React.Dispatch<React.SetStateAction<number>>;
        setSelectedExits: React.Dispatch<React.SetStateAction<ExitRef[]>>;
        setSelectedObjects: React.Dispatch<React.SetStateAction<string[]>>;
        setShowOverlayLabels: React.Dispatch<React.SetStateAction<boolean>>;
        setSimConfig: React.Dispatch<React.SetStateAction<SimConfig>>;
        setStats: React.Dispatch<React.SetStateAction<SimulationStats>>;
        setToolMode: React.Dispatch<React.SetStateAction<"view" | "build">>;
        showOverlayLabels: boolean;
        simConfig: SimConfig;
        simIsPaused: boolean;
        simIsRunning: boolean;
        snapToValidPosition: (
            draggedGroup: THREE.Group<THREE.Object3DEventMap>,
        ) => void;
        startSim: () => void;
        stats: SimulationStats;
        toolMode: "view" | "build";
        unregisterJunctionObject: (
            group: THREE.Group<THREE.Object3DEventMap>,
        ) => void;
    }
    Index

    Properties

    carsReady: boolean
    confirmConfig: () => void
    followedVehicleId: number | null
    followedVehicleStats: FollowedVehicleStats | null
    haltSim: () => void
    isConfigConfirmed: boolean
    junction: JunctionConfig
    junctionObjectRefs: React.RefObject<THREE.Group<THREE.Object3DEventMap>[]>
    objectCounter: number
    pauseSim: () => void
    registerJunctionObject: (group: THREE.Group) => void
    removeObject: (objID: string) => void
    resetConfig: () => void
    resumeSim: () => void
    selectedExits: ExitRef[]
    selectedObjects: string[]
    setCarsReady: React.Dispatch<React.SetStateAction<boolean>>
    setFollowedVehicleId: React.Dispatch<React.SetStateAction<number | null>>
    setFollowedVehicleStats: React.Dispatch<
        React.SetStateAction<FollowedVehicleStats | null>,
    >
    setJunction: (
        junction: JunctionConfig | ((prev: JunctionConfig) => JunctionConfig),
    ) => void
    setObjectCounter: React.Dispatch<React.SetStateAction<number>>
    setSelectedExits: React.Dispatch<React.SetStateAction<ExitRef[]>>
    setSelectedObjects: React.Dispatch<React.SetStateAction<string[]>>
    setShowOverlayLabels: React.Dispatch<React.SetStateAction<boolean>>
    setSimConfig: React.Dispatch<React.SetStateAction<SimConfig>>
    setStats: React.Dispatch<React.SetStateAction<SimulationStats>>
    setToolMode: React.Dispatch<React.SetStateAction<"view" | "build">>
    showOverlayLabels: boolean
    simConfig: SimConfig
    simIsPaused: boolean
    simIsRunning: boolean
    snapToValidPosition: (draggedGroup: THREE.Group<THREE.Object3DEventMap>) => void
    startSim: () => void
    toolMode: "view" | "build"
    unregisterJunctionObject: (group: THREE.Group<THREE.Object3DEventMap>) => void