Skip to content

Commit 1ece6b7

Browse files
author
Adrien Boucaud
committed
docs(ts): Fix ViewStream and RemoteView definitions
1 parent 26e60e7 commit 1ece6b7

File tree

3 files changed

+54
-13
lines changed

3 files changed

+54
-13
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
import { Size, Vector3 } from '../../../types';
2+
3+
declare function createMethods(session: any): {
4+
subscribeToImageStream: (callback: any) => any;
5+
unsubscribeToImageStream: (subscription: any) => any;
6+
registerView: (viewId: number) => any;
7+
unregisterView: (viewId: number) => any;
8+
enableView: (viewId: number, enabled: boolean) => any;
9+
render: (options?: {
10+
size: Size;
11+
view: number;
12+
}) => any;
13+
resetCamera: (view?: number) => any;
14+
invalidateCache: (viewId: number) => any;
15+
setQuality: (viewId: number, quality: number, ratio?: number) => any;
16+
setSize: (viewId: number, width?: number, height?: number) => any;
17+
setServerAnimationFPS: (fps?: number) => any;
18+
getServerAnimationFPS: () => number;
19+
startAnimation: (viewId?: number) => any;
20+
stopAnimation: (viewId?: number) => any;
21+
updateCamera: (viewId: number, focalPoint: Vector3, viewUp: Vector3, position: Vector3, forceUpdate?: boolean) => any;
22+
updateCameraParameters: (viewId?: number, parameters?: {}, forceUpdate?: boolean) => any;
23+
}
24+
25+
export default createMethods;

Sources/IO/Core/ImageStream/ViewStream.d.ts

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
import { vtkObject } from '../../../interfaces';
2-
2+
import { Size } from '../../../types';
3+
import vtkCamera from '../../../Rendering/Core/Camera';
4+
import DefaultProtocol from './DefaultProtocol';
35
/**
46
*
57
*/
68
export interface IViewStreamInitialValues {
7-
protocol?: any;
9+
protocol?: typeof DefaultProtocol;
810
api?: any;
911
cameraUpdateRate?: number;
1012
decodeImage?: boolean;
@@ -13,13 +15,26 @@ export interface IViewStreamInitialValues {
1315
interactiveRatio?: number;
1416
isAnimating?: boolean;
1517
mimeType?: string;
16-
size?: number[];
18+
size?: Size;
1719
stillQuality?: number;
1820
stillRatio?: number;
1921
useCameraParameters?: boolean;
2022
viewId?: string;
2123
}
2224

25+
interface IMetaData {
26+
size: Size,
27+
id: string,
28+
memory: number,
29+
workTime: number,
30+
}
31+
32+
interface IEvent {
33+
url: string,
34+
fps: number[],
35+
metadata: IMetaData,
36+
}
37+
2338
export interface vtkViewStream extends vtkObject {
2439
/**
2540
*
@@ -35,28 +50,28 @@ export interface vtkViewStream extends vtkObject {
3550
/**
3651
*
3752
*/
38-
getSize(): number[];
53+
getSize(): Size;
3954

4055
/**
4156
*
4257
*/
43-
getFps(): any;
58+
getFps(): number[];
4459

4560
/**
4661
*
4762
*/
48-
getLastImageEvent(): any;
63+
getLastImageEvent(): IEvent;
4964

5065
/**
5166
*
5267
*/
53-
getCamera(): any;
68+
getCamera(): vtkCamera;
5469

5570
/**
5671
*
5772
* @param camera
5873
*/
59-
setCamera(camera: any): boolean;
74+
setCamera(camera: vtkCamera): boolean;
6075

6176
/**
6277
*
@@ -72,7 +87,7 @@ export interface vtkViewStream extends vtkObject {
7287
/**
7388
*
7489
*/
75-
getDecodeImage(): any;
90+
getDecodeImage(): boolean;
7691

7792
/**
7893
*

Sources/Rendering/Misc/RemoteView/index.d.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
import { vtkObject } from '../../../interfaces';
2-
import { vtkCanvasView } from '../CanvasView';
2+
import vtkCanvasView from '../CanvasView';
3+
import vtkViewStream from '../../../IO/Core/ImageStream/ViewStream';
34

45
interface IRemoteViewInitialValues {
5-
viewId?: number;
6+
viewId?: string;
67
interactiveQuality?: number;
78
interactiveRatio?: number;
89
stillQuality?: number;
@@ -21,7 +22,7 @@ export interface vtkRemoteView extends vtkObject {
2122
/**
2223
*
2324
*/
24-
getViewStream(): any;
25+
getViewStream(): vtkViewStream;
2526

2627
/**
2728
*
@@ -111,7 +112,7 @@ export interface vtkRemoteView extends vtkObject {
111112
*
112113
* @param viewStream
113114
*/
114-
setViewStream(viewStream: any): boolean; // viewStream is vtkViewStream
115+
setViewStream(viewStream: vtkViewStream): boolean;
115116

116117
/**
117118
*

0 commit comments

Comments
 (0)