| 1 |
"""Wrapper mapping. |
| 2 |
|
| 3 |
Setting ``pyvista._wrappers`` allows for developers to override the default class used |
| 4 |
to coerce a :vtk:`vtkDataSet` into a pyvista object. This is useful when creating a |
| 5 |
subclass of a :class:`pyvista.DataSet` class. |
| 6 |
|
| 7 |
Examples |
| 8 |
-------- |
| 9 |
A user-defined Foo class is defined that extends the functionality of |
| 10 |
:class:`pyvista.PolyData`. This class is set as the default wrapper for |
| 11 |
:vtk:`vtkPolyData` objects. |
| 12 |
|
| 13 |
>>> import pyvista as pv |
| 14 |
>>> default_wrappers = pv._wrappers.copy() |
| 15 |
>>> class Foo(pv.PolyData): |
| 16 |
... pass # Extend PolyData here |
| 17 |
>>> pv._wrappers['vtkPolyData'] = Foo |
| 18 |
>>> image = pv.ImageData() |
| 19 |
>>> surface = image.extract_surface(algorithm=None) |
| 20 |
>>> assert isinstance(surface, Foo) |
| 21 |
>>> pv._wrappers = default_wrappers # reset back to default |
| 22 |
|
| 23 |
""" |
| 24 |
|
| 25 |
from __future__ import annotations |
| 26 |
|
| 27 |
from typing import TypeVar |
| 28 |
|
| 29 |
from pyvista import _vtk |
| 30 |
|
| 31 |
from .composite import MultiBlock |
| 32 |
from .grid import ImageData |
| 33 |
from .grid import RectilinearGrid |
| 34 |
from .objects import Table |
| 35 |
from .partitioned import PartitionedDataSet |
| 36 |
from .pointset import ExplicitStructuredGrid |
| 37 |
from .pointset import PointSet |
| 38 |
from .pointset import PolyData |
| 39 |
from .pointset import StructuredGrid |
| 40 |
from .pointset import UnstructuredGrid |
| 41 |
|
| 42 |
_wrappers = { |
| 43 |
'vtkExplicitStructuredGrid': ExplicitStructuredGrid, |
| 44 |
'vtkUnstructuredGrid': UnstructuredGrid, |
| 45 |
'vtkRectilinearGrid': RectilinearGrid, |
| 46 |
'vtkStructuredGrid': StructuredGrid, |
| 47 |
'vtkPolyData': PolyData, |
| 48 |
'vtkImageData': ImageData, |
| 49 |
'vtkStructuredPoints': ImageData, |
| 50 |
'vtkMultiBlockDataSet': MultiBlock, |
| 51 |
'vtkTable': Table, |
| 52 |
'vtkPointSet': PointSet, |
| 53 |
'vtkPartitionedDataSet': PartitionedDataSet, |
| 54 |
# 'vtkParametricSpline': pyvista.Spline, |
| 55 |
} |
| 56 |
|
| 57 |
_WrappableVTKDataObjectType = TypeVar( # noqa: PYI018 |
| 58 |
'_WrappableVTKDataObjectType', |
| 59 |
_vtk.vtkExplicitStructuredGrid, |
| 60 |
_vtk.vtkUnstructuredGrid, |
| 61 |
_vtk.vtkRectilinearGrid, |
| 62 |
_vtk.vtkStructuredGrid, |
| 63 |
_vtk.vtkPolyData, |
| 64 |
_vtk.vtkImageData, |
| 65 |
_vtk.vtkStructuredPoints, |
| 66 |
_vtk.vtkMultiBlockDataSet, |
| 67 |
_vtk.vtkTable, |
| 68 |
_vtk.vtkPoints, |
| 69 |
_vtk.vtkPartitionedDataSet, |
| 70 |
) |