@kitware/vtk.js 30.6.0 → 30.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (206) hide show
  1. package/Common/Core/Base64.d.ts +2 -2
  2. package/Common/Core/CellArray.d.ts +45 -42
  3. package/Common/Core/DataArray.d.ts +465 -449
  4. package/Common/Core/Endian.d.ts +5 -5
  5. package/Common/Core/HalfFloat.d.ts +3 -3
  6. package/Common/Core/ImageHelper.d.ts +11 -5
  7. package/Common/Core/LookupTable.d.ts +260 -257
  8. package/Common/Core/Math.d.ts +461 -270
  9. package/Common/Core/MatrixBuilder.d.ts +117 -112
  10. package/Common/Core/Points.d.ts +114 -106
  11. package/Common/Core/PriorityQueue.d.ts +34 -30
  12. package/Common/Core/ProgressHandler.d.ts +44 -39
  13. package/Common/Core/ScalarsToColors/Constants.d.ts +9 -9
  14. package/Common/Core/ScalarsToColors.d.ts +351 -326
  15. package/Common/Core/StringArray.d.ts +94 -89
  16. package/Common/Core/URLExtract.d.ts +9 -6
  17. package/Common/Core/VariantArray.d.ts +94 -89
  18. package/Common/DataModel/AbstractPointLocator.d.ts +18 -18
  19. package/Common/DataModel/Box.d.ts +60 -52
  20. package/Common/DataModel/CardinalSpline1D.d.ts +59 -34
  21. package/Common/DataModel/Cell.d.ts +70 -67
  22. package/Common/DataModel/Collection.d.ts +100 -84
  23. package/Common/DataModel/Cone.d.ts +30 -27
  24. package/Common/DataModel/Cylinder.d.ts +122 -112
  25. package/Common/DataModel/DataSet/Constants.d.ts +9 -9
  26. package/Common/DataModel/DataSet.d.ts +38 -35
  27. package/Common/DataModel/DataSetAttributes/FieldData.d.ts +217 -206
  28. package/Common/DataModel/DataSetAttributes.d.ts +420 -415
  29. package/Common/DataModel/EdgeLocator.d.ts +82 -79
  30. package/Common/DataModel/ITKHelper.d.ts +33 -22
  31. package/Common/DataModel/ImageData.d.ts +362 -340
  32. package/Common/DataModel/IncrementalOctreeNode.d.ts +242 -242
  33. package/Common/DataModel/IncrementalOctreePointLocator.d.ts +16 -16
  34. package/Common/DataModel/KochanekSpline1D.d.ts +60 -36
  35. package/Common/DataModel/Line.d.ts +104 -83
  36. package/Common/DataModel/Locator.d.ts +10 -10
  37. package/Common/DataModel/PiecewiseFunction.d.ts +215 -199
  38. package/Common/DataModel/Plane.d.ts +255 -223
  39. package/Common/DataModel/PointSet.d.ts +32 -28
  40. package/Common/DataModel/PolyData/Constants.d.ts +2 -2
  41. package/Common/DataModel/PolyData.d.ts +143 -140
  42. package/Common/DataModel/PolyLine.d.ts +51 -28
  43. package/Common/DataModel/Polygon.d.ts +34 -33
  44. package/Common/DataModel/SelectionNode/Constants.d.ts +18 -18
  45. package/Common/DataModel/SelectionNode.d.ts +62 -56
  46. package/Common/DataModel/Sphere.d.ts +74 -72
  47. package/Common/DataModel/Spline1D.d.ts +60 -40
  48. package/Common/DataModel/Spline3D/Constants.d.ts +3 -3
  49. package/Common/DataModel/Spline3D.d.ts +27 -22
  50. package/Common/Transform/LandmarkTransform.d.ts +67 -64
  51. package/Common/Transform/Transform.d.ts +148 -126
  52. package/Filters/General/AppendPolyData.d.ts +43 -37
  53. package/Filters/General/ClipClosedSurface.d.ts +41 -41
  54. package/Filters/General/ContourTriangulator.d.ts +38 -38
  55. package/Filters/General/ImageCropFilter.d.ts +48 -44
  56. package/Filters/General/ImageDataOutlineFilter.d.ts +41 -37
  57. package/Filters/General/ImageOutlineFilter.d.ts +41 -37
  58. package/Filters/General/ImageSliceFilter.d.ts +38 -34
  59. package/Filters/General/ImageStreamline.d.ts +120 -93
  60. package/Filters/General/LineFilter.d.ts +18 -15
  61. package/Filters/General/OutlineFilter.d.ts +19 -16
  62. package/Filters/General/TriangleFilter.d.ts +23 -19
  63. package/Filters/General/TubeFilter.d.ts +194 -188
  64. package/Filters/Sources/Arrow2DSource.d.ts +151 -143
  65. package/Filters/Sources/ArrowSource.d.ts +148 -140
  66. package/Filters/Sources/CircleSource.d.ts +138 -130
  67. package/Filters/Sources/ConeSource.d.ts +167 -159
  68. package/Filters/Sources/CubeSource.d.ts +198 -181
  69. package/Filters/Sources/Cursor3D.d.ts +171 -164
  70. package/Filters/Sources/CylinderSource.d.ts +173 -166
  71. package/Filters/Sources/LineSource.d.ts +100 -92
  72. package/Filters/Sources/PlaneSource.d.ts +211 -203
  73. package/Filters/Sources/PointSource.d.ts +90 -82
  74. package/Filters/Sources/SphereSource.d.ts +171 -164
  75. package/Filters/Texture/TextureMapToPlane.d.ts +213 -208
  76. package/Filters/Texture/TextureMapToSphere.d.ts +77 -72
  77. package/IO/Core/DataAccessHelper/HtmlDataAccessHelper.d.ts +18 -5
  78. package/IO/Core/DataAccessHelper/HttpDataAccessHelper.d.ts +18 -5
  79. package/IO/Core/DataAccessHelper/JSZipDataAccessHelper.d.ts +19 -6
  80. package/IO/Core/DataAccessHelper/LiteHttpDataAccessHelper.d.ts +18 -5
  81. package/IO/Core/DataAccessHelper.d.ts +36 -22
  82. package/IO/Core/HttpDataSetReader.d.ts +279 -249
  83. package/IO/Core/HttpSceneLoader.d.ts +92 -87
  84. package/IO/Core/ImageStream/DefaultProtocol.d.ts +27 -20
  85. package/IO/Core/ImageStream/ViewStream.d.ts +7 -7
  86. package/IO/Core/ImageStream.d.ts +52 -47
  87. package/IO/Core/WSLinkClient.d.ts +12 -6
  88. package/IO/Geometry/DracoReader.d.ts +106 -88
  89. package/IO/Geometry/PLYReader.d.ts +92 -75
  90. package/IO/Geometry/PLYWriter.d.ts +163 -148
  91. package/IO/Geometry/STLReader.d.ts +92 -77
  92. package/IO/Geometry/STLWriter.d.ts +50 -42
  93. package/IO/Misc/ElevationReader.d.ts +155 -139
  94. package/IO/Misc/ITKImageReader.d.ts +58 -50
  95. package/IO/Misc/ITKPolyDataReader.d.ts +58 -50
  96. package/IO/Misc/JSONNucleoReader.d.ts +74 -57
  97. package/IO/Misc/JSONReader.d.ts +78 -72
  98. package/IO/Misc/MTLReader.d.ts +143 -130
  99. package/IO/Misc/OBJReader.d.ts +129 -110
  100. package/IO/Misc/PDBReader.d.ts +109 -93
  101. package/IO/XML/XMLImageDataReader.d.ts +31 -19
  102. package/IO/XML/XMLPolyDataReader.d.ts +31 -19
  103. package/IO/XML/XMLReader.d.ts +141 -105
  104. package/Imaging/Core/AbstractImageInterpolator/Constants.d.ts +2 -2
  105. package/Imaging/Core/ImageReslice.d.ts +231 -173
  106. package/Interaction/Style/InteractorStyleHMDXR.d.ts +7 -3
  107. package/Interaction/Style/InteractorStyleImage.d.ts +5 -4
  108. package/Interaction/Style/InteractorStyleTrackballCamera.d.ts +17 -6
  109. package/Interaction/Widgets/OrientationMarkerWidget/Constants.d.ts +5 -5
  110. package/Interaction/Widgets/OrientationMarkerWidget.d.ts +146 -142
  111. package/Proxy/Core/ViewProxy.d.ts +1 -1
  112. package/Proxy/Representations/GeometryRepresentationProxy.d.ts +28 -27
  113. package/Proxy/Representations/ResliceRepresentationProxy.d.ts +0 -1
  114. package/Rendering/Core/AbstractImageMapper.d.ts +125 -113
  115. package/Rendering/Core/AbstractMapper.d.ts +58 -52
  116. package/Rendering/Core/AbstractMapper3D.d.ts +32 -25
  117. package/Rendering/Core/AbstractPicker.d.ts +91 -88
  118. package/Rendering/Core/Actor.d.ts +117 -114
  119. package/Rendering/Core/Actor2D.d.ts +101 -98
  120. package/Rendering/Core/AnnotatedCubeActor.d.ts +58 -53
  121. package/Rendering/Core/AxesActor.d.ts +10 -4
  122. package/Rendering/Core/Camera.d.ts +739 -727
  123. package/Rendering/Core/CellPicker.d.ts +87 -77
  124. package/Rendering/Core/ColorTransferFunction/Constants.d.ts +2 -2
  125. package/Rendering/Core/ColorTransferFunction/CssFilters.d.ts +39 -13
  126. package/Rendering/Core/ColorTransferFunction.d.ts +3 -6
  127. package/Rendering/Core/Coordinate/Constants.d.ts +1 -1
  128. package/Rendering/Core/Coordinate.d.ts +154 -150
  129. package/Rendering/Core/Follower.d.ts +52 -47
  130. package/Rendering/Core/Glyph3DMapper/Constants.d.ts +8 -8
  131. package/Rendering/Core/Glyph3DMapper.d.ts +152 -149
  132. package/Rendering/Core/ImageArrayMapper.d.ts +237 -213
  133. package/Rendering/Core/ImageCPRMapper/Constants.d.ts +4 -4
  134. package/Rendering/Core/ImageCPRMapper.d.ts +424 -392
  135. package/Rendering/Core/ImageMapper/Constants.d.ts +8 -8
  136. package/Rendering/Core/ImageMapper.d.ts +292 -268
  137. package/Rendering/Core/ImageProperty/Constants.d.ts +3 -3
  138. package/Rendering/Core/ImageProperty.d.ts +204 -197
  139. package/Rendering/Core/ImageResliceMapper/Constants.d.ts +5 -5
  140. package/Rendering/Core/ImageResliceMapper.d.ts +235 -210
  141. package/Rendering/Core/ImageSlice.d.ts +142 -136
  142. package/Rendering/Core/InteractorObserver.d.ts +41 -32
  143. package/Rendering/Core/Light.d.ts +321 -318
  144. package/Rendering/Core/Mapper/Constants.d.ts +14 -14
  145. package/Rendering/Core/Mapper.d.ts +539 -512
  146. package/Rendering/Core/Mapper2D.d.ts +342 -330
  147. package/Rendering/Core/Picker.d.ts +114 -106
  148. package/Rendering/Core/PixelSpaceCallbackMapper.d.ts +56 -40
  149. package/Rendering/Core/PointPicker.d.ts +42 -37
  150. package/Rendering/Core/Prop/Constants.d.ts +3 -3
  151. package/Rendering/Core/Prop.d.ts +274 -274
  152. package/Rendering/Core/Prop3D.d.ts +259 -257
  153. package/Rendering/Core/Property/Constants.d.ts +12 -12
  154. package/Rendering/Core/Property.d.ts +535 -531
  155. package/Rendering/Core/Property2D/Constants.d.ts +1 -1
  156. package/Rendering/Core/Property2D.d.ts +114 -109
  157. package/Rendering/Core/RenderWindow.d.ts +193 -191
  158. package/Rendering/Core/RenderWindowInteractor/Constants.d.ts +19 -19
  159. package/Rendering/Core/RenderWindowInteractor.d.ts +1335 -1219
  160. package/Rendering/Core/Renderer.d.ts +677 -663
  161. package/Rendering/Core/ScalarBarActor.d.ts +333 -322
  162. package/Rendering/Core/Skybox.d.ts +45 -42
  163. package/Rendering/Core/SphereMapper.d.ts +49 -44
  164. package/Rendering/Core/StickMapper.d.ts +49 -44
  165. package/Rendering/Core/Texture.d.ts +87 -80
  166. package/Rendering/Core/Viewport.d.ts +229 -222
  167. package/Rendering/Core/Volume.d.ts +78 -73
  168. package/Rendering/Core/VolumeMapper/Constants.d.ts +11 -11
  169. package/Rendering/Core/VolumeMapper.d.ts +295 -285
  170. package/Rendering/Core/VolumeProperty/Constants.d.ts +19 -19
  171. package/Rendering/Core/VolumeProperty.d.ts +375 -365
  172. package/Rendering/Misc/CanvasView.d.ts +148 -145
  173. package/Rendering/Misc/FullScreenRenderWindow.d.ts +111 -108
  174. package/Rendering/Misc/GenericRenderWindow.d.ts +69 -65
  175. package/Rendering/Misc/RenderWindowWithControlBar.d.ts +46 -39
  176. package/Rendering/Misc/SynchronizableRenderWindow/ObjectManager.d.ts +49 -29
  177. package/Rendering/Misc/SynchronizableRenderWindow.d.ts +51 -35
  178. package/Rendering/Misc/TextureLODsDownloader.d.ts +110 -106
  179. package/Rendering/OpenGL/BufferObject.d.ts +3 -2
  180. package/Rendering/OpenGL/RenderWindow.d.ts +456 -405
  181. package/Rendering/OpenGL/Texture.d.ts +66 -14
  182. package/Rendering/SceneGraph/RenderPass.d.ts +88 -83
  183. package/Rendering/SceneGraph/ViewNode.d.ts +150 -146
  184. package/Rendering/SceneGraph/ViewNodeFactory.d.ts +17 -12
  185. package/Rendering/WebXR/RenderWindowHelper/Constants.d.ts +5 -5
  186. package/Rendering/WebXR/RenderWindowHelper.d.ts +54 -49
  187. package/Widgets/Core/AbstractWidget.d.ts +30 -24
  188. package/Widgets/Core/AbstractWidgetFactory.d.ts +53 -33
  189. package/Widgets/Core/WidgetManager/Constants.d.ts +4 -4
  190. package/Widgets/Core/WidgetManager.d.ts +21 -15
  191. package/Widgets/Core/WidgetState.d.ts +11 -7
  192. package/Widgets/Manipulators/AbstractManipulator.d.ts +224 -217
  193. package/Widgets/Manipulators/LineManipulator.d.ts +33 -21
  194. package/Widgets/Manipulators/PickerManipulator.d.ts +22 -18
  195. package/Widgets/Manipulators/PlaneManipulator.d.ts +33 -22
  196. package/Widgets/Manipulators/TrackballManipulator.d.ts +40 -26
  197. package/Widgets/Representations/WidgetRepresentation.d.ts +62 -51
  198. package/Widgets/Widgets3D/ImplicitPlaneWidget.js +23 -5
  199. package/Widgets/Widgets3D/InteractiveOrientationWidget.d.ts +25 -10
  200. package/Widgets/Widgets3D/ResliceCursorWidget/Constants.d.ts +26 -7
  201. package/Widgets/Widgets3D/ResliceCursorWidget/behavior.d.ts +13 -12
  202. package/Widgets/Widgets3D/ResliceCursorWidget.d.ts +26 -15
  203. package/Widgets/Widgets3D/SeedWidget.d.ts +2 -2
  204. package/Widgets/Widgets3D/SphereWidget.d.ts +5 -3
  205. package/interfaces.d.ts +243 -243
  206. package/package.json +3 -3
@@ -4,1241 +4,1351 @@ import vtkRenderer from './Renderer';
4
4
  import { Axis, Device, Input } from './RenderWindowInteractor/Constants';
5
5
 
6
6
  declare enum handledEvents {
7
- 'StartAnimation',
8
- 'Animation',
9
- 'EndAnimation',
10
- 'MouseEnter',
11
- 'MouseLeave',
12
- 'StartMouseMove',
13
- 'MouseMove',
14
- 'EndMouseMove',
15
- 'LeftButtonPress',
16
- 'LeftButtonRelease',
17
- 'MiddleButtonPress',
18
- 'MiddleButtonRelease',
19
- 'RightButtonPress',
20
- 'RightButtonRelease',
21
- 'KeyPress',
22
- 'KeyDown',
23
- 'KeyUp',
24
- 'StartMouseWheel',
25
- 'MouseWheel',
26
- 'EndMouseWheel',
27
- 'StartPinch',
28
- 'Pinch',
29
- 'EndPinch',
30
- 'StartPan',
31
- 'Pan',
32
- 'EndPan',
33
- 'StartRotate',
34
- 'Rotate',
35
- 'EndRotate',
36
- 'Button3D',
37
- 'Move3D',
38
- 'StartPointerLock',
39
- 'EndPointerLock',
40
- 'StartInteraction',
41
- 'Interaction',
42
- 'EndInteraction',
43
- 'AnimationFrameRateUpdate',
7
+ 'StartAnimation',
8
+ 'Animation',
9
+ 'EndAnimation',
10
+ 'MouseEnter',
11
+ 'MouseLeave',
12
+ 'StartMouseMove',
13
+ 'MouseMove',
14
+ 'EndMouseMove',
15
+ 'LeftButtonPress',
16
+ 'LeftButtonRelease',
17
+ 'MiddleButtonPress',
18
+ 'MiddleButtonRelease',
19
+ 'RightButtonPress',
20
+ 'RightButtonRelease',
21
+ 'KeyPress',
22
+ 'KeyDown',
23
+ 'KeyUp',
24
+ 'StartMouseWheel',
25
+ 'MouseWheel',
26
+ 'EndMouseWheel',
27
+ 'StartPinch',
28
+ 'Pinch',
29
+ 'EndPinch',
30
+ 'StartPan',
31
+ 'Pan',
32
+ 'EndPan',
33
+ 'StartRotate',
34
+ 'Rotate',
35
+ 'EndRotate',
36
+ 'Button3D',
37
+ 'Move3D',
38
+ 'StartPointerLock',
39
+ 'EndPointerLock',
40
+ 'StartInteraction',
41
+ 'Interaction',
42
+ 'EndInteraction',
43
+ 'AnimationFrameRateUpdate',
44
44
  }
45
45
 
46
46
  /**
47
47
  *
48
48
  */
49
49
  export interface IRenderWindowInteractorInitialValues {
50
- initialized?: boolean;
51
- enabled?: boolean;
52
- enableRender?: boolean;
53
- lightFollowCamera?: boolean;
54
- desiredUpdateRate?: number;
55
- stillUpdateRate?: number;
56
- recognizeGestures?: boolean;
57
- currentGesture?: string;
58
- lastFrameTime?: number;
59
- wheelTimeoutID?: number;
60
- moveTimeoutID?: number;
61
- preventDefaultOnPointerDown?: boolean;
62
- preventDefaultOnPointerUp?: boolean;
63
- mouseScrollDebounceByPass?: boolean;
50
+ initialized?: boolean;
51
+ enabled?: boolean;
52
+ enableRender?: boolean;
53
+ lightFollowCamera?: boolean;
54
+ desiredUpdateRate?: number;
55
+ stillUpdateRate?: number;
56
+ recognizeGestures?: boolean;
57
+ currentGesture?: string;
58
+ lastFrameTime?: number;
59
+ wheelTimeoutID?: number;
60
+ moveTimeoutID?: number;
61
+ preventDefaultOnPointerDown?: boolean;
62
+ preventDefaultOnPointerUp?: boolean;
63
+ mouseScrollDebounceByPass?: boolean;
64
64
  }
65
65
 
66
66
  interface IPosition {
67
- type: string;
67
+ type: string;
68
68
  }
69
69
 
70
- export type InteractorEventCallback = (e: IRenderWindowInteractorEvent) => void
70
+ export type InteractorEventCallback = (e: IRenderWindowInteractorEvent) => void;
71
71
 
72
- export type InteractorEventType = "StartInteractionEvent" | "InteractionEvent" | "EndInteractionEvent"
72
+ export type InteractorEventType =
73
+ | 'StartInteractionEvent'
74
+ | 'InteractionEvent'
75
+ | 'EndInteractionEvent';
73
76
 
74
77
  export interface IRenderWindowInteractorEvent {
75
- altKey: boolean;
76
- controlKey: boolean;
77
- firstRenderer: vtkRenderer;
78
- pokedRenderer: vtkRenderer;
79
- position: { x: number; y: number; z: number };
80
- shiftKey: boolean;
81
- type: InteractorEventType;
78
+ altKey: boolean;
79
+ controlKey: boolean;
80
+ firstRenderer: vtkRenderer;
81
+ pokedRenderer: vtkRenderer;
82
+ position: { x: number; y: number; z: number };
83
+ shiftKey: boolean;
84
+ type: InteractorEventType;
82
85
  }
83
86
 
84
87
  export interface I3DEvent {
85
- gamepad: Gamepad;
86
- position: DOMPointReadOnly;
87
- orientation: DOMPointReadOnly;
88
- targetPosition: DOMPointReadOnly;
89
- targetOrientation: DOMPointReadOnly;
90
- device: Device;
88
+ gamepad: Gamepad;
89
+ position: DOMPointReadOnly;
90
+ orientation: DOMPointReadOnly;
91
+ targetPosition: DOMPointReadOnly;
92
+ targetOrientation: DOMPointReadOnly;
93
+ device: Device;
91
94
  }
92
95
 
93
96
  export interface IButton3DEvent extends I3DEvent {
94
- pressed: boolean;
95
- input: Input;
97
+ pressed: boolean;
98
+ input: Input;
96
99
  }
97
100
 
98
101
  export interface vtkRenderWindowInteractor extends vtkObject {
99
-
100
- /**
101
- *
102
- * @default false
103
- */
104
- getInitialized(): boolean;
105
-
106
- /**
107
- *
108
- * @default null
109
- */
110
- getContainer(): Nullable<HTMLElement>;
111
-
112
- /**
113
- *
114
- * @default false
115
- */
116
-
117
- getEnabled(): boolean;
118
-
119
- /**
120
- *
121
- * @default true
122
- */
123
- getEnableRender(): boolean;
124
-
125
- /**
126
- *
127
- * @default null
128
- */
129
- getInteractorStyle(): any;
130
-
131
- /**
132
- *
133
- * @default 0.1
134
- */
135
- getLastFrameTime(): number;
136
-
137
- /**
138
- *
139
- * @default null
140
- */
141
- getView(): any;
142
-
143
- /**
144
- *
145
- * @default true
146
- */
147
- getLightFollowCamera(): boolean;
148
-
149
- /**
150
- *
151
- */
152
- getPicker(): any;
153
-
154
- /**
155
- *
156
- * @default true
157
- */
158
- getRecognizeGestures(): boolean;
159
-
160
- /**
161
- *
162
- * @default 30.0
163
- */
164
- getDesiredUpdateRate(): number;
165
-
166
- /**
167
- *
168
- * @default 2.0
169
- */
170
- getStillUpdateRate(): number;
171
-
172
- /**
173
- * @default false
174
- */
175
- getPreventDefaultOnPointerDown(): boolean;
176
-
177
- /**
178
- * @default false
179
- */
180
- getPreventDefaultOnPointerUp(): boolean;
181
-
182
- /**
183
- * @default false
184
- */
185
- getMouseScrollDebounceByPass(): boolean;
186
-
187
- /**
188
- *
189
- * @param {IRenderWindowInteractorEvent} callData
190
- */
191
- invokeStartAnimation(callData: IRenderWindowInteractorEvent): void;
192
-
193
- /**
194
- *
195
- * @param {IRenderWindowInteractorEvent} callData
196
- */
197
- invokeAnimation(callData: IRenderWindowInteractorEvent): void;
198
-
199
- /**
200
- *
201
- * @param {IRenderWindowInteractorEvent} callData
202
- */
203
- invokeEndAnimation(callData: IRenderWindowInteractorEvent): void;
204
-
205
- /**
206
- *
207
- * @param {IRenderWindowInteractorEvent} callData
208
- */
209
- invokePointerEnter(callData: IRenderWindowInteractorEvent): void;
210
-
211
- /**
212
- *
213
- */
214
- invokePointerLeave(callData: IRenderWindowInteractorEvent): void;
215
-
216
- /**
217
- *
218
- */
219
- invokeMouseEnter(callData: IRenderWindowInteractorEvent): void;
220
-
221
- /**
222
- *
223
- * @param {IRenderWindowInteractorEvent} callData
224
- */
225
- invokeMouseLeave(callData: IRenderWindowInteractorEvent): void;
226
-
227
- /**
228
- *
229
- * @param {IRenderWindowInteractorEvent} callData
230
- */
231
- invokeStartMouseMove(callData: IRenderWindowInteractorEvent): void;
232
-
233
- /**
234
- *
235
- * @param {IRenderWindowInteractorEvent} callData
236
- */
237
- invokeMouseMove(callData: IRenderWindowInteractorEvent): void;
238
-
239
- /**
240
- *
241
- * @param {IRenderWindowInteractorEvent} callData
242
- */
243
- invokeEndMouseMove(callData: IRenderWindowInteractorEvent): void;
244
-
245
- /**
246
- *
247
- * @param {IRenderWindowInteractorEvent} callData
248
- */
249
- invokeLeftButtonPress(callData: IRenderWindowInteractorEvent): void;
250
-
251
- /**
252
- *
253
- * @param {IRenderWindowInteractorEvent} callData
254
- */
255
- invokeLeftButtonRelease(callData: IRenderWindowInteractorEvent): void;
256
-
257
- /**
258
- *
259
- * @param {IRenderWindowInteractorEvent} callData
260
- */
261
- invokeMiddleButtonPress(callData: IRenderWindowInteractorEvent): void;
262
-
263
- /**
264
- *
265
- * @param {IRenderWindowInteractorEvent} callData
266
- */
267
- invokeMiddleButtonRelease(callData: IRenderWindowInteractorEvent): void;
268
-
269
- /**
270
- *
271
- * @param {IRenderWindowInteractorEvent} callData
272
- */
273
- invokeRightButtonPress(callData: IRenderWindowInteractorEvent): void;
274
-
275
- /**
276
- *
277
- * @param {IRenderWindowInteractorEvent} callData
278
- */
279
- invokeRightButtonRelease(callData: IRenderWindowInteractorEvent): void;
280
-
281
- /**
282
- *
283
- * @param {IRenderWindowInteractorEvent} callData
284
- */
285
- invokeKeyPress(callData: IRenderWindowInteractorEvent): void;
286
-
287
- /**
288
- *
289
- * @param {IRenderWindowInteractorEvent} callData
290
- */
291
- invokeKeyDown(callData: IRenderWindowInteractorEvent): void;
292
-
293
- /**
294
- *
295
- * @param {IRenderWindowInteractorEvent} callData
296
- */
297
- invokeKeyUp(callData: IRenderWindowInteractorEvent): void;
298
-
299
- /**
300
- *
301
- * @param {IRenderWindowInteractorEvent} callData
302
- */
303
- invokeStartMouseWheel(callData: IRenderWindowInteractorEvent): void;
304
-
305
- /**
306
- *
307
- * @param {IRenderWindowInteractorEvent} callData
308
- */
309
- invokeMouseWheel(callData: IRenderWindowInteractorEvent): void;
310
-
311
- /**
312
- *
313
- * @param {IRenderWindowInteractorEvent} callData
314
- */
315
- invokeEndMouseWheel(callData: IRenderWindowInteractorEvent): void;
316
-
317
- /**
318
- *
319
- * @param {IRenderWindowInteractorEvent} callData
320
- */
321
- invokeStartPinch(callData: IRenderWindowInteractorEvent): void;
322
-
323
- /**
324
- *
325
- * @param {IRenderWindowInteractorEvent} callData
326
- */
327
- invokePinch(callData: IRenderWindowInteractorEvent): void;
328
-
329
- /**
330
- *
331
- * @param {IRenderWindowInteractorEvent} callData
332
- */
333
- invokeEndPinch(callData: IRenderWindowInteractorEvent): void;
334
-
335
- /**
336
- *
337
- * @param {IRenderWindowInteractorEvent} callData
338
- */
339
- invokeStartPan(callData: IRenderWindowInteractorEvent): void;
340
-
341
- /**
342
- *
343
- * @param {IRenderWindowInteractorEvent} callData
344
- */
345
- invokePan(callData: IRenderWindowInteractorEvent): void;
346
-
347
- /**
348
- *
349
- * @param {IRenderWindowInteractorEvent} callData
350
- */
351
- invokeEndPan(callData: IRenderWindowInteractorEvent): void;
352
-
353
- /**
354
- *
355
- * @param {IRenderWindowInteractorEvent} callData
356
- */
357
- invokeStartRotate(callData: IRenderWindowInteractorEvent): void;
358
-
359
- /**
360
- *
361
- * @param {IRenderWindowInteractorEvent} callData
362
- */
363
- invokeRotate(callData: IRenderWindowInteractorEvent): void;
364
-
365
- /**
366
- *
367
- * @param {IRenderWindowInteractorEvent} callData
368
- */
369
- invokeEndRotate(callData: IRenderWindowInteractorEvent): void;
370
-
371
- /**
372
- *
373
- * @param {IRenderWindowInteractorEvent} callData
374
- */
375
- invokeButton3D(callData: IRenderWindowInteractorEvent): void;
376
-
377
- /**
378
- *
379
- * @param {IRenderWindowInteractorEvent} callData
380
- */
381
- invokeMove3D(callData: IRenderWindowInteractorEvent): void;
382
-
383
- /**
384
- *
385
- * @param {IRenderWindowInteractorEvent} callData
386
- */
387
- invokeStartPointerLock(callData: IRenderWindowInteractorEvent): void;
388
-
389
- /**
390
- *
391
- * @param {IRenderWindowInteractorEvent} callData
392
- */
393
- invokeEndPointerLock(callData: IRenderWindowInteractorEvent): void;
394
-
395
- /**
396
- *
397
- * @param {IRenderWindowInteractorEvent} callData
398
- */
399
- invokeStartInteractionEvent(callData: IRenderWindowInteractorEvent): void;
400
-
401
- /**
402
- *
403
- * @param {IRenderWindowInteractorEvent} callData
404
- */
405
- invokeInteractionEvent(callData: IRenderWindowInteractorEvent): void;
406
-
407
- /**
408
- *
409
- * @param {IRenderWindowInteractorEvent} callData
410
- */
411
- invokeEndInteractionEvent(callData: IRenderWindowInteractorEvent): void;
412
-
413
- /**
414
- *
415
- */
416
- invokeRenderEvent(): void;
417
-
418
- /**
419
- *
420
- * @param cb The callback to be called
421
- */
422
- onStartAnimation(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
423
-
424
- /**
425
- *
426
- * @param {InteractorEventCallback} cb The callback to be called.
427
- * @param {Number} [priority] The priority of the event.
428
- */
429
- onAnimation(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
430
-
431
- /**
432
- *
433
- * @param {InteractorEventCallback} cb The callback to be called.
434
- * @param {Number} [priority] The priority of the event.
435
- */
436
- onEndAnimation(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
437
-
438
- /**
439
- *
440
- * @param {InteractorEventCallback} cb The callback to be called.
441
- * @param {Number} [priority] The priority of the event.
442
- */
443
- onPointerEnter(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
444
-
445
- /**
446
- *
447
- * @param cb The callback to be called
448
- */
449
- onPointerLeave(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
450
-
451
- /**
452
- *
453
- * @param cb The callback to be called
454
- */
455
- onMouseEnter(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
456
-
457
- /**
458
- *
459
- * @param {InteractorEventCallback} cb The callback to be called.
460
- * @param {Number} [priority] The priority of the event.
461
- */
462
- onMouseLeave(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
463
-
464
- /**
465
- *
466
- * @param {InteractorEventCallback} cb The callback to be called.
467
- * @param {Number} [priority] The priority of the event.
468
- */
469
- onStartMouseMove(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
470
-
471
- /**
472
- *
473
- * @param {InteractorEventCallback} cb The callback to be called.
474
- * @param {Number} [priority] The priority of the event.
475
- */
476
- onMouseMove(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
477
-
478
- /**
479
- *
480
- * @param {InteractorEventCallback} cb The callback to be called.
481
- * @param {Number} [priority] The priority of the event.
482
- */
483
- onEndMouseMove(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
484
-
485
- /**
486
- *
487
- * @param {InteractorEventCallback} cb The callback to be called.
488
- * @param {Number} [priority] The priority of the event.
489
- */
490
- onLeftButtonPress(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
491
-
492
- /**
493
- *
494
- * @param {InteractorEventCallback} cb The callback to be called.
495
- * @param {Number} [priority] The priority of the event.
496
- */
497
- onLeftButtonRelease(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
498
-
499
- /**
500
- *
501
- * @param {InteractorEventCallback} cb The callback to be called.
502
- * @param {Number} [priority] The priority of the event.
503
- */
504
- onMiddleButtonPress(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
505
-
506
- /**
507
- *
508
- * @param {InteractorEventCallback} cb The callback to be called.
509
- * @param {Number} [priority] The priority of the event.
510
- */
511
- onMiddleButtonRelease(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
512
-
513
- /**
514
- *
515
- * @param {InteractorEventCallback} cb The callback to be called.
516
- * @param {Number} [priority] The priority of the event.
517
- */
518
- onRightButtonPress(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
519
-
520
- /**
521
- *
522
- * @param {InteractorEventCallback} cb The callback to be called.
523
- * @param {Number} [priority] The priority of the event.
524
- */
525
- onRightButtonRelease(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
526
-
527
- /**
528
- *
529
- * @param {InteractorEventCallback} cb The callback to be called.
530
- * @param {Number} [priority] The priority of the event.
531
- */
532
- onKeyPress(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
533
-
534
- /**
535
- *
536
- * @param {InteractorEventCallback} cb The callback to be called.
537
- * @param {Number} [priority] The priority of the event.
538
- */
539
- onKeyDown(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
540
-
541
- /**
542
- *
543
- * @param {InteractorEventCallback} cb The callback to be called.
544
- * @param {Number} [priority] The priority of the event.
545
- */
546
- onKeyUp(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
547
-
548
- /**
549
- *
550
- * @param {InteractorEventCallback} cb The callback to be called.
551
- * @param {Number} [priority] The priority of the event.
552
- */
553
- onStartMouseWheel(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
554
-
555
- /**
556
- *
557
- * @param {InteractorEventCallback} cb The callback to be called.
558
- * @param {Number} [priority] The priority of the event.
559
- */
560
- onMouseWheel(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
561
-
562
- /**
563
- *
564
- * @param {InteractorEventCallback} cb The callback to be called.
565
- * @param {Number} [priority] The priority of the event.
566
- */
567
- onEndMouseWheel(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
568
-
569
- /**
570
- *
571
- * @param {InteractorEventCallback} cb The callback to be called.
572
- * @param {Number} [priority] The priority of the event.
573
- */
574
- onStartPinch(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
575
-
576
- /**
577
- *
578
- * @param {InteractorEventCallback} cb The callback to be called.
579
- * @param {Number} [priority] The priority of the event.
580
- */
581
- onPinch(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
582
-
583
- /**
584
- *
585
- * @param {InteractorEventCallback} cb The callback to be called.
586
- * @param {Number} [priority] The priority of the event.
587
- */
588
- onEndPinch(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
589
-
590
- /**
591
- *
592
- * @param {InteractorEventCallback} cb The callback to be called.
593
- * @param {Number} [priority] The priority of the event.
594
- */
595
- onStartPan(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
596
-
597
- /**
598
- *
599
- * @param {InteractorEventCallback} cb The callback to be called.
600
- * @param {Number} [priority] The priority of the event.
601
- */
602
- onPan(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
603
-
604
- /**
605
- *
606
- * @param {InteractorEventCallback} cb The callback to be called.
607
- * @param {Number} [priority] The priority of the event.
608
- */
609
- onEndPan(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
610
-
611
- /**
612
- *
613
- * @param {InteractorEventCallback} cb The callback to be called.
614
- * @param {Number} [priority] The priority of the event.
615
- */
616
- onStartRotate(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
617
-
618
- /**
619
- *
620
- * @param {InteractorEventCallback} cb The callback to be called.
621
- * @param {Number} [priority] The priority of the event.
622
- */
623
- onRotate(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
624
-
625
- /**
626
- *
627
- * @param {InteractorEventCallback} cb The callback to be called.
628
- * @param {Number} [priority] The priority of the event.
629
- */
630
- onEndRotate(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
631
-
632
- /**
633
- *
634
- * @param {InteractorEventCallback} cb The callback to be called.
635
- * @param {Number} [priority] The priority of the event.
636
- */
637
- onButton3D(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
638
-
639
- /**
640
- *
641
- * @param {InteractorEventCallback} cb The callback to be called.
642
- * @param {Number} [priority] The priority of the event.
643
- */
644
- onMove3D(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
645
-
646
- /**
647
- *
648
- * @param {InteractorEventCallback} cb The callback to be called.
649
- * @param {Number} [priority] The priority of the event.
650
- */
651
- onStartPointerLock(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
652
-
653
- /**
654
- *
655
- * @param {InteractorEventCallback} cb The callback to be called.
656
- * @param {Number} [priority] The priority of the event.
657
- */
658
- onEndPointerLock(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
659
-
660
- /**
661
- *
662
- * @param {InteractorEventCallback} cb The callback to be called.
663
- * @param {Number} [priority] The priority of the event.
664
- */
665
- onStartInteractionEvent(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
666
-
667
- /**
668
- *
669
- * @param {InteractorEventCallback} cb The callback to be called.
670
- * @param {Number} [priority] The priority of the event.
671
- */
672
- onInteractionEvent(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
673
-
674
- /**
675
- *
676
- * @param {InteractorEventCallback} cb The callback to be called.
677
- * @param {Number} [priority] The priority of the event.
678
- */
679
- onEndInteractionEvent(cb: InteractorEventCallback, priority?: number): Readonly<vtkSubscription>;
680
-
681
- /**
682
- *
683
- * @param {Function} cb The callback to be called.
684
- * @param {Number} [priority] The priority of the event.
685
- */
686
- onRenderEvent(cb: () => void, priority?: number): Readonly<vtkSubscription>;
687
-
688
- /**
689
- *
690
- * @param args
691
- */
692
- animationEvent(args: any): any;
693
-
694
- /**
695
- * Triggers the 'Button3D' event.
696
- *
697
- * @param args
698
- */
699
- button3DEvent(eventPayload: IButton3DEvent): void;
700
-
701
- /**
702
- *
703
- * @param args
704
- */
705
- endAnimationEvent(args: any): any;
706
-
707
- /**
708
- *
709
- * @param args
710
- */
711
- endInteractionEvent(args: any): any;
712
-
713
- /**
714
- *
715
- * @param args
716
- */
717
- endMouseMoveEvent(args: any): any;
718
-
719
- /**
720
- *
721
- * @param args
722
- */
723
- endMouseWheelEvent(args: any): any;
724
-
725
- /**
726
- *
727
- * @param args
728
- */
729
- endPanEvent(args: any): any;
730
-
731
- /**
732
- *
733
- * @param args
734
- */
735
- endPinchEvent(args: any): any;
736
-
737
- /**
738
- *
739
- * @param args
740
- */
741
- endPointerLockEvent(args: any): any;
742
-
743
- /**
744
- *
745
- * @param args
746
- */
747
- endRotateEvent(args: any): any;
748
-
749
- /**
750
- *
751
- * @param args
752
- */
753
- interactionEvent(args: any): any;
754
-
755
- /**
756
- *
757
- * @param args
758
- */
759
- keyDownEvent(args: any): any;
760
-
761
- /**
762
- *
763
- * @param args
764
- */
765
- keyPressEvent(args: any): any;
766
-
767
- /**
768
- *
769
- * @param args
770
- */
771
- keyUpEvent(args: any): any;
772
-
773
- /**
774
- *
775
- * @param args
776
- */
777
- leftButtonPressEvent(args: any): any;
778
-
779
- /**
780
- *
781
- * @param args
782
- */
783
- leftButtonReleaseEvent(args: any): any;
784
-
785
- /**
786
- *
787
- * @param args
788
- */
789
- middleButtonPressEvent(args: any): any;
790
-
791
- /**
792
- *
793
- * @param args
794
- */
795
- middleButtonReleaseEvent(args: any): any;
796
-
797
- /**
798
- *
799
- * @param args
800
- */
801
- mouseEnterEvent(args: any): any;
802
-
803
- /**
804
- *
805
- * @param args
806
- */
807
- mouseLeaveEvent(args: any): any;
808
-
809
- /**
810
- *
811
- * @param args
812
- */
813
- mouseMoveEvent(args: any): any;
814
-
815
- /**
816
- *
817
- * @param args
818
- */
819
- mouseWheelEvent(args: any): any;
820
-
821
- /**
822
- * Triggers the 'Move3D' event.
823
- *
824
- * @param eventPayload
825
- */
826
- move3DEvent(eventPayload: I3DEvent): void;
827
-
828
- /**
829
- *
830
- * @param args
831
- */
832
- panEvent(args: any): any;
833
-
834
- /**
835
- *
836
- * @param args
837
- */
838
- pinchEvent(args: any): any;
839
-
840
- /**
841
- *
842
- * @param args
843
- */
844
- rightButtonPressEvent(args: any): any;
845
-
846
- /**
847
- *
848
- * @param args
849
- */
850
- rightButtonReleaseEvent(args: any): any;
851
-
852
- /**
853
- *
854
- * @param args
855
- */
856
- rotateEvent(args: any): any;
857
-
858
- /**
859
- * Add an HTMLElement as the new container for the interactor.
860
- * All events will be bound to this new container.
861
- * Any old container will be removed along with its listeners.
862
- */
863
- setContainer(container: Nullable<HTMLElement>): boolean;
864
-
865
- /**
866
- * Turn on/off the automatic repositioning of lights as the camera moves.
867
- * @param lightFollowCamera
868
- */
869
- setLightFollowCamera(lightFollowCamera: boolean): boolean;
870
-
871
- /**
872
- * Set the object used to perform pick operations.
873
- * @param picker
874
- */
875
- setPicker(picker: any): boolean;
876
-
877
- /**
878
- * Set whether preventDefault is called on pointer down.
879
- * @param {Boolean} preventDefault
880
- */
881
- setPreventDefaultOnPointerDown(preventDefault: boolean): boolean;
882
-
883
- /**
884
- * Set whether preventDefault is called on pointer up.
885
- *
886
- * If pointerup occurs without a preceeding pointerdown, then
887
- * this does nothing.
888
- *
889
- * @param {Boolean} preventDefault
890
- */
891
- setPreventDefaultOnPointerUp(preventDefault: boolean): boolean;
892
-
893
- /**
894
- * Allow system to bypass scrolling debounce. This function must be called to allow the debounce to be bypassed
895
- * @param mouseScrollDebounceByPass
896
- */
897
-
898
- setMouseScrollDebounceByPass(mouseScrollDebounceByPass:boolean): boolean;
899
-
900
- /**
901
- *
902
- * @param recognizeGestures
903
- */
904
- setRecognizeGestures(recognizeGestures: boolean): boolean;
905
-
906
- /**
907
- * Set the desired update rate.
908
- * @param desiredUpdateRate
909
- */
910
- setDesiredUpdateRate(desiredUpdateRate: number): boolean;
911
-
912
- /**
913
- * Set the desired update rate when movement has stopped.
914
- * @param stillUpdateRate
915
- */
916
- setStillUpdateRate(stillUpdateRate: number): boolean;
917
-
918
- /**
919
- * Start the event loop.
920
- * This is provided so that you do not have to implement your own event loop.
921
- * You still can use your own event loop if you want.
922
- */
923
- start(): void;
924
-
925
- /**
926
- *
927
- * @param args
928
- */
929
- startAnimationEvent(args: any): any;
930
-
931
-
932
- /**
933
- *
934
- * @param args
935
- */
936
- startInteractionEvent(args: any): any;
937
-
938
-
939
- /**
940
- *
941
- * @param args
942
- */
943
- startMouseMoveEvent(args: any): any;
944
-
945
-
946
- /**
947
- *
948
- * @param args
949
- */
950
- startMouseWheelEvent(args: any): any;
951
-
952
-
953
- /**
954
- *
955
- * @param args
956
- */
957
- startPanEvent(args: any): any;
958
-
959
-
960
- /**
961
- *
962
- * @param args
963
- */
964
- startPinchEvent(args: any): any;
965
-
966
-
967
- /**
968
- *
969
- * @param args
970
- */
971
- startPointerLockEvent(args: any): any;
972
-
973
-
974
- /**
975
- *
976
- * @param args
977
- */
978
- startRotateEvent(args: any): any;
979
-
980
-
981
- /**
982
- * Set/Get the rendering window being controlled by this object.
983
- * @param aren
984
- */
985
- setRenderWindow(aren: any): void;
986
-
987
- /**
988
- * External switching between joystick/trackball/new? modes.
989
- * @param style
990
- */
991
- setInteractorStyle(style: any): void;
992
-
993
- /**
994
- * ---------------------------------------------------------------------
995
- */
996
- initialize(): void;
997
-
998
- /**
999
- * Enable/Disable interactions.
1000
- * By default interactors are enabled when initialized.
1001
- * Initialize() must be called prior to enabling/disabling interaction.
1002
- * These methods are used when a window/widget is being shared by multiple renderers and interactors.
1003
- * This allows a "modal" display where one interactor is active when its data is to be displayed and all other interactors associated with the widget are disabled when their data is not displayed.
1004
- */
1005
- enable(): void;
1006
-
1007
- /**
1008
- *
1009
- */
1010
- disable(): void;
1011
-
1012
- /**
1013
- *
1014
- */
1015
- startEventLoop(): void;
1016
-
1017
- /**
1018
- *
1019
- */
1020
- getCurrentRenderer(): void;
1021
-
1022
- /**
1023
- * Manually sets the current renderer.
1024
- * @param {vtkRenderer} ren
1025
- */
1026
- setCurrentRenderer(ren: vtkRenderer): void;
1027
-
1028
- /**
1029
- *
1030
- * @param container kept for backward compatibility.
1031
- * @deprecated please use vtkRenderWindowInteractor.setContainer(container: HTMLElement)
1032
- * which will also bind events.
1033
- */
1034
- bindEvents(container: any): void;
1035
-
1036
- /**
1037
- *
1038
- * @deprecated please use vtkRenderWindowInteractor.setContainer(null) instead.
1039
- */
1040
- unbindEvents(): void;
1041
-
1042
- /**
1043
- *
1044
- * @param {KeyboardEvent} event
1045
- */
1046
- handleKeyPress(event: KeyboardEvent): void;
1047
-
1048
- /**
1049
- *
1050
- * @param {KeyboardEvent} event
1051
- */
1052
- handleKeyDown(event: KeyboardEvent): void;
1053
-
1054
- /**
1055
- *
1056
- * @param {KeyboardEvent} event
1057
- */
1058
- handleKeyUp(event: KeyboardEvent): void;
1059
-
1060
- /**
1061
- *
1062
- * @param {PointerEvent} event
1063
- */
1064
- handlePointerDown(event: PointerEvent): void;
1065
-
1066
- /**
1067
- *
1068
- * @param {PointerEvent} event
1069
- */
1070
- handlePointerUp(event: PointerEvent): void;
1071
-
1072
- /**
1073
- *
1074
- * @param {PointerEvent} event
1075
- */
1076
- handlePointerCancel(event: PointerEvent): void;
1077
-
1078
- /**
1079
- *
1080
- * @param {PointerEvent} event
1081
- */
1082
- handlePointerMove(event: PointerEvent): void;
1083
-
1084
- /**
1085
- *
1086
- * @param {PointerEvent} event
1087
- */
1088
- handleMouseDown(event: PointerEvent): void;
1089
-
1090
- /**
1091
- *
1092
- */
1093
- requestPointerLock(): void;
1094
-
1095
- /**
1096
- *
1097
- */
1098
- exitPointerLock(): void;
1099
-
1100
- /**
1101
- *
1102
- */
1103
- isPointerLocked(): boolean;
1104
-
1105
- /**
1106
- *
1107
- */
1108
- handlePointerLockChange(): void;
1109
-
1110
- /**
1111
- *
1112
- * @param requestor
1113
- */
1114
- requestAnimation(requestor: any): void;
1115
-
1116
- /**
1117
- *
1118
- */
1119
- isAnimating(): boolean;
1120
-
1121
- /**
1122
- *
1123
- * @param requestor
1124
- * @param {Boolean} [skipWarning]
1125
- */
1126
- cancelAnimation(requestor: any, skipWarning?: boolean): void;
1127
-
1128
- /**
1129
- *
1130
- */
1131
- switchToVRAnimation(): void;
1132
-
1133
- /**
1134
- *
1135
- */
1136
- returnFromVRAnimation(): void;
1137
-
1138
- /**
1139
- *
1140
- * @param {Number} displayId The ID of the display.
1141
- */
1142
- updateGamepads(displayId: number): void;
1143
-
1144
- /**
1145
- *
1146
- * @param {PointerEvent} event
1147
- */
1148
- handleMouseMove(event: PointerEvent): void;
1149
-
1150
- /**
1151
- *
1152
- */
1153
- handleAnimation(): void;
1154
-
1155
- /**
1156
- *
1157
- * @param {MouseEvent} event
1158
- */
1159
- handleWheel(event: MouseEvent): void;
1160
-
1161
- /**
1162
- *
1163
- * @param {PointerEvent} event
1164
- */
1165
- handlePointerEnter(event: PointerEvent): void;
1166
-
1167
- /**
1168
- *
1169
- * @param {PointerEvent} event
1170
- */
1171
- handlePointerLeave(event: PointerEvent): void;
1172
-
1173
- /**
1174
- *
1175
- * @param {PointerEvent} event
1176
- */
1177
- handleMouseUp(event: PointerEvent): void;
1178
-
1179
- /**
1180
- *
1181
- * @param {PointerEvent} event
1182
- */
1183
- handleTouchStart(event: PointerEvent): void;
1184
-
1185
- /**
1186
- *
1187
- * @param {PointerEvent} event
1188
- */
1189
- handleTouchMove(event: PointerEvent): void;
1190
-
1191
- /**
1192
- *
1193
- * @param {PointerEvent} event
1194
- */
1195
- handleTouchEnd(event: PointerEvent): void;
1196
-
1197
- /**
1198
- *
1199
- * @param val
1200
- */
1201
- setView(val: any): void;
1202
-
1203
- /**
1204
- * @return first renderer to be used for camera manipulation
1205
- */
1206
- getFirstRenderer(): vtkRenderer;
1207
-
1208
- /**
1209
- *
1210
- * @param {Number} x
1211
- * @param {Number} y
1212
- */
1213
- findPokedRenderer(x: number, y: number): Nullable<vtkRenderer>;
1214
-
1215
- /**
1216
- * only render if we are not animating. If we are animating
1217
- * then renders will happen naturally anyhow and we definitely
1218
- * do not want extra renders as the make the apparent interaction
1219
- * rate slower.
1220
- */
1221
- render(): void;
1222
-
1223
- /**
1224
- * we know we are in multitouch now, so start recognizing
1225
- * @param event
1226
- * @param positions
1227
- */
1228
- recognizeGesture(event: 'TouchStart' | 'TouchMove' | 'TouchEnd', positions: IPosition): void;
1229
-
1230
- /**
1231
- *
1232
- */
1233
- handleVisibilityChange(): void;
1234
-
1235
- /**
1236
- * Stop animating if the renderWindowInteractor is deleted.
1237
- */
1238
- delete(): void;
102
+ /**
103
+ *
104
+ * @default false
105
+ */
106
+ getInitialized(): boolean;
107
+
108
+ /**
109
+ *
110
+ * @default null
111
+ */
112
+ getContainer(): Nullable<HTMLElement>;
113
+
114
+ /**
115
+ *
116
+ * @default false
117
+ */
118
+
119
+ getEnabled(): boolean;
120
+
121
+ /**
122
+ *
123
+ * @default true
124
+ */
125
+ getEnableRender(): boolean;
126
+
127
+ /**
128
+ *
129
+ * @default null
130
+ */
131
+ getInteractorStyle(): any;
132
+
133
+ /**
134
+ *
135
+ * @default 0.1
136
+ */
137
+ getLastFrameTime(): number;
138
+
139
+ /**
140
+ *
141
+ * @default null
142
+ */
143
+ getView(): any;
144
+
145
+ /**
146
+ *
147
+ * @default true
148
+ */
149
+ getLightFollowCamera(): boolean;
150
+
151
+ /**
152
+ *
153
+ */
154
+ getPicker(): any;
155
+
156
+ /**
157
+ *
158
+ * @default true
159
+ */
160
+ getRecognizeGestures(): boolean;
161
+
162
+ /**
163
+ *
164
+ * @default 30.0
165
+ */
166
+ getDesiredUpdateRate(): number;
167
+
168
+ /**
169
+ *
170
+ * @default 2.0
171
+ */
172
+ getStillUpdateRate(): number;
173
+
174
+ /**
175
+ * @default false
176
+ */
177
+ getPreventDefaultOnPointerDown(): boolean;
178
+
179
+ /**
180
+ * @default false
181
+ */
182
+ getPreventDefaultOnPointerUp(): boolean;
183
+
184
+ /**
185
+ * @default false
186
+ */
187
+ getMouseScrollDebounceByPass(): boolean;
188
+
189
+ /**
190
+ *
191
+ * @param {IRenderWindowInteractorEvent} callData
192
+ */
193
+ invokeStartAnimation(callData: IRenderWindowInteractorEvent): void;
194
+
195
+ /**
196
+ *
197
+ * @param {IRenderWindowInteractorEvent} callData
198
+ */
199
+ invokeAnimation(callData: IRenderWindowInteractorEvent): void;
200
+
201
+ /**
202
+ *
203
+ * @param {IRenderWindowInteractorEvent} callData
204
+ */
205
+ invokeEndAnimation(callData: IRenderWindowInteractorEvent): void;
206
+
207
+ /**
208
+ *
209
+ * @param {IRenderWindowInteractorEvent} callData
210
+ */
211
+ invokePointerEnter(callData: IRenderWindowInteractorEvent): void;
212
+
213
+ /**
214
+ *
215
+ */
216
+ invokePointerLeave(callData: IRenderWindowInteractorEvent): void;
217
+
218
+ /**
219
+ *
220
+ */
221
+ invokeMouseEnter(callData: IRenderWindowInteractorEvent): void;
222
+
223
+ /**
224
+ *
225
+ * @param {IRenderWindowInteractorEvent} callData
226
+ */
227
+ invokeMouseLeave(callData: IRenderWindowInteractorEvent): void;
228
+
229
+ /**
230
+ *
231
+ * @param {IRenderWindowInteractorEvent} callData
232
+ */
233
+ invokeStartMouseMove(callData: IRenderWindowInteractorEvent): void;
234
+
235
+ /**
236
+ *
237
+ * @param {IRenderWindowInteractorEvent} callData
238
+ */
239
+ invokeMouseMove(callData: IRenderWindowInteractorEvent): void;
240
+
241
+ /**
242
+ *
243
+ * @param {IRenderWindowInteractorEvent} callData
244
+ */
245
+ invokeEndMouseMove(callData: IRenderWindowInteractorEvent): void;
246
+
247
+ /**
248
+ *
249
+ * @param {IRenderWindowInteractorEvent} callData
250
+ */
251
+ invokeLeftButtonPress(callData: IRenderWindowInteractorEvent): void;
252
+
253
+ /**
254
+ *
255
+ * @param {IRenderWindowInteractorEvent} callData
256
+ */
257
+ invokeLeftButtonRelease(callData: IRenderWindowInteractorEvent): void;
258
+
259
+ /**
260
+ *
261
+ * @param {IRenderWindowInteractorEvent} callData
262
+ */
263
+ invokeMiddleButtonPress(callData: IRenderWindowInteractorEvent): void;
264
+
265
+ /**
266
+ *
267
+ * @param {IRenderWindowInteractorEvent} callData
268
+ */
269
+ invokeMiddleButtonRelease(callData: IRenderWindowInteractorEvent): void;
270
+
271
+ /**
272
+ *
273
+ * @param {IRenderWindowInteractorEvent} callData
274
+ */
275
+ invokeRightButtonPress(callData: IRenderWindowInteractorEvent): void;
276
+
277
+ /**
278
+ *
279
+ * @param {IRenderWindowInteractorEvent} callData
280
+ */
281
+ invokeRightButtonRelease(callData: IRenderWindowInteractorEvent): void;
282
+
283
+ /**
284
+ *
285
+ * @param {IRenderWindowInteractorEvent} callData
286
+ */
287
+ invokeKeyPress(callData: IRenderWindowInteractorEvent): void;
288
+
289
+ /**
290
+ *
291
+ * @param {IRenderWindowInteractorEvent} callData
292
+ */
293
+ invokeKeyDown(callData: IRenderWindowInteractorEvent): void;
294
+
295
+ /**
296
+ *
297
+ * @param {IRenderWindowInteractorEvent} callData
298
+ */
299
+ invokeKeyUp(callData: IRenderWindowInteractorEvent): void;
300
+
301
+ /**
302
+ *
303
+ * @param {IRenderWindowInteractorEvent} callData
304
+ */
305
+ invokeStartMouseWheel(callData: IRenderWindowInteractorEvent): void;
306
+
307
+ /**
308
+ *
309
+ * @param {IRenderWindowInteractorEvent} callData
310
+ */
311
+ invokeMouseWheel(callData: IRenderWindowInteractorEvent): void;
312
+
313
+ /**
314
+ *
315
+ * @param {IRenderWindowInteractorEvent} callData
316
+ */
317
+ invokeEndMouseWheel(callData: IRenderWindowInteractorEvent): void;
318
+
319
+ /**
320
+ *
321
+ * @param {IRenderWindowInteractorEvent} callData
322
+ */
323
+ invokeStartPinch(callData: IRenderWindowInteractorEvent): void;
324
+
325
+ /**
326
+ *
327
+ * @param {IRenderWindowInteractorEvent} callData
328
+ */
329
+ invokePinch(callData: IRenderWindowInteractorEvent): void;
330
+
331
+ /**
332
+ *
333
+ * @param {IRenderWindowInteractorEvent} callData
334
+ */
335
+ invokeEndPinch(callData: IRenderWindowInteractorEvent): void;
336
+
337
+ /**
338
+ *
339
+ * @param {IRenderWindowInteractorEvent} callData
340
+ */
341
+ invokeStartPan(callData: IRenderWindowInteractorEvent): void;
342
+
343
+ /**
344
+ *
345
+ * @param {IRenderWindowInteractorEvent} callData
346
+ */
347
+ invokePan(callData: IRenderWindowInteractorEvent): void;
348
+
349
+ /**
350
+ *
351
+ * @param {IRenderWindowInteractorEvent} callData
352
+ */
353
+ invokeEndPan(callData: IRenderWindowInteractorEvent): void;
354
+
355
+ /**
356
+ *
357
+ * @param {IRenderWindowInteractorEvent} callData
358
+ */
359
+ invokeStartRotate(callData: IRenderWindowInteractorEvent): void;
360
+
361
+ /**
362
+ *
363
+ * @param {IRenderWindowInteractorEvent} callData
364
+ */
365
+ invokeRotate(callData: IRenderWindowInteractorEvent): void;
366
+
367
+ /**
368
+ *
369
+ * @param {IRenderWindowInteractorEvent} callData
370
+ */
371
+ invokeEndRotate(callData: IRenderWindowInteractorEvent): void;
372
+
373
+ /**
374
+ *
375
+ * @param {IRenderWindowInteractorEvent} callData
376
+ */
377
+ invokeButton3D(callData: IRenderWindowInteractorEvent): void;
378
+
379
+ /**
380
+ *
381
+ * @param {IRenderWindowInteractorEvent} callData
382
+ */
383
+ invokeMove3D(callData: IRenderWindowInteractorEvent): void;
384
+
385
+ /**
386
+ *
387
+ * @param {IRenderWindowInteractorEvent} callData
388
+ */
389
+ invokeStartPointerLock(callData: IRenderWindowInteractorEvent): void;
390
+
391
+ /**
392
+ *
393
+ * @param {IRenderWindowInteractorEvent} callData
394
+ */
395
+ invokeEndPointerLock(callData: IRenderWindowInteractorEvent): void;
396
+
397
+ /**
398
+ *
399
+ * @param {IRenderWindowInteractorEvent} callData
400
+ */
401
+ invokeStartInteractionEvent(callData: IRenderWindowInteractorEvent): void;
402
+
403
+ /**
404
+ *
405
+ * @param {IRenderWindowInteractorEvent} callData
406
+ */
407
+ invokeInteractionEvent(callData: IRenderWindowInteractorEvent): void;
408
+
409
+ /**
410
+ *
411
+ * @param {IRenderWindowInteractorEvent} callData
412
+ */
413
+ invokeEndInteractionEvent(callData: IRenderWindowInteractorEvent): void;
414
+
415
+ /**
416
+ *
417
+ */
418
+ invokeRenderEvent(): void;
419
+
420
+ /**
421
+ *
422
+ * @param cb The callback to be called
423
+ */
424
+ onStartAnimation(
425
+ cb: InteractorEventCallback,
426
+ priority?: number
427
+ ): Readonly<vtkSubscription>;
428
+
429
+ /**
430
+ *
431
+ * @param {InteractorEventCallback} cb The callback to be called.
432
+ * @param {Number} [priority] The priority of the event.
433
+ */
434
+ onAnimation(
435
+ cb: InteractorEventCallback,
436
+ priority?: number
437
+ ): Readonly<vtkSubscription>;
438
+
439
+ /**
440
+ *
441
+ * @param {InteractorEventCallback} cb The callback to be called.
442
+ * @param {Number} [priority] The priority of the event.
443
+ */
444
+ onEndAnimation(
445
+ cb: InteractorEventCallback,
446
+ priority?: number
447
+ ): Readonly<vtkSubscription>;
448
+
449
+ /**
450
+ *
451
+ * @param {InteractorEventCallback} cb The callback to be called.
452
+ * @param {Number} [priority] The priority of the event.
453
+ */
454
+ onPointerEnter(
455
+ cb: InteractorEventCallback,
456
+ priority?: number
457
+ ): Readonly<vtkSubscription>;
458
+
459
+ /**
460
+ *
461
+ * @param cb The callback to be called
462
+ */
463
+ onPointerLeave(
464
+ cb: InteractorEventCallback,
465
+ priority?: number
466
+ ): Readonly<vtkSubscription>;
467
+
468
+ /**
469
+ *
470
+ * @param cb The callback to be called
471
+ */
472
+ onMouseEnter(
473
+ cb: InteractorEventCallback,
474
+ priority?: number
475
+ ): Readonly<vtkSubscription>;
476
+
477
+ /**
478
+ *
479
+ * @param {InteractorEventCallback} cb The callback to be called.
480
+ * @param {Number} [priority] The priority of the event.
481
+ */
482
+ onMouseLeave(
483
+ cb: InteractorEventCallback,
484
+ priority?: number
485
+ ): Readonly<vtkSubscription>;
486
+
487
+ /**
488
+ *
489
+ * @param {InteractorEventCallback} cb The callback to be called.
490
+ * @param {Number} [priority] The priority of the event.
491
+ */
492
+ onStartMouseMove(
493
+ cb: InteractorEventCallback,
494
+ priority?: number
495
+ ): Readonly<vtkSubscription>;
496
+
497
+ /**
498
+ *
499
+ * @param {InteractorEventCallback} cb The callback to be called.
500
+ * @param {Number} [priority] The priority of the event.
501
+ */
502
+ onMouseMove(
503
+ cb: InteractorEventCallback,
504
+ priority?: number
505
+ ): Readonly<vtkSubscription>;
506
+
507
+ /**
508
+ *
509
+ * @param {InteractorEventCallback} cb The callback to be called.
510
+ * @param {Number} [priority] The priority of the event.
511
+ */
512
+ onEndMouseMove(
513
+ cb: InteractorEventCallback,
514
+ priority?: number
515
+ ): Readonly<vtkSubscription>;
516
+
517
+ /**
518
+ *
519
+ * @param {InteractorEventCallback} cb The callback to be called.
520
+ * @param {Number} [priority] The priority of the event.
521
+ */
522
+ onLeftButtonPress(
523
+ cb: InteractorEventCallback,
524
+ priority?: number
525
+ ): Readonly<vtkSubscription>;
526
+
527
+ /**
528
+ *
529
+ * @param {InteractorEventCallback} cb The callback to be called.
530
+ * @param {Number} [priority] The priority of the event.
531
+ */
532
+ onLeftButtonRelease(
533
+ cb: InteractorEventCallback,
534
+ priority?: number
535
+ ): Readonly<vtkSubscription>;
536
+
537
+ /**
538
+ *
539
+ * @param {InteractorEventCallback} cb The callback to be called.
540
+ * @param {Number} [priority] The priority of the event.
541
+ */
542
+ onMiddleButtonPress(
543
+ cb: InteractorEventCallback,
544
+ priority?: number
545
+ ): Readonly<vtkSubscription>;
546
+
547
+ /**
548
+ *
549
+ * @param {InteractorEventCallback} cb The callback to be called.
550
+ * @param {Number} [priority] The priority of the event.
551
+ */
552
+ onMiddleButtonRelease(
553
+ cb: InteractorEventCallback,
554
+ priority?: number
555
+ ): Readonly<vtkSubscription>;
556
+
557
+ /**
558
+ *
559
+ * @param {InteractorEventCallback} cb The callback to be called.
560
+ * @param {Number} [priority] The priority of the event.
561
+ */
562
+ onRightButtonPress(
563
+ cb: InteractorEventCallback,
564
+ priority?: number
565
+ ): Readonly<vtkSubscription>;
566
+
567
+ /**
568
+ *
569
+ * @param {InteractorEventCallback} cb The callback to be called.
570
+ * @param {Number} [priority] The priority of the event.
571
+ */
572
+ onRightButtonRelease(
573
+ cb: InteractorEventCallback,
574
+ priority?: number
575
+ ): Readonly<vtkSubscription>;
576
+
577
+ /**
578
+ *
579
+ * @param {InteractorEventCallback} cb The callback to be called.
580
+ * @param {Number} [priority] The priority of the event.
581
+ */
582
+ onKeyPress(
583
+ cb: InteractorEventCallback,
584
+ priority?: number
585
+ ): Readonly<vtkSubscription>;
586
+
587
+ /**
588
+ *
589
+ * @param {InteractorEventCallback} cb The callback to be called.
590
+ * @param {Number} [priority] The priority of the event.
591
+ */
592
+ onKeyDown(
593
+ cb: InteractorEventCallback,
594
+ priority?: number
595
+ ): Readonly<vtkSubscription>;
596
+
597
+ /**
598
+ *
599
+ * @param {InteractorEventCallback} cb The callback to be called.
600
+ * @param {Number} [priority] The priority of the event.
601
+ */
602
+ onKeyUp(
603
+ cb: InteractorEventCallback,
604
+ priority?: number
605
+ ): Readonly<vtkSubscription>;
606
+
607
+ /**
608
+ *
609
+ * @param {InteractorEventCallback} cb The callback to be called.
610
+ * @param {Number} [priority] The priority of the event.
611
+ */
612
+ onStartMouseWheel(
613
+ cb: InteractorEventCallback,
614
+ priority?: number
615
+ ): Readonly<vtkSubscription>;
616
+
617
+ /**
618
+ *
619
+ * @param {InteractorEventCallback} cb The callback to be called.
620
+ * @param {Number} [priority] The priority of the event.
621
+ */
622
+ onMouseWheel(
623
+ cb: InteractorEventCallback,
624
+ priority?: number
625
+ ): Readonly<vtkSubscription>;
626
+
627
+ /**
628
+ *
629
+ * @param {InteractorEventCallback} cb The callback to be called.
630
+ * @param {Number} [priority] The priority of the event.
631
+ */
632
+ onEndMouseWheel(
633
+ cb: InteractorEventCallback,
634
+ priority?: number
635
+ ): Readonly<vtkSubscription>;
636
+
637
+ /**
638
+ *
639
+ * @param {InteractorEventCallback} cb The callback to be called.
640
+ * @param {Number} [priority] The priority of the event.
641
+ */
642
+ onStartPinch(
643
+ cb: InteractorEventCallback,
644
+ priority?: number
645
+ ): Readonly<vtkSubscription>;
646
+
647
+ /**
648
+ *
649
+ * @param {InteractorEventCallback} cb The callback to be called.
650
+ * @param {Number} [priority] The priority of the event.
651
+ */
652
+ onPinch(
653
+ cb: InteractorEventCallback,
654
+ priority?: number
655
+ ): Readonly<vtkSubscription>;
656
+
657
+ /**
658
+ *
659
+ * @param {InteractorEventCallback} cb The callback to be called.
660
+ * @param {Number} [priority] The priority of the event.
661
+ */
662
+ onEndPinch(
663
+ cb: InteractorEventCallback,
664
+ priority?: number
665
+ ): Readonly<vtkSubscription>;
666
+
667
+ /**
668
+ *
669
+ * @param {InteractorEventCallback} cb The callback to be called.
670
+ * @param {Number} [priority] The priority of the event.
671
+ */
672
+ onStartPan(
673
+ cb: InteractorEventCallback,
674
+ priority?: number
675
+ ): Readonly<vtkSubscription>;
676
+
677
+ /**
678
+ *
679
+ * @param {InteractorEventCallback} cb The callback to be called.
680
+ * @param {Number} [priority] The priority of the event.
681
+ */
682
+ onPan(
683
+ cb: InteractorEventCallback,
684
+ priority?: number
685
+ ): Readonly<vtkSubscription>;
686
+
687
+ /**
688
+ *
689
+ * @param {InteractorEventCallback} cb The callback to be called.
690
+ * @param {Number} [priority] The priority of the event.
691
+ */
692
+ onEndPan(
693
+ cb: InteractorEventCallback,
694
+ priority?: number
695
+ ): Readonly<vtkSubscription>;
696
+
697
+ /**
698
+ *
699
+ * @param {InteractorEventCallback} cb The callback to be called.
700
+ * @param {Number} [priority] The priority of the event.
701
+ */
702
+ onStartRotate(
703
+ cb: InteractorEventCallback,
704
+ priority?: number
705
+ ): Readonly<vtkSubscription>;
706
+
707
+ /**
708
+ *
709
+ * @param {InteractorEventCallback} cb The callback to be called.
710
+ * @param {Number} [priority] The priority of the event.
711
+ */
712
+ onRotate(
713
+ cb: InteractorEventCallback,
714
+ priority?: number
715
+ ): Readonly<vtkSubscription>;
716
+
717
+ /**
718
+ *
719
+ * @param {InteractorEventCallback} cb The callback to be called.
720
+ * @param {Number} [priority] The priority of the event.
721
+ */
722
+ onEndRotate(
723
+ cb: InteractorEventCallback,
724
+ priority?: number
725
+ ): Readonly<vtkSubscription>;
726
+
727
+ /**
728
+ *
729
+ * @param {InteractorEventCallback} cb The callback to be called.
730
+ * @param {Number} [priority] The priority of the event.
731
+ */
732
+ onButton3D(
733
+ cb: InteractorEventCallback,
734
+ priority?: number
735
+ ): Readonly<vtkSubscription>;
736
+
737
+ /**
738
+ *
739
+ * @param {InteractorEventCallback} cb The callback to be called.
740
+ * @param {Number} [priority] The priority of the event.
741
+ */
742
+ onMove3D(
743
+ cb: InteractorEventCallback,
744
+ priority?: number
745
+ ): Readonly<vtkSubscription>;
746
+
747
+ /**
748
+ *
749
+ * @param {InteractorEventCallback} cb The callback to be called.
750
+ * @param {Number} [priority] The priority of the event.
751
+ */
752
+ onStartPointerLock(
753
+ cb: InteractorEventCallback,
754
+ priority?: number
755
+ ): Readonly<vtkSubscription>;
756
+
757
+ /**
758
+ *
759
+ * @param {InteractorEventCallback} cb The callback to be called.
760
+ * @param {Number} [priority] The priority of the event.
761
+ */
762
+ onEndPointerLock(
763
+ cb: InteractorEventCallback,
764
+ priority?: number
765
+ ): Readonly<vtkSubscription>;
766
+
767
+ /**
768
+ *
769
+ * @param {InteractorEventCallback} cb The callback to be called.
770
+ * @param {Number} [priority] The priority of the event.
771
+ */
772
+ onStartInteractionEvent(
773
+ cb: InteractorEventCallback,
774
+ priority?: number
775
+ ): Readonly<vtkSubscription>;
776
+
777
+ /**
778
+ *
779
+ * @param {InteractorEventCallback} cb The callback to be called.
780
+ * @param {Number} [priority] The priority of the event.
781
+ */
782
+ onInteractionEvent(
783
+ cb: InteractorEventCallback,
784
+ priority?: number
785
+ ): Readonly<vtkSubscription>;
786
+
787
+ /**
788
+ *
789
+ * @param {InteractorEventCallback} cb The callback to be called.
790
+ * @param {Number} [priority] The priority of the event.
791
+ */
792
+ onEndInteractionEvent(
793
+ cb: InteractorEventCallback,
794
+ priority?: number
795
+ ): Readonly<vtkSubscription>;
796
+
797
+ /**
798
+ *
799
+ * @param {Function} cb The callback to be called.
800
+ * @param {Number} [priority] The priority of the event.
801
+ */
802
+ onRenderEvent(cb: () => void, priority?: number): Readonly<vtkSubscription>;
803
+
804
+ /**
805
+ *
806
+ * @param args
807
+ */
808
+ animationEvent(args: any): any;
809
+
810
+ /**
811
+ * Triggers the 'Button3D' event.
812
+ *
813
+ * @param args
814
+ */
815
+ button3DEvent(eventPayload: IButton3DEvent): void;
816
+
817
+ /**
818
+ *
819
+ * @param args
820
+ */
821
+ endAnimationEvent(args: any): any;
822
+
823
+ /**
824
+ *
825
+ * @param args
826
+ */
827
+ endInteractionEvent(args: any): any;
828
+
829
+ /**
830
+ *
831
+ * @param args
832
+ */
833
+ endMouseMoveEvent(args: any): any;
834
+
835
+ /**
836
+ *
837
+ * @param args
838
+ */
839
+ endMouseWheelEvent(args: any): any;
840
+
841
+ /**
842
+ *
843
+ * @param args
844
+ */
845
+ endPanEvent(args: any): any;
846
+
847
+ /**
848
+ *
849
+ * @param args
850
+ */
851
+ endPinchEvent(args: any): any;
852
+
853
+ /**
854
+ *
855
+ * @param args
856
+ */
857
+ endPointerLockEvent(args: any): any;
858
+
859
+ /**
860
+ *
861
+ * @param args
862
+ */
863
+ endRotateEvent(args: any): any;
864
+
865
+ /**
866
+ *
867
+ * @param args
868
+ */
869
+ interactionEvent(args: any): any;
870
+
871
+ /**
872
+ *
873
+ * @param args
874
+ */
875
+ keyDownEvent(args: any): any;
876
+
877
+ /**
878
+ *
879
+ * @param args
880
+ */
881
+ keyPressEvent(args: any): any;
882
+
883
+ /**
884
+ *
885
+ * @param args
886
+ */
887
+ keyUpEvent(args: any): any;
888
+
889
+ /**
890
+ *
891
+ * @param args
892
+ */
893
+ leftButtonPressEvent(args: any): any;
894
+
895
+ /**
896
+ *
897
+ * @param args
898
+ */
899
+ leftButtonReleaseEvent(args: any): any;
900
+
901
+ /**
902
+ *
903
+ * @param args
904
+ */
905
+ middleButtonPressEvent(args: any): any;
906
+
907
+ /**
908
+ *
909
+ * @param args
910
+ */
911
+ middleButtonReleaseEvent(args: any): any;
912
+
913
+ /**
914
+ *
915
+ * @param args
916
+ */
917
+ mouseEnterEvent(args: any): any;
918
+
919
+ /**
920
+ *
921
+ * @param args
922
+ */
923
+ mouseLeaveEvent(args: any): any;
924
+
925
+ /**
926
+ *
927
+ * @param args
928
+ */
929
+ mouseMoveEvent(args: any): any;
930
+
931
+ /**
932
+ *
933
+ * @param args
934
+ */
935
+ mouseWheelEvent(args: any): any;
936
+
937
+ /**
938
+ * Triggers the 'Move3D' event.
939
+ *
940
+ * @param eventPayload
941
+ */
942
+ move3DEvent(eventPayload: I3DEvent): void;
943
+
944
+ /**
945
+ *
946
+ * @param args
947
+ */
948
+ panEvent(args: any): any;
949
+
950
+ /**
951
+ *
952
+ * @param args
953
+ */
954
+ pinchEvent(args: any): any;
955
+
956
+ /**
957
+ *
958
+ * @param args
959
+ */
960
+ rightButtonPressEvent(args: any): any;
961
+
962
+ /**
963
+ *
964
+ * @param args
965
+ */
966
+ rightButtonReleaseEvent(args: any): any;
967
+
968
+ /**
969
+ *
970
+ * @param args
971
+ */
972
+ rotateEvent(args: any): any;
973
+
974
+ /**
975
+ * Add an HTMLElement as the new container for the interactor.
976
+ * All events will be bound to this new container.
977
+ * Any old container will be removed along with its listeners.
978
+ */
979
+ setContainer(container: Nullable<HTMLElement>): boolean;
980
+
981
+ /**
982
+ * Turn on/off the automatic repositioning of lights as the camera moves.
983
+ * @param lightFollowCamera
984
+ */
985
+ setLightFollowCamera(lightFollowCamera: boolean): boolean;
986
+
987
+ /**
988
+ * Set the object used to perform pick operations.
989
+ * @param picker
990
+ */
991
+ setPicker(picker: any): boolean;
992
+
993
+ /**
994
+ * Set whether preventDefault is called on pointer down.
995
+ * @param {Boolean} preventDefault
996
+ */
997
+ setPreventDefaultOnPointerDown(preventDefault: boolean): boolean;
998
+
999
+ /**
1000
+ * Set whether preventDefault is called on pointer up.
1001
+ *
1002
+ * If pointerup occurs without a preceeding pointerdown, then
1003
+ * this does nothing.
1004
+ *
1005
+ * @param {Boolean} preventDefault
1006
+ */
1007
+ setPreventDefaultOnPointerUp(preventDefault: boolean): boolean;
1008
+
1009
+ /**
1010
+ * Allow system to bypass scrolling debounce. This function must be called to allow the debounce to be bypassed
1011
+ * @param mouseScrollDebounceByPass
1012
+ */
1013
+
1014
+ setMouseScrollDebounceByPass(mouseScrollDebounceByPass: boolean): boolean;
1015
+
1016
+ /**
1017
+ *
1018
+ * @param recognizeGestures
1019
+ */
1020
+ setRecognizeGestures(recognizeGestures: boolean): boolean;
1021
+
1022
+ /**
1023
+ * Set the desired update rate.
1024
+ * @param desiredUpdateRate
1025
+ */
1026
+ setDesiredUpdateRate(desiredUpdateRate: number): boolean;
1027
+
1028
+ /**
1029
+ * Set the desired update rate when movement has stopped.
1030
+ * @param stillUpdateRate
1031
+ */
1032
+ setStillUpdateRate(stillUpdateRate: number): boolean;
1033
+
1034
+ /**
1035
+ * Start the event loop.
1036
+ * This is provided so that you do not have to implement your own event loop.
1037
+ * You still can use your own event loop if you want.
1038
+ */
1039
+ start(): void;
1040
+
1041
+ /**
1042
+ *
1043
+ * @param args
1044
+ */
1045
+ startAnimationEvent(args: any): any;
1046
+
1047
+ /**
1048
+ *
1049
+ * @param args
1050
+ */
1051
+ startInteractionEvent(args: any): any;
1052
+
1053
+ /**
1054
+ *
1055
+ * @param args
1056
+ */
1057
+ startMouseMoveEvent(args: any): any;
1058
+
1059
+ /**
1060
+ *
1061
+ * @param args
1062
+ */
1063
+ startMouseWheelEvent(args: any): any;
1064
+
1065
+ /**
1066
+ *
1067
+ * @param args
1068
+ */
1069
+ startPanEvent(args: any): any;
1070
+
1071
+ /**
1072
+ *
1073
+ * @param args
1074
+ */
1075
+ startPinchEvent(args: any): any;
1076
+
1077
+ /**
1078
+ *
1079
+ * @param args
1080
+ */
1081
+ startPointerLockEvent(args: any): any;
1082
+
1083
+ /**
1084
+ *
1085
+ * @param args
1086
+ */
1087
+ startRotateEvent(args: any): any;
1088
+
1089
+ /**
1090
+ * Set/Get the rendering window being controlled by this object.
1091
+ * @param aren
1092
+ */
1093
+ setRenderWindow(aren: any): void;
1094
+
1095
+ /**
1096
+ * External switching between joystick/trackball/new? modes.
1097
+ * @param style
1098
+ */
1099
+ setInteractorStyle(style: any): void;
1100
+
1101
+ /**
1102
+ * ---------------------------------------------------------------------
1103
+ */
1104
+ initialize(): void;
1105
+
1106
+ /**
1107
+ * Enable/Disable interactions.
1108
+ * By default interactors are enabled when initialized.
1109
+ * Initialize() must be called prior to enabling/disabling interaction.
1110
+ * These methods are used when a window/widget is being shared by multiple renderers and interactors.
1111
+ * This allows a "modal" display where one interactor is active when its data is to be displayed and all other interactors associated with the widget are disabled when their data is not displayed.
1112
+ */
1113
+ enable(): void;
1114
+
1115
+ /**
1116
+ *
1117
+ */
1118
+ disable(): void;
1119
+
1120
+ /**
1121
+ *
1122
+ */
1123
+ startEventLoop(): void;
1124
+
1125
+ /**
1126
+ *
1127
+ */
1128
+ getCurrentRenderer(): void;
1129
+
1130
+ /**
1131
+ * Manually sets the current renderer.
1132
+ * @param {vtkRenderer} ren
1133
+ */
1134
+ setCurrentRenderer(ren: vtkRenderer): void;
1135
+
1136
+ /**
1137
+ *
1138
+ * @param container kept for backward compatibility.
1139
+ * @deprecated please use vtkRenderWindowInteractor.setContainer(container: HTMLElement)
1140
+ * which will also bind events.
1141
+ */
1142
+ bindEvents(container: any): void;
1143
+
1144
+ /**
1145
+ *
1146
+ * @deprecated please use vtkRenderWindowInteractor.setContainer(null) instead.
1147
+ */
1148
+ unbindEvents(): void;
1149
+
1150
+ /**
1151
+ *
1152
+ * @param {KeyboardEvent} event
1153
+ */
1154
+ handleKeyPress(event: KeyboardEvent): void;
1155
+
1156
+ /**
1157
+ *
1158
+ * @param {KeyboardEvent} event
1159
+ */
1160
+ handleKeyDown(event: KeyboardEvent): void;
1161
+
1162
+ /**
1163
+ *
1164
+ * @param {KeyboardEvent} event
1165
+ */
1166
+ handleKeyUp(event: KeyboardEvent): void;
1167
+
1168
+ /**
1169
+ *
1170
+ * @param {PointerEvent} event
1171
+ */
1172
+ handlePointerDown(event: PointerEvent): void;
1173
+
1174
+ /**
1175
+ *
1176
+ * @param {PointerEvent} event
1177
+ */
1178
+ handlePointerUp(event: PointerEvent): void;
1179
+
1180
+ /**
1181
+ *
1182
+ * @param {PointerEvent} event
1183
+ */
1184
+ handlePointerCancel(event: PointerEvent): void;
1185
+
1186
+ /**
1187
+ *
1188
+ * @param {PointerEvent} event
1189
+ */
1190
+ handlePointerMove(event: PointerEvent): void;
1191
+
1192
+ /**
1193
+ *
1194
+ * @param {PointerEvent} event
1195
+ */
1196
+ handleMouseDown(event: PointerEvent): void;
1197
+
1198
+ /**
1199
+ *
1200
+ */
1201
+ requestPointerLock(): void;
1202
+
1203
+ /**
1204
+ *
1205
+ */
1206
+ exitPointerLock(): void;
1207
+
1208
+ /**
1209
+ *
1210
+ */
1211
+ isPointerLocked(): boolean;
1212
+
1213
+ /**
1214
+ *
1215
+ */
1216
+ handlePointerLockChange(): void;
1217
+
1218
+ /**
1219
+ *
1220
+ * @param requestor
1221
+ */
1222
+ requestAnimation(requestor: any): void;
1223
+
1224
+ /**
1225
+ *
1226
+ */
1227
+ isAnimating(): boolean;
1228
+
1229
+ /**
1230
+ *
1231
+ * @param requestor
1232
+ * @param {Boolean} [skipWarning]
1233
+ */
1234
+ cancelAnimation(requestor: any, skipWarning?: boolean): void;
1235
+
1236
+ /**
1237
+ *
1238
+ */
1239
+ switchToVRAnimation(): void;
1240
+
1241
+ /**
1242
+ *
1243
+ */
1244
+ returnFromVRAnimation(): void;
1245
+
1246
+ /**
1247
+ *
1248
+ * @param {Number} displayId The ID of the display.
1249
+ */
1250
+ updateGamepads(displayId: number): void;
1251
+
1252
+ /**
1253
+ *
1254
+ * @param {PointerEvent} event
1255
+ */
1256
+ handleMouseMove(event: PointerEvent): void;
1257
+
1258
+ /**
1259
+ *
1260
+ */
1261
+ handleAnimation(): void;
1262
+
1263
+ /**
1264
+ *
1265
+ * @param {MouseEvent} event
1266
+ */
1267
+ handleWheel(event: MouseEvent): void;
1268
+
1269
+ /**
1270
+ *
1271
+ * @param {PointerEvent} event
1272
+ */
1273
+ handlePointerEnter(event: PointerEvent): void;
1274
+
1275
+ /**
1276
+ *
1277
+ * @param {PointerEvent} event
1278
+ */
1279
+ handlePointerLeave(event: PointerEvent): void;
1280
+
1281
+ /**
1282
+ *
1283
+ * @param {PointerEvent} event
1284
+ */
1285
+ handleMouseUp(event: PointerEvent): void;
1286
+
1287
+ /**
1288
+ *
1289
+ * @param {PointerEvent} event
1290
+ */
1291
+ handleTouchStart(event: PointerEvent): void;
1292
+
1293
+ /**
1294
+ *
1295
+ * @param {PointerEvent} event
1296
+ */
1297
+ handleTouchMove(event: PointerEvent): void;
1298
+
1299
+ /**
1300
+ *
1301
+ * @param {PointerEvent} event
1302
+ */
1303
+ handleTouchEnd(event: PointerEvent): void;
1304
+
1305
+ /**
1306
+ *
1307
+ * @param val
1308
+ */
1309
+ setView(val: any): void;
1310
+
1311
+ /**
1312
+ * @return first renderer to be used for camera manipulation
1313
+ */
1314
+ getFirstRenderer(): vtkRenderer;
1315
+
1316
+ /**
1317
+ *
1318
+ * @param {Number} x
1319
+ * @param {Number} y
1320
+ */
1321
+ findPokedRenderer(x: number, y: number): Nullable<vtkRenderer>;
1322
+
1323
+ /**
1324
+ * only render if we are not animating. If we are animating
1325
+ * then renders will happen naturally anyhow and we definitely
1326
+ * do not want extra renders as the make the apparent interaction
1327
+ * rate slower.
1328
+ */
1329
+ render(): void;
1330
+
1331
+ /**
1332
+ * we know we are in multitouch now, so start recognizing
1333
+ * @param event
1334
+ * @param positions
1335
+ */
1336
+ recognizeGesture(
1337
+ event: 'TouchStart' | 'TouchMove' | 'TouchEnd',
1338
+ positions: IPosition
1339
+ ): void;
1340
+
1341
+ /**
1342
+ *
1343
+ */
1344
+ handleVisibilityChange(): void;
1345
+
1346
+ /**
1347
+ * Stop animating if the renderWindowInteractor is deleted.
1348
+ */
1349
+ delete(): void;
1239
1350
  }
1240
1351
 
1241
-
1242
1352
  /**
1243
1353
  * Method use to decorate a given object (publicAPI+model) with vtkRenderWindowInteractor characteristics.
1244
1354
  *
@@ -1246,12 +1356,18 @@ export interface vtkRenderWindowInteractor extends vtkObject {
1246
1356
  * @param model object on which data structure will be bounds (protected)
1247
1357
  * @param {IRenderWindowInteractorInitialValues} [initialValues] (default: {})
1248
1358
  */
1249
- export function extend(publicAPI: object, model: object, initialValues?: IRenderWindowInteractorInitialValues): void;
1359
+ export function extend(
1360
+ publicAPI: object,
1361
+ model: object,
1362
+ initialValues?: IRenderWindowInteractorInitialValues
1363
+ ): void;
1250
1364
 
1251
1365
  /**
1252
1366
  * Method use to create a new instance of vtkRenderWindowInteractor
1253
1367
  */
1254
- export function newInstance(initialValues?: IRenderWindowInteractorInitialValues): vtkRenderWindowInteractor;
1368
+ export function newInstance(
1369
+ initialValues?: IRenderWindowInteractorInitialValues
1370
+ ): vtkRenderWindowInteractor;
1255
1371
 
1256
1372
  /**
1257
1373
  * vtkRenderWindowInteractor provides an interaction mechanism for
@@ -1267,7 +1383,7 @@ export function newInstance(initialValues?: IRenderWindowInteractorInitialValues
1267
1383
  * Initialize/Start/Enable/Disable.
1268
1384
  *
1269
1385
  * ## Caveats
1270
- *
1386
+ *
1271
1387
  * vtkRenderWindowInteractor routes events through VTK’s command/observer design
1272
1388
  * pattern. That is, when vtkRenderWindowInteractor (actually, one of its
1273
1389
  * subclasses) sees an event, it translates it into a VTK event using the
@@ -1275,11 +1391,11 @@ export function newInstance(initialValues?: IRenderWindowInteractorInitialValues
1275
1391
  * that event are expected to respond appropriately.
1276
1392
  */
1277
1393
  export declare const vtkRenderWindowInteractor: {
1278
- newInstance: typeof newInstance;
1279
- extend: typeof extend;
1280
- handledEvents: typeof handledEvents;
1281
- Device: typeof Device;
1282
- Input: typeof Input;
1283
- Axis: typeof Axis;
1394
+ newInstance: typeof newInstance;
1395
+ extend: typeof extend;
1396
+ handledEvents: typeof handledEvents;
1397
+ Device: typeof Device;
1398
+ Input: typeof Input;
1399
+ Axis: typeof Axis;
1284
1400
  };
1285
1401
  export default vtkRenderWindowInteractor;