@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
@@ -14,412 +14,457 @@ import vtkViewStream from './../../IO/Core/ImageStream/ViewStream';
14
14
  *
15
15
  */
16
16
  export interface IOpenGLRenderWindowInitialValues {
17
- cullFaceEnabled?: boolean;
18
- shaderCache?: null;
19
- initialized?: boolean;
20
- context?: WebGLRenderingContext | WebGL2RenderingContext;
21
- context2D?: CanvasRenderingContext2D;
22
- canvas?: HTMLCanvasElement;
23
- cursorVisibility?: boolean;
24
- cursor?: string;
25
- textureUnitManager?: null;
26
- textureResourceIds?: null;
27
- containerSize?: Size;
28
- renderPasses?: any[];
29
- notifyStartCaptureImage?: boolean;
30
- webgl2?: boolean;
31
- defaultToWebgl2?: boolean;
32
- activeFramebuffer?: any;
33
- imageFormat?: 'image/png';
34
- useOffScreen?: boolean;
35
- useBackgroundImage?: boolean;
17
+ cullFaceEnabled?: boolean;
18
+ shaderCache?: null;
19
+ initialized?: boolean;
20
+ context?: WebGLRenderingContext | WebGL2RenderingContext;
21
+ context2D?: CanvasRenderingContext2D;
22
+ canvas?: HTMLCanvasElement;
23
+ cursorVisibility?: boolean;
24
+ cursor?: string;
25
+ textureUnitManager?: null;
26
+ textureResourceIds?: null;
27
+ containerSize?: Size;
28
+ renderPasses?: any[];
29
+ notifyStartCaptureImage?: boolean;
30
+ webgl2?: boolean;
31
+ defaultToWebgl2?: boolean;
32
+ activeFramebuffer?: any;
33
+ imageFormat?: 'image/png';
34
+ useOffScreen?: boolean;
35
+ useBackgroundImage?: boolean;
36
36
  }
37
37
 
38
38
  export interface ICaptureOptions {
39
- resetCamera?: boolean;
40
- size?: Size;
41
- scale?: number
39
+ resetCamera?: boolean;
40
+ size?: Size;
41
+ scale?: number;
42
42
  }
43
43
 
44
- type vtkOpenGLRenderWindowBase = vtkObject & Omit<vtkAlgorithm,
45
- | 'getInputData'
46
- | 'setInputData'
47
- | 'setInputConnection'
48
- | 'getInputConnection'
49
- | 'addInputConnection'
50
- | 'addInputData'>;
44
+ type vtkOpenGLRenderWindowBase = vtkObject &
45
+ Omit<
46
+ vtkAlgorithm,
47
+ | 'getInputData'
48
+ | 'setInputData'
49
+ | 'setInputConnection'
50
+ | 'getInputConnection'
51
+ | 'addInputConnection'
52
+ | 'addInputData'
53
+ >;
51
54
 
52
55
  export interface vtkOpenGLRenderWindow extends vtkOpenGLRenderWindowBase {
53
-
54
- /**
55
- * Builds myself.
56
- * @param {Boolean} prepass
57
- */
58
- buildPass(prepass: boolean): void;
59
-
60
- /**
61
- * Initialize the rendering window. This will setup all system-specific
62
- * resources. This method and Finalize() must be symmetric and it should be
63
- * possible to call them multiple times, even changing WindowId in-between.
64
- * This is what WindowRemap does.
65
- */
66
- initialize(): void;
67
-
68
- /**
69
- *
70
- */
71
- makeCurrent(): void;
72
-
73
- /**
74
- *
75
- * @param {HTMLElement} el The container element.
76
- */
77
- setContainer(el: Nullable<HTMLElement>): void;
78
-
79
- /**
80
- * Get the container element.
81
- */
82
- getContainer(): Nullable<HTMLElement>;
83
-
84
- /**
85
- * Get the container size.
86
- */
87
- getContainerSize(): Vector2;
88
-
89
- /**
90
- * Get the frame buffer size.
91
- */
92
- getFramebufferSize(): Vector2;
93
-
94
- /**
95
- * Get the webgl canvas.
96
- */
97
- getCanvas(): Nullable<HTMLCanvasElement>;
98
-
99
- /**
100
- * Check if a point is in the viewport.
101
- * @param {Number} x The x coordinate.
102
- * @param {Number} y The y coordinate.
103
- * @param {vtkRenderer} viewport The viewport vtk element.
104
- */
105
- isInViewport(x: number, y: number, viewport: vtkRenderer): boolean;
106
-
107
- /**
108
- * Get the viewport size.
109
- * @param {vtkRenderer} viewport The viewport vtk element.
110
- */
111
- getViewportSize(viewport: vtkRenderer): Vector2;
112
-
113
- /**
114
- * Get the center of the viewport.
115
- * @param {vtkRenderer} viewport The viewport vtk element.
116
- */
117
- getViewportCenter(viewport: vtkRenderer): Vector2;
118
-
119
- /**
120
- *
121
- * @param {Number} x
122
- * @param {Number} y
123
- * @param {Number} z
124
- */
125
- displayToNormalizedDisplay(x: number, y: number, z: number): Vector3;
126
-
127
- /**
128
- *
129
- * @param {Number} x
130
- * @param {Number} y
131
- * @param {Number} z
132
- */
133
- normalizedDisplayToDisplay(x: number, y: number, z: number): Vector3;
134
-
135
- /**
136
- *
137
- * @param {Number} x
138
- * @param {Number} y
139
- * @param {Number} z
140
- * @param {vtkRenderer} renderer The vtkRenderer instance.
141
- */
142
- worldToView(x: number, y: number, z: number, renderer: vtkRenderer): Vector3;
143
-
144
- /**
145
- *
146
- * @param {Number} x
147
- * @param {Number} y
148
- * @param {Number} z
149
- * @param {vtkRenderer} renderer The vtkRenderer instance.
150
- */
151
- viewToWorld(x: number, y: number, z: number, renderer: vtkRenderer): Vector3;
152
-
153
- /**
154
- *
155
- * @param {Number} x
156
- * @param {Number} y
157
- * @param {Number} z
158
- * @param {vtkRenderer} renderer The vtkRenderer instance.
159
- */
160
- worldToDisplay(x: number, y: number, z: number, renderer: vtkRenderer): Vector3;
161
-
162
- /**
163
- *
164
- * @param {Number} x
165
- * @param {Number} y
166
- * @param {Number} z
167
- * @param {vtkRenderer} renderer The vtkRenderer instance.
168
- */
169
- displayToWorld(x: number, y: number, z: number, renderer: vtkRenderer): Vector3;
170
-
171
- /**
172
- *
173
- * @param {Number} x
174
- * @param {Number} y
175
- * @param {Number} z
176
- * @param {vtkRenderer} renderer The vtkRenderer instance.
177
- */
178
- normalizedDisplayToViewport(x: number, y: number, z: number, renderer: vtkRenderer): Vector3;
179
-
180
- /**
181
- *
182
- * @param {Number} x
183
- * @param {Number} y
184
- * @param {Number} z
185
- * @param {vtkRenderer} renderer The vtkRenderer instance.
186
- */
187
- viewportToNormalizedViewport(x: number, y: number, z: number, renderer: vtkRenderer): Vector3;
188
-
189
- /**
190
- *
191
- * @param {Number} x
192
- * @param {Number} y
193
- * @param {Number} z
194
- */
195
- normalizedViewportToViewport(x: number, y: number, z: number): Vector3;
196
-
197
- /**
198
- *
199
- * @param {Number} x
200
- * @param {Number} y
201
- * @param {Number} z
202
- */
203
- displayToLocalDisplay(x: number, y: number, z: number): Vector3;
204
-
205
- /**
206
- *
207
- * @param {Number} x
208
- * @param {Number} y
209
- * @param {Number} z
210
- * @param {vtkRenderer} renderer The vtkRenderer instance.
211
- */
212
- viewportToNormalizedDisplay(x: number, y: number, z: number, renderer: vtkRenderer): Vector3;
213
-
214
- /**
215
- *
216
- * @param {Number} x1
217
- * @param {Number} y1
218
- * @param {Number} x2
219
- * @param {Number} y2
220
- */
221
- getPixelData(x1: number, y1: number, x2: number, y2: number): Uint8Array;
222
-
223
- /**
224
- *
225
- * @param {WebGLContextAttributes} options
226
- */
227
- get3DContext(options: WebGLContextAttributes): Nullable<WebGLRenderingContext>;
228
-
229
- /**
230
- *
231
- * @param {CanvasRenderingContext2DSettings} options
232
- */
233
- get2DContext(options: CanvasRenderingContext2DSettings): Nullable<CanvasRenderingContext2D>;
234
-
235
- /**
236
- * Copy the content of the root parent, if there is one, to the canvas
237
- */
238
- copyParentContent(): void;
239
-
240
- /**
241
- * Resize this render window using the size of its children
242
- * The new size of the renderwindow is the size of the bounding box
243
- * containing all the child render windows
244
- */
245
- resizeFromChildRenderWindows(): void;
246
-
247
- /**
248
- * Returns the last ancestor of type vtkOpenGLRenderWindow if there is one
249
- * If there is no parent vtkOpenGLRenderWindow, returns undefined
250
- */
251
- getRootOpenGLRenderWindow(): vtkOpenGLRenderWindow | undefined;
252
-
253
- /**
254
- * The context 2D is created during initialization instead of the WebGL context
255
- * when there is a parent render window
256
- */
257
- getContext2D(): CanvasRenderingContext2D | undefined;
258
-
259
- /**
260
- *
261
- */
262
- setContext2D(context2D: CanvasRenderingContext2D | undefined): boolean;
263
-
264
- /**
265
- *
266
- */
267
- restoreContext(): void;
268
-
269
- /**
270
- *
271
- * @param {vtkTexture} texture
272
- */
273
- activateTexture(texture: vtkTexture): void;
274
-
275
- /**
276
- *
277
- * @param {vtkTexture} texture
278
- */
279
- deactivateTexture(texture: vtkTexture): void;
280
-
281
- /**
282
- *
283
- * @param {vtkTexture} texture
284
- */
285
- getTextureUnitForTexture(texture: vtkTexture): number;
286
-
287
- /**
288
- *
289
- * @param {VtkDataTypes} vtktype
290
- * @param {Number} numComps
291
- * @param {Boolean} useFloat
292
- * @param {unknown} oglNorm16Ext The WebGL EXT_texture_norm16 extension context
293
- * @param {Boolean} useHalfFloat
294
- */
295
- getDefaultTextureInternalFormat(vtktype: VtkDataTypes, numComps: number, oglNorm16Ext?: unknown, useHalfFloat?: boolean): void;
296
-
297
- /**
298
- *
299
- * @param {HTMLImageElement} img The background image.
300
- */
301
- setBackgroundImage(img: HTMLImageElement): void;
302
-
303
- /**
304
- *
305
- * @param {Boolean} value
306
- */
307
- setUseBackgroundImage(value: boolean): void;
308
-
309
- /**
310
- * Capture a screenshot of the contents of this renderwindow. The options
311
- * object can include a `size` array (`[w, h]`) or a `scale` floating point
312
- * value, as well as a `resetCamera` boolean. If `size` is provided, the
313
- * captured screenshot will be of the given size (and `resetCamera` could be
314
- * useful in this case if the aspect ratio of `size` does not match the
315
- * current renderwindow size). Otherwise, if `scale` is provided, it will
316
- * be multiplied by the current renderwindow size to compute the screenshot
317
- * size. If no `size` or `scale` are provided, the current renderwindow
318
- * size is assumed. The default format is "image/png". Returns a promise
319
- * that resolves to the captured screenshot.
320
- * @param {String} format
321
- * @param {ICaptureOptions} options
322
- */
323
- captureNextImage(format: string, options?: ICaptureOptions): Nullable<Promise<string>>;
324
-
325
- /**
326
- *
327
- */
328
- getGLInformations(): object;
329
-
330
- /**
331
- *
332
- */
333
- traverseAllPasses(): void;
334
-
335
- /**
336
- *
337
- */
338
- disableCullFace(): void;
339
-
340
- /**
341
- *
342
- */
343
- enableCullFace(): void;
344
-
345
- /**
346
- *
347
- * @param {vtkViewStream} stream The vtkViewStream instance.
348
- */
349
- setViewStream(stream: vtkViewStream): boolean;
350
-
351
- /**
352
- * Sets the pixel width and height of the rendered image.
353
- *
354
- * WebGL and WebGPU render windows apply these values to
355
- * the width and height attribute of the canvas element.
356
- *
357
- * To match the device resolution in browser environments,
358
- * multiply the container size by `window.devicePixelRatio`
359
- * `apiSpecificRenderWindow.setSize(Math.floor(containerWidth * devicePixelRatio), Math.floor(containerHeight * devicePixelRatio));
360
- * See the VTK.js FullscreenRenderWindow class for an example.
361
- *
362
- * @see getComputedDevicePixelRatio()
363
- *
364
- * @param {Vector2} size
365
- */
366
- setSize(size: Vector2): void;
367
-
368
- /**
369
- *
370
- * @param {Number} x
371
- * @param {Number} y
372
- */
373
- setSize(x: number, y: number): void;
374
-
375
- /**
376
- *
377
- */
378
- getSize(): Vector2;
379
-
380
- /**
381
- * Scales the size of a browser CSS pixel to a rendered canvas pixel.
382
- * `const renderedPixelWidth = cssPixelWidth * apiRenderWindow.getComputedDevicePixelRatio()`
383
- * Use to scale rendered objects to a consistent perceived size or DOM pixel position.
384
- *
385
- * Rather than using window.devicePixelRatio directly, the device pixel ratio is inferred
386
- * from the container CSS pixel size and rendered image pixel size. The user directly sets the rendered pixel size.
387
- *
388
- * @see setSize()
389
- * @see getContainerSize()
390
- */
391
- getComputedDevicePixelRatio(): number;
392
-
393
- /**
394
- * Set graphics resources for vtk objects to be cached at the context level.
395
- * This provides mappers with a convenient API to re-use allocated GPU resources
396
- * without duplication.
397
- *
398
- * @param {Object} vtkObj VTK data object / array with resources on the GPU
399
- * @param {Object} gObj Container object that maintains a handle to the graphics resource on the GPU
400
- * @param {String} hash String hash that can be used by mappers to decide whether to discard or re-allocate
401
- * the cached resource.
402
- */
403
- setGraphicsResourceForObject(vtkObj: vtkCellArray | vtkDataArray | vtkPoints, gObj: vtkOpenGLTexture | vtkBufferObject, hash: string): void;
404
-
405
- /**
406
- * Get graphics resources for vtk objects cached at the context level.
407
- * This provides mappers with a convenient API to re-use allocated GPU resources
408
- * without duplication.
409
- *
410
- * @param {Object} vtkObj VTK data object / array with resources on the GPU
411
- * the cached resource.
412
- * @return {Object} Dictionary with the graphics resource and string hash
413
- */
414
- getGraphicsResourceForObject(vtkObj: vtkCellArray | vtkDataArray | vtkPoints): {gObj: vtkOpenGLTexture | vtkBufferObject, hash: string};
415
-
416
- /**
417
- * Get approximate graphics memory usage, in bytes, for the context. This is a simple computation
418
- * that analyzes how much memory is allocated on the GPU for textures, VBOs, etc. to give an
419
- * application a view of its graphics memory consumption.
420
- * Note that this ignores page resources.
421
- */
422
- getGraphicsMemoryInfo(): number;
56
+ /**
57
+ * Builds myself.
58
+ * @param {Boolean} prepass
59
+ */
60
+ buildPass(prepass: boolean): void;
61
+
62
+ /**
63
+ * Initialize the rendering window. This will setup all system-specific
64
+ * resources. This method and Finalize() must be symmetric and it should be
65
+ * possible to call them multiple times, even changing WindowId in-between.
66
+ * This is what WindowRemap does.
67
+ */
68
+ initialize(): void;
69
+
70
+ /**
71
+ *
72
+ */
73
+ makeCurrent(): void;
74
+
75
+ /**
76
+ *
77
+ * @param {HTMLElement} el The container element.
78
+ */
79
+ setContainer(el: Nullable<HTMLElement>): void;
80
+
81
+ /**
82
+ * Get the container element.
83
+ */
84
+ getContainer(): Nullable<HTMLElement>;
85
+
86
+ /**
87
+ * Get the container size.
88
+ */
89
+ getContainerSize(): Vector2;
90
+
91
+ /**
92
+ * Get the frame buffer size.
93
+ */
94
+ getFramebufferSize(): Vector2;
95
+
96
+ /**
97
+ * Get the webgl canvas.
98
+ */
99
+ getCanvas(): Nullable<HTMLCanvasElement>;
100
+
101
+ /**
102
+ * Check if a point is in the viewport.
103
+ * @param {Number} x The x coordinate.
104
+ * @param {Number} y The y coordinate.
105
+ * @param {vtkRenderer} viewport The viewport vtk element.
106
+ */
107
+ isInViewport(x: number, y: number, viewport: vtkRenderer): boolean;
108
+
109
+ /**
110
+ * Get the viewport size.
111
+ * @param {vtkRenderer} viewport The viewport vtk element.
112
+ */
113
+ getViewportSize(viewport: vtkRenderer): Vector2;
114
+
115
+ /**
116
+ * Get the center of the viewport.
117
+ * @param {vtkRenderer} viewport The viewport vtk element.
118
+ */
119
+ getViewportCenter(viewport: vtkRenderer): Vector2;
120
+
121
+ /**
122
+ *
123
+ * @param {Number} x
124
+ * @param {Number} y
125
+ * @param {Number} z
126
+ */
127
+ displayToNormalizedDisplay(x: number, y: number, z: number): Vector3;
128
+
129
+ /**
130
+ *
131
+ * @param {Number} x
132
+ * @param {Number} y
133
+ * @param {Number} z
134
+ */
135
+ normalizedDisplayToDisplay(x: number, y: number, z: number): Vector3;
136
+
137
+ /**
138
+ *
139
+ * @param {Number} x
140
+ * @param {Number} y
141
+ * @param {Number} z
142
+ * @param {vtkRenderer} renderer The vtkRenderer instance.
143
+ */
144
+ worldToView(x: number, y: number, z: number, renderer: vtkRenderer): Vector3;
145
+
146
+ /**
147
+ *
148
+ * @param {Number} x
149
+ * @param {Number} y
150
+ * @param {Number} z
151
+ * @param {vtkRenderer} renderer The vtkRenderer instance.
152
+ */
153
+ viewToWorld(x: number, y: number, z: number, renderer: vtkRenderer): Vector3;
154
+
155
+ /**
156
+ *
157
+ * @param {Number} x
158
+ * @param {Number} y
159
+ * @param {Number} z
160
+ * @param {vtkRenderer} renderer The vtkRenderer instance.
161
+ */
162
+ worldToDisplay(
163
+ x: number,
164
+ y: number,
165
+ z: number,
166
+ renderer: vtkRenderer
167
+ ): Vector3;
168
+
169
+ /**
170
+ *
171
+ * @param {Number} x
172
+ * @param {Number} y
173
+ * @param {Number} z
174
+ * @param {vtkRenderer} renderer The vtkRenderer instance.
175
+ */
176
+ displayToWorld(
177
+ x: number,
178
+ y: number,
179
+ z: number,
180
+ renderer: vtkRenderer
181
+ ): Vector3;
182
+
183
+ /**
184
+ *
185
+ * @param {Number} x
186
+ * @param {Number} y
187
+ * @param {Number} z
188
+ * @param {vtkRenderer} renderer The vtkRenderer instance.
189
+ */
190
+ normalizedDisplayToViewport(
191
+ x: number,
192
+ y: number,
193
+ z: number,
194
+ renderer: vtkRenderer
195
+ ): Vector3;
196
+
197
+ /**
198
+ *
199
+ * @param {Number} x
200
+ * @param {Number} y
201
+ * @param {Number} z
202
+ * @param {vtkRenderer} renderer The vtkRenderer instance.
203
+ */
204
+ viewportToNormalizedViewport(
205
+ x: number,
206
+ y: number,
207
+ z: number,
208
+ renderer: vtkRenderer
209
+ ): Vector3;
210
+
211
+ /**
212
+ *
213
+ * @param {Number} x
214
+ * @param {Number} y
215
+ * @param {Number} z
216
+ */
217
+ normalizedViewportToViewport(x: number, y: number, z: number): Vector3;
218
+
219
+ /**
220
+ *
221
+ * @param {Number} x
222
+ * @param {Number} y
223
+ * @param {Number} z
224
+ */
225
+ displayToLocalDisplay(x: number, y: number, z: number): Vector3;
226
+
227
+ /**
228
+ *
229
+ * @param {Number} x
230
+ * @param {Number} y
231
+ * @param {Number} z
232
+ * @param {vtkRenderer} renderer The vtkRenderer instance.
233
+ */
234
+ viewportToNormalizedDisplay(
235
+ x: number,
236
+ y: number,
237
+ z: number,
238
+ renderer: vtkRenderer
239
+ ): Vector3;
240
+
241
+ /**
242
+ *
243
+ * @param {Number} x1
244
+ * @param {Number} y1
245
+ * @param {Number} x2
246
+ * @param {Number} y2
247
+ */
248
+ getPixelData(x1: number, y1: number, x2: number, y2: number): Uint8Array;
249
+
250
+ /**
251
+ *
252
+ * @param {WebGLContextAttributes} options
253
+ */
254
+ get3DContext(
255
+ options: WebGLContextAttributes
256
+ ): Nullable<WebGLRenderingContext>;
257
+
258
+ /**
259
+ *
260
+ * @param {CanvasRenderingContext2DSettings} options
261
+ */
262
+ get2DContext(
263
+ options: CanvasRenderingContext2DSettings
264
+ ): Nullable<CanvasRenderingContext2D>;
265
+
266
+ /**
267
+ * Copy the content of the root parent, if there is one, to the canvas
268
+ */
269
+ copyParentContent(): void;
270
+
271
+ /**
272
+ * Resize this render window using the size of its children
273
+ * The new size of the renderwindow is the size of the bounding box
274
+ * containing all the child render windows
275
+ */
276
+ resizeFromChildRenderWindows(): void;
277
+
278
+ /**
279
+ * Returns the last ancestor of type vtkOpenGLRenderWindow if there is one
280
+ * If there is no parent vtkOpenGLRenderWindow, returns undefined
281
+ */
282
+ getRootOpenGLRenderWindow(): vtkOpenGLRenderWindow | undefined;
283
+
284
+ /**
285
+ * The context 2D is created during initialization instead of the WebGL context
286
+ * when there is a parent render window
287
+ */
288
+ getContext2D(): CanvasRenderingContext2D | undefined;
289
+
290
+ /**
291
+ *
292
+ */
293
+ setContext2D(context2D: CanvasRenderingContext2D | undefined): boolean;
294
+
295
+ /**
296
+ *
297
+ */
298
+ restoreContext(): void;
299
+
300
+ /**
301
+ *
302
+ * @param {vtkTexture} texture
303
+ */
304
+ activateTexture(texture: vtkTexture): void;
305
+
306
+ /**
307
+ *
308
+ * @param {vtkTexture} texture
309
+ */
310
+ deactivateTexture(texture: vtkTexture): void;
311
+
312
+ /**
313
+ *
314
+ * @param {vtkTexture} texture
315
+ */
316
+ getTextureUnitForTexture(texture: vtkTexture): number;
317
+
318
+ /**
319
+ *
320
+ * @param {VtkDataTypes} vtktype
321
+ * @param {Number} numComps
322
+ * @param {Boolean} useFloat
323
+ * @param {unknown} oglNorm16Ext The WebGL EXT_texture_norm16 extension context
324
+ * @param {Boolean} useHalfFloat
325
+ */
326
+ getDefaultTextureInternalFormat(
327
+ vtktype: VtkDataTypes,
328
+ numComps: number,
329
+ oglNorm16Ext?: unknown,
330
+ useHalfFloat?: boolean
331
+ ): void;
332
+
333
+ /**
334
+ *
335
+ * @param {HTMLImageElement} img The background image.
336
+ */
337
+ setBackgroundImage(img: HTMLImageElement): void;
338
+
339
+ /**
340
+ *
341
+ * @param {Boolean} value
342
+ */
343
+ setUseBackgroundImage(value: boolean): void;
344
+
345
+ /**
346
+ * Capture a screenshot of the contents of this renderwindow. The options
347
+ * object can include a `size` array (`[w, h]`) or a `scale` floating point
348
+ * value, as well as a `resetCamera` boolean. If `size` is provided, the
349
+ * captured screenshot will be of the given size (and `resetCamera` could be
350
+ * useful in this case if the aspect ratio of `size` does not match the
351
+ * current renderwindow size). Otherwise, if `scale` is provided, it will
352
+ * be multiplied by the current renderwindow size to compute the screenshot
353
+ * size. If no `size` or `scale` are provided, the current renderwindow
354
+ * size is assumed. The default format is "image/png". Returns a promise
355
+ * that resolves to the captured screenshot.
356
+ * @param {String} format
357
+ * @param {ICaptureOptions} options
358
+ */
359
+ captureNextImage(
360
+ format: string,
361
+ options?: ICaptureOptions
362
+ ): Nullable<Promise<string>>;
363
+
364
+ /**
365
+ *
366
+ */
367
+ getGLInformations(): object;
368
+
369
+ /**
370
+ *
371
+ */
372
+ traverseAllPasses(): void;
373
+
374
+ /**
375
+ *
376
+ */
377
+ disableCullFace(): void;
378
+
379
+ /**
380
+ *
381
+ */
382
+ enableCullFace(): void;
383
+
384
+ /**
385
+ *
386
+ * @param {vtkViewStream} stream The vtkViewStream instance.
387
+ */
388
+ setViewStream(stream: vtkViewStream): boolean;
389
+
390
+ /**
391
+ * Sets the pixel width and height of the rendered image.
392
+ *
393
+ * WebGL and WebGPU render windows apply these values to
394
+ * the width and height attribute of the canvas element.
395
+ *
396
+ * To match the device resolution in browser environments,
397
+ * multiply the container size by `window.devicePixelRatio`
398
+ * `apiSpecificRenderWindow.setSize(Math.floor(containerWidth * devicePixelRatio), Math.floor(containerHeight * devicePixelRatio));
399
+ * See the VTK.js FullscreenRenderWindow class for an example.
400
+ *
401
+ * @see getComputedDevicePixelRatio()
402
+ *
403
+ * @param {Vector2} size
404
+ */
405
+ setSize(size: Vector2): void;
406
+
407
+ /**
408
+ *
409
+ * @param {Number} x
410
+ * @param {Number} y
411
+ */
412
+ setSize(x: number, y: number): void;
413
+
414
+ /**
415
+ *
416
+ */
417
+ getSize(): Vector2;
418
+
419
+ /**
420
+ * Scales the size of a browser CSS pixel to a rendered canvas pixel.
421
+ * `const renderedPixelWidth = cssPixelWidth * apiRenderWindow.getComputedDevicePixelRatio()`
422
+ * Use to scale rendered objects to a consistent perceived size or DOM pixel position.
423
+ *
424
+ * Rather than using window.devicePixelRatio directly, the device pixel ratio is inferred
425
+ * from the container CSS pixel size and rendered image pixel size. The user directly sets the rendered pixel size.
426
+ *
427
+ * @see setSize()
428
+ * @see getContainerSize()
429
+ */
430
+ getComputedDevicePixelRatio(): number;
431
+
432
+ /**
433
+ * Set graphics resources for vtk objects to be cached at the context level.
434
+ * This provides mappers with a convenient API to re-use allocated GPU resources
435
+ * without duplication.
436
+ *
437
+ * @param {Object} vtkObj VTK data object / array with resources on the GPU
438
+ * @param {Object} gObj Container object that maintains a handle to the graphics resource on the GPU
439
+ * @param {String} hash String hash that can be used by mappers to decide whether to discard or re-allocate
440
+ * the cached resource.
441
+ */
442
+ setGraphicsResourceForObject(
443
+ vtkObj: vtkCellArray | vtkDataArray | vtkPoints,
444
+ gObj: vtkOpenGLTexture | vtkBufferObject,
445
+ hash: string
446
+ ): void;
447
+
448
+ /**
449
+ * Get graphics resources for vtk objects cached at the context level.
450
+ * This provides mappers with a convenient API to re-use allocated GPU resources
451
+ * without duplication.
452
+ *
453
+ * @param {Object} vtkObj VTK data object / array with resources on the GPU
454
+ * the cached resource.
455
+ * @return {Object} Dictionary with the graphics resource and string hash
456
+ */
457
+ getGraphicsResourceForObject(
458
+ vtkObj: vtkCellArray | vtkDataArray | vtkPoints
459
+ ): { gObj: vtkOpenGLTexture | vtkBufferObject; hash: string };
460
+
461
+ /**
462
+ * Get approximate graphics memory usage, in bytes, for the context. This is a simple computation
463
+ * that analyzes how much memory is allocated on the GPU for textures, VBOs, etc. to give an
464
+ * application a view of its graphics memory consumption.
465
+ * Note that this ignores page resources.
466
+ */
467
+ getGraphicsMemoryInfo(): number;
423
468
  }
424
469
 
425
470
  /**
@@ -429,13 +474,19 @@ export interface vtkOpenGLRenderWindow extends vtkOpenGLRenderWindowBase {
429
474
  * @param model object on which data structure will be bounds (protected)
430
475
  * @param {IOpenGLRenderWindowInitialValues} [initialValues] (default: {})
431
476
  */
432
- export function extend(publicAPI: object, model: object, initialValues?: IOpenGLRenderWindowInitialValues): void;
477
+ export function extend(
478
+ publicAPI: object,
479
+ model: object,
480
+ initialValues?: IOpenGLRenderWindowInitialValues
481
+ ): void;
433
482
 
434
483
  /**
435
484
  * Method used to create a new instance of vtkOpenGLRenderWindow.
436
485
  * @param {IOpenGLRenderWindowInitialValues} [initialValues] for pre-setting some of its content
437
486
  */
438
- export function newInstance(initialValues?: IOpenGLRenderWindowInitialValues): vtkOpenGLRenderWindow;
487
+ export function newInstance(
488
+ initialValues?: IOpenGLRenderWindowInitialValues
489
+ ): vtkOpenGLRenderWindow;
439
490
 
440
491
  /**
441
492
  *
@@ -455,9 +506,9 @@ export function popMonitorGLContextCount(cb: any): void;
455
506
  * vtkOpenGLRenderWindow is designed to view/render a vtkRenderWindow.
456
507
  */
457
508
  export declare const vtkOpenGLRenderWindow: {
458
- newInstance: typeof newInstance,
459
- extend: typeof extend,
460
- pushMonitorGLContextCount: typeof pushMonitorGLContextCount,
461
- popMonitorGLContextCount: typeof popMonitorGLContextCount,
509
+ newInstance: typeof newInstance;
510
+ extend: typeof extend;
511
+ pushMonitorGLContextCount: typeof pushMonitorGLContextCount;
512
+ popMonitorGLContextCount: typeof popMonitorGLContextCount;
462
513
  };
463
514
  export default vtkOpenGLRenderWindow;