-
Notifications
You must be signed in to change notification settings - Fork 2
/
SessionState.ts
236 lines (222 loc) · 9.4 KB
/
SessionState.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
/*---------------------------------------------------------------------------------------------
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
* See LICENSE.md in the project root for license terms and full copyright notice.
*--------------------------------------------------------------------------------------------*/
/** @packageDocumentation
* @module State
*/
// The following definitions are causing extract-api issues on linux so for now just using any until we can figure out the issue.
import type { XAndY } from "@itwin/core-geometry";
// import { IModelConnection, ViewState } from "@itwin/core-frontend";
import type { CursorMenuItemProps, MenuItemProps } from "../shared/MenuItem";
import type { ActionsUnion, DeepReadonly } from "./redux-ts";
import { createAction } from "./redux-ts";
// cSpell:ignore configurableui snapmode toolprompt sessionstate imodelid viewid viewportid rulesetid
/** PresentationSelectionScope holds the id and the localized label for a selection scope supported for a specific iModel.
* Added to avoid an api-extract error caused by using SelectionScope.
* @public
*/
export interface PresentationSelectionScope {
id: string;
label: string;
}
/** Definition of data added to Redux store to define cursor menu. If menuItems are empty the menu control is not displayed.
* To close the menu clear the menuItems or pass in undefined as the CursorData.
* @public
* @deprecated in 4.11.x use {@link CursorMenuPayload} instead.
*/
export interface CursorMenuData {
position: XAndY;
childWindowId?: string;
// eslint-disable-next-line deprecation/deprecation
items: MenuItemProps[];
}
/**
* Definition of data added to Redux store to define cursor menu. If menuItems are empty the menu control is not displayed.
* To close the menu clear the menuItems or pass in undefined as the CursorData.
* @public
*/
export interface CursorMenuPayload {
position: XAndY;
childWindowId?: string;
items: CursorMenuItemProps[];
}
/** Action Ids used by Redux and to send sync UI components. Typically used to refresh visibility or enable state of control.
* Since these are also used as sync ids they should be in lowercase.
* @public
*/
export enum SessionStateActionId {
SetNumItemsSelected = "sessionstate:set-num-items-selected",
SetAvailableSelectionScopes = "sessionstate:set-available-selection-scopes",
SetSelectionScope = "sessionstate:set-selection-scope",
SetActiveIModelId = "sessionstate:set-active-imodelid",
SetIModelConnection = "sessionstate:set-imodel-connection",
SetDefaultIModelViewportControlId = "sessionstate:set-default-viewportid",
SetDefaultViewId = "sessionstate:set-default-viewid",
SetDefaultViewState = "sessionstate:set-default-view-state",
UpdateCursorMenu = "sessionstate:update-cursor-menu",
}
/** The portion of state managed by the SessionStateReducer.
* @public
*/
export interface SessionState {
numItemsSelected: number;
availableSelectionScopes: PresentationSelectionScope[];
activeSelectionScope: string;
iModelId: string;
defaultIModelViewportControlId: string | undefined;
defaultViewId: string | undefined;
defaultViewState: any;
iModelConnection: any;
// eslint-disable-next-line deprecation/deprecation
cursorMenuData: CursorMenuData | undefined; // @deprecated in 4.11.x use {@link CursorMenuPayload} instead
cursorMenuPayload: CursorMenuPayload | undefined;
}
const defaultSelectionScope = {
id: "element",
label: "Element",
} as PresentationSelectionScope;
/** used on first call of SessionStateReducer */
const initialState: SessionState = {
/** number of selected items in Presentation Selection */
numItemsSelected: 0,
/** initialize to only support "Element" scope, this will be overwritten when iModelConnection is established */
availableSelectionScopes: [defaultSelectionScope],
/** initialize to active selection scope to "Element", this will be overwritten when iModelConnection is established */
activeSelectionScope: defaultSelectionScope.id,
/** set to iModelId if an iModel is active else it is an empty string, so initialize to empty string */
iModelId: "",
defaultIModelViewportControlId: undefined,
defaultViewId: undefined,
defaultViewState: undefined,
iModelConnection: undefined,
cursorMenuData: undefined, // @deprecated in 4.11.x use {@link SessionState.cursorMenuPayload} instead
cursorMenuPayload: undefined,
};
/** An interface that allows redux connected object to dispatch changes to the SessionState reducer.
* @beta
*/
export interface SessionStateActionsProps {
setActiveIModelId: typeof SessionStateActions.setActiveIModelId;
setAvailableSelectionScopes: typeof SessionStateActions.setAvailableSelectionScopes;
setDefaultIModelViewportControlId: typeof SessionStateActions.setDefaultIModelViewportControlId;
setDefaultViewId: typeof SessionStateActions.setDefaultViewId;
setDefaultViewState: typeof SessionStateActions.setDefaultViewState;
setIModelConnection: typeof SessionStateActions.setIModelConnection;
setNumItemsSelected: typeof SessionStateActions.setNumItemsSelected;
setSelectionScope: typeof SessionStateActions.setSelectionScope;
updateCursorMenu: typeof SessionStateActions.updateCursorMenu;
}
/** An object with a function that creates each SessionStateReducer that can be handled by our reducer.
* @public
*/
export const SessionStateActions = {
setActiveIModelId:
// istanbul ignore next
(iModelId: string) =>
createAction(SessionStateActionId.SetActiveIModelId, iModelId),
setAvailableSelectionScopes:
// istanbul ignore next
(availableSelectionScopes: PresentationSelectionScope[]) =>
createAction(
SessionStateActionId.SetAvailableSelectionScopes,
availableSelectionScopes
),
setDefaultIModelViewportControlId: (iModelViewportControlId: string) =>
createAction(
SessionStateActionId.SetDefaultIModelViewportControlId,
iModelViewportControlId
),
setDefaultViewId: (viewId: string) =>
createAction(SessionStateActionId.SetDefaultViewId, viewId),
setDefaultViewState:
// istanbul ignore next
(viewState: any) =>
createAction(SessionStateActionId.SetDefaultViewState, viewState),
setNumItemsSelected: (numSelected: number) =>
createAction(SessionStateActionId.SetNumItemsSelected, numSelected),
setIModelConnection:
// istanbul ignore next
(iModelConnection: any) =>
createAction(SessionStateActionId.SetIModelConnection, iModelConnection),
setSelectionScope:
// istanbul ignore next
(activeSelectionScope: string) =>
createAction(
SessionStateActionId.SetSelectionScope,
activeSelectionScope
),
updateCursorMenu:
// istanbul ignore next
// eslint-disable-next-line deprecation/deprecation
(cursorMenuData: CursorMenuData | CursorMenuPayload) =>
createAction(SessionStateActionId.UpdateCursorMenu, cursorMenuData),
};
/** Object that contains available actions that modify SessionState. Parent control's props should
* extend from SessionStateActionsProps before using this in Redux 'connect' function.
* @beta
*/
// ...SessionStateActionsProps
export const sessionStateMapDispatchToProps = { ...SessionStateActions };
/** Union of SessionState Redux actions
* @public
*/
export type SessionStateActionsUnion = ActionsUnion<typeof SessionStateActions>;
/** Handles actions to update SessionState.
* @public
*/
export function SessionStateReducer(
state: SessionState = initialState,
action: SessionStateActionsUnion
): DeepReadonly<SessionState> {
switch (action.type) {
case SessionStateActionId.SetNumItemsSelected: {
// istanbul ignore else
if (undefined !== action.payload)
return { ...state, numItemsSelected: action.payload };
else return { ...state, numItemsSelected: 0 };
}
case SessionStateActionId.SetAvailableSelectionScopes: {
const payloadArray: PresentationSelectionScope[] = [];
action.payload.forEach((scope) => payloadArray.push(scope));
// istanbul ignore else
if (undefined !== action.payload)
return { ...state, availableSelectionScopes: payloadArray };
else
return { ...state, availableSelectionScopes: [defaultSelectionScope] };
}
case SessionStateActionId.SetSelectionScope: {
// istanbul ignore else
if (undefined !== action.payload)
return { ...state, activeSelectionScope: action.payload };
else return { ...state, activeSelectionScope: defaultSelectionScope.id };
}
case SessionStateActionId.SetActiveIModelId: {
// istanbul ignore else
if (undefined !== action.payload)
return { ...state, iModelId: action.payload };
else return { ...state, iModelId: "" };
}
case SessionStateActionId.SetDefaultIModelViewportControlId: {
return { ...state, defaultIModelViewportControlId: action.payload };
}
case SessionStateActionId.SetDefaultViewId: {
return { ...state, defaultViewId: action.payload };
}
case SessionStateActionId.SetDefaultViewState: {
return { ...state, defaultViewState: action.payload };
}
case SessionStateActionId.SetIModelConnection: {
return { ...state, iModelConnection: action.payload };
}
case SessionStateActionId.UpdateCursorMenu: {
return {
...state,
cursorMenuPayload: action.payload as CursorMenuPayload,
// eslint-disable-next-line deprecation/deprecation
cursorMenuData: action.payload as CursorMenuData,
};
}
}
return state;
}