forked from JeremyHeleine/Photo-Sphere-Viewer
-
-
Notifications
You must be signed in to change notification settings - Fork 634
/
events.ts
174 lines (150 loc) · 4.44 KB
/
events.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
import { TypedEvent } from '@photo-sphere-viewer/core';
import type { Marker } from './markers/Marker';
import type { MarkersPlugin } from './MarkersPlugin';
/**
* Base class for events dispatched by {@link MarkersPlugin}
*/
export abstract class MarkersPluginEvent extends TypedEvent<MarkersPlugin> {}
/**
* @event Triggered when the visibility of a marker changes
*/
export class MarkerVisibilityEvent extends MarkersPluginEvent {
static override readonly type = 'marker-visibility';
override type: 'marker-visibility';
/** @internal */
constructor(
public readonly marker: Marker,
public readonly visible: boolean
) {
super(MarkerVisibilityEvent.type);
}
}
/**
* @event Triggered when the animation to a marker is done
*/
export class GotoMarkerDoneEvent extends MarkersPluginEvent {
static override readonly type = 'goto-marker-done';
override type: 'goto-marker-done';
/** @internal */
constructor(public readonly marker: Marker) {
super(GotoMarkerDoneEvent.type);
}
}
/**
* @event Triggered when the user puts the cursor away from a marker
*/
export class LeaveMarkerEvent extends MarkersPluginEvent {
static override readonly type = 'leave-marker';
override type: 'leave-marker';
/** @internal */
constructor(public readonly marker: Marker) {
super(LeaveMarkerEvent.type);
}
}
/**
* @event Triggered when the user puts the cursor hover a marker
*/
export class EnterMarkerEvent extends MarkersPluginEvent {
static override readonly type = 'enter-marker';
override type: 'enter-marker';
/** @internal */
constructor(public readonly marker: Marker) {
super(EnterMarkerEvent.type);
}
}
/**
* @event Triggered when the user clicks on a marker
*/
export class SelectMarkerEvent extends MarkersPluginEvent {
static override readonly type = 'select-marker';
override type: 'select-marker';
/** @internal */
constructor(
public readonly marker: Marker,
public readonly doubleClick: boolean,
public readonly rightClick: boolean
) {
super(SelectMarkerEvent.type);
}
}
/**
* @event Triggered when a marker is selected from the side panel
*/
export class SelectMarkerListEvent extends MarkersPluginEvent {
static override readonly type = 'select-marker-list';
override type: 'select-marker-list';
/** @internal */
constructor(public readonly marker: Marker) {
super(SelectMarkerListEvent.type);
}
}
/**
* @event Triggered when a marker was selected and the user clicks elsewhere
*/
export class UnselectMarkerEvent extends MarkersPluginEvent {
static override readonly type = 'unselect-marker';
override type: 'unselect-marker';
/** @internal */
constructor(public readonly marker: Marker) {
super(UnselectMarkerEvent.type);
}
}
/**
* @event Triggered when the markers are hidden
*/
export class HideMarkersEvent extends MarkersPluginEvent {
static override readonly type = 'hide-markers';
override type: 'hide-markers';
/** @internal */
constructor() {
super(HideMarkersEvent.type);
}
}
/**
* @event Triggered when the markers change
*/
export class SetMarkersEvent extends MarkersPluginEvent {
static override readonly type = 'set-markers';
override type: 'set-markers';
/** @internal */
constructor(public readonly markers: Marker[]) {
super(SetMarkersEvent.type);
}
}
/**
* @event Triggered when the markers are shown
*/
export class ShowMarkersEvent extends MarkersPluginEvent {
static override readonly type = 'show-markers';
override type: 'show-markers';
/** @internal */
constructor() {
super(ShowMarkersEvent.type);
}
}
/**
* @event Used to alter the list of markers displayed in the side-panel
*/
export class RenderMarkersListEvent extends MarkersPluginEvent {
static override readonly type = 'render-markers-list';
override type: 'render-markers-list';
/** @internal */
constructor(
/** the list of markers to display, can be modified */
public markers: Marker[]
) {
super(RenderMarkersListEvent.type);
}
}
export type MarkersPluginEvents =
| MarkerVisibilityEvent
| GotoMarkerDoneEvent
| LeaveMarkerEvent
| EnterMarkerEvent
| SelectMarkerEvent
| SelectMarkerListEvent
| UnselectMarkerEvent
| HideMarkersEvent
| SetMarkersEvent
| ShowMarkersEvent
| RenderMarkersListEvent;