Class ObjectStateHistory

Handle the history of object states

Index

Constructors

Accessors

Methods

clear initializeState pushState removeState updateState

Constructors

constructor

new ObjectStateHistory(): ObjectStateHistory
Returns ObjectStateHistory

Accessors

size

get size(): number
Returns number
- Defined in src/viewer/core/state/ObjectStateHistory.ts:60

Methods

clear

clear(): void
Returns void
- Defined in src/viewer/core/state/ObjectStateHistory.ts:64

initializeState

initializeState(
object: SceneObject,
): ObjectStateController<SceneObject, ObjectState>
Parameters
- object: SceneObject
Returns ObjectStateController<SceneObject, ObjectState>
- Defined in src/viewer/core/state/ObjectStateHistory.ts:18

pushState

pushState<T extends ObjectState>(
objects: Iterable<SceneObject>,
state: Partial<T & RestoreState>,
): null | number
Push a new state in the state controllers
Type Parameters
- T extends ObjectState
Parameters
- objects: Iterable<SceneObject>
- state: Partial<T & RestoreState>
Returns null | number
- Defined in src/viewer/core/state/ObjectStateHistory.ts:33

removeState

removeState(id: number): void
Remove the state from the state controllers
Parameters
- id: number
Returns void
- Defined in src/viewer/core/state/ObjectStateHistory.ts:73

updateState

updateState<T extends ObjectState>(
id: number,
state: Partial<T & RestoreState>,
): void
Update a state and recompute the final state of the objects
Type Parameters
- T extends ObjectState
Parameters
- id: number
- state: Partial<T & RestoreState>
Returns void
- Defined in src/viewer/core/state/ObjectStateHistory.ts:93