File: __init__.pyi

package info (click to toggle)
python-ocp 7.8.1.2-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 64,720 kB
  • sloc: cpp: 362,337; pascal: 33; python: 23; makefile: 4
file content (416 lines) | stat: -rw-r--r-- 12,538 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
import OCP.IVtkTools
from typing import *
from typing import Iterable as iterable
from typing import Iterator as iterator
from numpy import float64
_Shape = Tuple[int, ...]
import OCP.IVtk
import OCP.IVtkOCC
__all__  = [
"IVtkTools_SubPolyDataFilter",
"IVtkTools_ShapeDataSource",
"IVtkTools_ShapeObject",
"IVtkTools_ShapePicker",
"IVtkTools_DisplayModeFilter"
]
class IVtkTools_SubPolyDataFilter():
    """
    Cells filter according to the given set of cells ids.
    """
    @overload
    def AddData(self,theSet : OCP.IVtk.IVtk_IdTypeMap) -> None: 
        """
        Add ids to be passed through this filter.

        Add ids to be passed through this filter.
        """
    @overload
    def AddData(self,theIds : OCP.IVtk.IVtk_ShapeIdList) -> None: ...
    def Clear(self) -> None: 
        """
        Clear ids set to be passed through this filter.
        """
    def GetNumberOfGenerationsFromBase(self,type : str) -> int: 
        """
        None
        """
    @staticmethod
    def GetNumberOfGenerationsFromBaseType_s(type : str) -> int: 
        """
        None
        """
    def IsA(self,type : str) -> int: 
        """
        None
        """
    @staticmethod
    def IsTypeOf_s(type : str) -> int: 
        """
        None
        """
    def NewInstance(self) -> IVtkTools_SubPolyDataFilter: 
        """
        None
        """
    @staticmethod
    def New_s() -> IVtkTools_SubPolyDataFilter: 
        """
        None
        """
    @staticmethod
    def SafeDownCast_s(o : vtkObjectBase) -> IVtkTools_SubPolyDataFilter: 
        """
        None
        """
    @overload
    def SetData(self,theSet : OCP.IVtk.IVtk_IdTypeMap) -> None: 
        """
        Set ids to be passed through this filter.

        Set ids to be passed through this filter.
        """
    @overload
    def SetData(self,theIds : OCP.IVtk.IVtk_ShapeIdList) -> None: ...
    def SetDoFiltering(self,theDoFiltering : bool) -> None: 
        """
        None
        """
    def SetIdsArrayName(self,theArrayName : str) -> None: 
        """
        Set ids array name.
        """
    pass
class IVtkTools_ShapeDataSource():
    """
    VTK data source for OCC shapes polygonal data.
    """
    def Contains(self,theOccShape : OCP.IVtkOCC.IVtkOCC_Shape) -> bool: 
        """
        Checks if the internal OccShape pointer is the same the argument.
        """
    def FastTransformModeOff(self) -> None: 
        """
        None
        """
    def FastTransformModeOn(self) -> None: 
        """
        None
        """
    def GetId(self) -> int: 
        """
        Returns ID of the shape used as a topological input for this data source.
        """
    def GetNumberOfGenerationsFromBase(self,type : str) -> int: 
        """
        None
        """
    @staticmethod
    def GetNumberOfGenerationsFromBaseType_s(type : str) -> int: 
        """
        None
        """
    def GetShape(self) -> OCP.IVtkOCC.IVtkOCC_Shape: 
        """
        Get the source OCCT shape.
        """
    def IsA(self,type : str) -> int: 
        """
        None
        """
    @staticmethod
    def IsTypeOf_s(type : str) -> int: 
        """
        None
        """
    def NewInstance(self) -> IVtkTools_ShapeDataSource: 
        """
        None
        """
    @staticmethod
    def New_s() -> IVtkTools_ShapeDataSource: 
        """
        None
        """
    @staticmethod
    def SafeDownCast_s(o : vtkObjectBase) -> IVtkTools_ShapeDataSource: 
        """
        None
        """
    def SetShape(self,theOccShape : OCP.IVtkOCC.IVtkOCC_Shape) -> None: 
        """
        Set the source OCCT shape.
        """
    def SubShapeIDs(self) -> Any: 
        """
        Access to the shape's sub-shape ids array
        """
    pass
class IVtkTools_ShapeObject():
    """
    VTK holder class for OCC shapes to pass them through pipelines.
    """
    def GetNumberOfGenerationsFromBase(self,type : str) -> int: 
        """
        None
        """
    @staticmethod
    def GetNumberOfGenerationsFromBaseType_s(type : str) -> int: 
        """
        None
        """
    @staticmethod
    def GetOccShape_s(theActor : vtkActor) -> OCP.IVtkOCC.IVtkOCC_Shape: 
        """
        Get OCC shape from VTK data from actor's information object by key.
        """
    def GetShapeSource(self) -> IVtkTools_ShapeDataSource: 
        """
        OCC shape source getter.
        """
    @staticmethod
    def GetShapeSource_s(theActor : vtkActor) -> Any: 
        """
        Get OCC shape source from VTK data from actor's information object by key.
        """
    def IsA(self,type : str) -> int: 
        """
        None
        """
    @staticmethod
    def IsTypeOf_s(type : str) -> int: 
        """
        None
        """
    def NewInstance(self) -> IVtkTools_ShapeObject: 
        """
        None
        """
    @staticmethod
    def New_s() -> IVtkTools_ShapeObject: 
        """
        None
        """
    @staticmethod
    def SafeDownCast_s(o : vtkObjectBase) -> IVtkTools_ShapeObject: 
        """
        None
        """
    def SetShapeSource(self,theDataSource : IVtkTools_ShapeDataSource) -> None: 
        """
        OCC shape source setter.
        """
    @staticmethod
    @overload
    def SetShapeSource_s(theDataSource : IVtkTools_ShapeDataSource,theActor : vtkActor) -> None: 
        """
        Static method to set OCC shape source to VTK dataset in information object with key.

        Static method to set OCC shape source to VTK actor in information object with key.
        """
    @staticmethod
    @overload
    def SetShapeSource_s(theDataSource : IVtkTools_ShapeDataSource,theData : vtkDataSet) -> None: ...
    @staticmethod
    def getKey_s() -> vtkInformationObjectBaseKey: 
        """
        Static method used by shape selection logic in order to establish a connection from vtkActor to OccShape instance.
        """
    pass
class IVtkTools_ShapePicker():
    """
    VTK picker for OCC shapes with OCC selection algorithm.
    """
    def GetNumberOfGenerationsFromBase(self,type : str) -> int: 
        """
        None
        """
    @staticmethod
    def GetNumberOfGenerationsFromBaseType_s(type : str) -> int: 
        """
        None
        """
    def GetPickedActors(self,theIsAll : bool=False) -> Any: 
        """
        Access to the list of actors picked.
        """
    def GetPickedShapesIds(self,theIsAll : bool=False) -> OCP.IVtk.IVtk_ShapeIdList: 
        """
        Access to the list of top-level shapes picked. If all argument is true, the picker returns the list of all OccShape objects found by the picking algorithm. e.g. all shapes under the mouse cursor. Otherwise, ID of the shape closest to the eye is returned.
        """
    def GetPickedSubShapesIds(self,theId : int,theIsAll : bool=False) -> OCP.IVtk.IVtk_ShapeIdList: 
        """
        Access to the list of sub-shapes ids picked.
        """
    @overload
    def GetSelectionModes(self,theShapeActor : vtkActor) -> OCP.IVtk.IVtk_SelectionModeList: 
        """
        Get activated selection modes for a shape.

        Get activated selection modes for a shape actor.
        """
    @overload
    def GetSelectionModes(self,theShape : OCP.IVtk.IVtk_IShape) -> OCP.IVtk.IVtk_SelectionModeList: ...
    def GetTolerance(self) -> float: 
        """
        Getter for tolerance of picking.
        """
    def IsA(self,type : str) -> int: 
        """
        None
        """
    @staticmethod
    def IsTypeOf_s(type : str) -> int: 
        """
        None
        """
    def NewInstance(self) -> IVtkTools_ShapePicker: 
        """
        None
        """
    @staticmethod
    def New_s() -> IVtkTools_ShapePicker: 
        """
        None
        """
    def RemoveSelectableActor(self,theShapeActor : vtkActor) -> None: 
        """
        Remove selectable object from the picker (from internal maps).
        """
    def RemoveSelectableObject(self,theShape : OCP.IVtk.IVtk_IShape) -> None: 
        """
        Remove selectable object from the picker (from internal maps).
        """
    @staticmethod
    def SafeDownCast_s(o : vtkObjectBase) -> IVtkTools_ShapePicker: 
        """
        None
        """
    def SetAreaSelection(self,theIsOn : bool) -> None: 
        """
        Sets area selection on/off
        """
    def SetRenderer(self,theRenderer : vtkRenderer) -> None: 
        """
        Sets the renderer to be used by OCCT selection algorithm
        """
    @overload
    def SetSelectionMode(self,theShapeActor : vtkActor,theMode : OCP.IVtk.IVtk_SelectionMode,theIsTurnOn : bool=True) -> None: 
        """
        Turn on/off a selection mode for a shape actor.

        Turn on/off a selection mode for a shape actor.

        Sets the current selection mode for all visible shape objects.
        """
    @overload
    def SetSelectionMode(self,theMode : OCP.IVtk.IVtk_SelectionMode,theIsTurnOn : bool=True) -> None: ...
    @overload
    def SetSelectionMode(self,theShape : OCP.IVtk.IVtk_IShape,theMode : OCP.IVtk.IVtk_SelectionMode,theIsTurnOn : bool=True) -> None: ...
    def SetTolerance(self,theTolerance : float) -> None: 
        """
        Setter for tolerance of picking.
        """
    pass
class IVtkTools_DisplayModeFilter(IVtkTools_SubPolyDataFilter):
    """
    Cells filter according to the selected display mode by mesh parts types. This filter is used to get parts of a shape according to different display modes.
    """
    @overload
    def AddData(self,theSet : OCP.IVtk.IVtk_IdTypeMap) -> None: 
        """
        Add ids to be passed through this filter.

        Add ids to be passed through this filter.
        """
    @overload
    def AddData(self,theIds : OCP.IVtk.IVtk_ShapeIdList) -> None: ...
    def Clear(self) -> None: 
        """
        Clear ids set to be passed through this filter.
        """
    def FaceBoundaryDraw(self) -> bool: 
        """
        Returns True if drawing Boundary of faces for shading mode is defined.
        """
    def GetDisplayMode(self) -> OCP.IVtk.IVtk_DisplayMode: 
        """
        Get current display mode.
        """
    def GetNumberOfGenerationsFromBase(self,type : str) -> int: 
        """
        None
        """
    @staticmethod
    def GetNumberOfGenerationsFromBaseType_s(type : str) -> int: 
        """
        None
        """
    def IsA(self,type : str) -> int: 
        """
        None
        """
    def IsSmoothShading(self) -> bool: 
        """
        Returns TRUE if vertex normals should be included for smooth shading within DM_Shading mode or not.
        """
    @staticmethod
    def IsTypeOf_s(type : str) -> int: 
        """
        None
        """
    def MeshTypesForMode(self,theMode : OCP.IVtk.IVtk_DisplayMode) -> OCP.IVtk.IVtk_IdTypeMap: 
        """
        Returns list of displaying mesh element types for the given display mode
        """
    def NewInstance(self) -> IVtkTools_DisplayModeFilter: 
        """
        None
        """
    @staticmethod
    def New_s() -> IVtkTools_DisplayModeFilter: 
        """
        None
        """
    @staticmethod
    def SafeDownCast_s(o : vtkObjectBase) -> IVtkTools_DisplayModeFilter: 
        """
        None
        """
    @overload
    def SetData(self,theSet : OCP.IVtk.IVtk_IdTypeMap) -> None: 
        """
        Set ids to be passed through this filter.

        Set ids to be passed through this filter.
        """
    @overload
    def SetData(self,theIds : OCP.IVtk.IVtk_ShapeIdList) -> None: ...
    def SetDisplayMode(self,aMode : OCP.IVtk.IVtk_DisplayMode) -> None: 
        """
        Set display mode to define cells types to be passed through this filter.
        """
    def SetDisplaySharedVertices(self,doDisplay : bool) -> None: 
        """
        Display or not shared vertices.
        """
    def SetDoFiltering(self,theDoFiltering : bool) -> None: 
        """
        None
        """
    def SetFaceBoundaryDraw(self,theToDraw : bool) -> None: 
        """
        Draw Boundary of faces for shading mode
        """
    def SetIdsArrayName(self,theArrayName : str) -> None: 
        """
        Set ids array name.
        """
    def SetMeshTypesForMode(self,theMode : OCP.IVtk.IVtk_DisplayMode,theMeshTypes : OCP.IVtk.IVtk_IdTypeMap) -> None: 
        """
        Set a list of displaying mesh element types for the given display mode
        """
    def SetSmoothShading(self,theIsSmooth : bool) -> None: 
        """
        Set if vertex normals should be included for smooth shading or not.
        """
    pass