vtk-js/Sources/Interaction/Manipulators/CompositeGestureManipulator/index.d.ts at master · Kitware/vtk-js · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
import vtkInteractorStyle from '../../../Rendering/Core/InteractorStyle';
import vtkRenderer from '../../..//Rendering/Core/Renderer';
import vtkRenderWindowInteractor from '../../../Rendering/Core/RenderWindowInteractor';
import { Nullable } from '../../../types';

export interface vtkCompositeGestureManipulator {
  /**
   * Starts an interaction event.
   */
  startInteraction(): void;

  /**
   * Ends an interaction event.
   */
  endInteraction(): void;

  /**
   * Handles a start pinch gesture.
   * @param interactor
   * @param scale
   */
  onStartPinch(interactor: vtkRenderWindowInteractor, scale: number): void;

  /**
   * Handles a pinch gesture.
   * @param interactor
   * @param renderer
   * @param scale
   */
  onPinch(
    interactor: vtkRenderWindowInteractor,
    renderer: vtkRenderer,
    scale: number
  ): void;

  /**
   * Handles an end pinch gesture.
   * @param interactor
   */
  onEndPinch(interactor: vtkRenderWindowInteractor): void;

  /**
   * Handles a start rotate gesture.
   * @param interactor
   * @param rotation
   */
  onStartRotate(interactor: vtkRenderWindowInteractor, rotation: number): void;

  /**
   * Handles a rotate gesture.
   * @param interactor
   * @param renderer
   * @param rotation
   */
  onRotate(
    interactor: vtkRenderWindowInteractor,
    renderer: vtkRenderer,
    rotation: number
  ): void;

  /**
   * Handles an end pinch gesture.
   * @param interactor
   */
  onEndRotate(interactor: vtkRenderWindowInteractor): void;

  /**
   * Handles a start pan gesture.
   * @param interactor
   * @param translation
   */
  onStartPan(interactor: vtkRenderWindowInteractor, translation: number): void;

  /**
   * Handles a pan gesture.
   * @param interactor
   * @param renderer
   * @param translation
   */
  onPan(
    interactor: vtkRenderWindowInteractor,
    renderer: vtkRenderer,
    translation: number
  ): void;

  /**
   * Handles an end pan gesture.
   * @param interactor
   */
  onEndPan(interactor: vtkRenderWindowInteractor): void;

  /**
   * Is pinch enabled.
   */
  isPinchEnabled(): boolean;

  /**
   * Sets if pinch is enabled.
   * @param pinch
   */
  setPinchEnabled(pinch: boolean): boolean;

  /**
   * Gets flag if pinch is enabled.
   */
  getPinchEnabled(): boolean;

  /**
   * Is pan enabled.
   */
  isPanEnabled(): boolean;

  /**
   * Sets if pan is enabled.
   * @param pan
   */
  setPanEnabled(pan: boolean): boolean;

  /**
   * Gets flag if pan is enabled.
   */
  getPanEnabled(): boolean;

  /**
   * Is rotate enabled.
   */
  isRotateEnabled(): boolean;

  /**
   * Sets if rotate is enabled.
   * @param rotate
   */
  setRotateEnabled(rotate: boolean): boolean;

  /**
   * Gets flag if rotate is enabled.
   */
  getRotateEnabled(): boolean;

  /**
   * Sets the interactor style.
   * @param style vtkInteractorStyle
   */
  setInteractorStyle(style: Nullable<vtkInteractorStyle>): boolean;

  /**
   * Gets the interactor style.
   */
  getInteractorStyle(): Nullable<vtkInteractorStyle>;
}

export interface ICompositeGestureManipulatorInitialValues {
  pinchEnabled?: boolean;
  panEnabled?: boolean;
  rotateEnabled?: boolean;
}

export function extend(
  publicAPI: object,
  model: object,
  initialValues?: ICompositeGestureManipulatorInitialValues
): void;

export const vtkCompositeGestureManipulator: {
  extend: typeof extend;
};

export default vtkCompositeGestureManipulator;