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
|
"""Render passes module for PyVista."""
from __future__ import annotations
import weakref
from pyvista._deprecate_positional_args import _deprecate_positional_args
from pyvista.core.utilities.misc import _NoNewAttrMixin
from . import _vtk
# The order of both the pre and post-passes matters.
PRE_PASS = [
'vtkEDLShading',
]
POST_PASS = [
'vtkDepthOfFieldPass',
'vtkGaussianBlurPass',
'vtkOpenGLFXAAPass',
'vtkSSAOPass',
'vtkSSAAPass', # should be last
]
class RenderPasses(_NoNewAttrMixin):
"""Class to support multiple render passes for a renderer.
Notes
-----
Passes are organized here as "primary" (:vtk:`vtkOpenGLRenderPass`) that act
within the renderer and "post-processing" (:vtk:`vtkImageProcessingPass`) passes,
which act on the image generated from the renderer.
The primary passes are added as part of a :vtk:`vtkRenderPassCollection` or
are "stacked", while the post-processing passes are added as a final pass
to the rendered image.
Parameters
----------
renderer : :vtk:`vtkRenderer`
Renderer to initialize render passes for.
"""
def __init__(self, renderer):
"""Initialize render passes."""
self._renderer_ref = weakref.ref(renderer)
self._passes = {}
self._fxaa_pass = None
self._shadow_map_pass = None
self._edl_pass = None
self._dof_pass = None
self._ssaa_pass = None
self._ssao_pass = None
self._blur_passes = []
self.__pass_collection = None
self.__seq_pass = None
self.__camera_pass = None
@property
def _pass_collection(self):
"""Initialize (when necessary) the pass collection and return it.
This lets us lazily generate the pass collection only when we need it
rather than at initialization of the class.
"""
if self.__pass_collection is None:
self._init_passes()
return self.__pass_collection
@property
def _seq_pass(self):
"""Initialize (when necessary) the sequence collection and return it.
This lets us lazily generate the sequence collection only when we need it
rather than at initialization of the class.
"""
if self.__seq_pass is None:
self._init_passes()
return self.__seq_pass
@property
def _camera_pass(self):
"""Initialize (when necessary) the camera pass and return it.
This lets us lazily generate the camera pass only when we need it
rather than at initialization of the class.
"""
if self.__camera_pass is None:
self._init_passes()
return self.__camera_pass
def _init_passes(self):
"""Initialize the renderer's standard passes."""
# simulate the standard VTK rendering passes and put them in a sequence
self.__pass_collection = _vtk.vtkRenderPassCollection()
self.__pass_collection.AddItem(_vtk.vtkRenderStepsPass())
self.__seq_pass = _vtk.vtkSequencePass()
self.__seq_pass.SetPasses(self._pass_collection)
# Make the sequence the delegate of a camera pass.
self.__camera_pass = _vtk.vtkCameraPass()
self.__camera_pass.SetDelegatePass(self._seq_pass)
@property
def _renderer(self):
"""Return the renderer."""
if self._renderer_ref is not None:
return self._renderer_ref()
return None # type: ignore[unreachable]
def deep_clean(self):
"""Delete all render passes."""
if self._renderer is not None:
self._renderer.SetPass(None)
self._renderer_ref = None # type: ignore[assignment]
if self.__seq_pass is not None:
self.__seq_pass.SetPasses(None)
self.__seq_pass = None
self.__pass_collection = None
self.__camera_pass = None
self._passes = {}
self._shadow_map_pass = None
self._edl_pass = None
self._dof_pass = None
self._ssaa_pass = None
self._ssao_pass = None
self._blur_passes = []
def enable_edl_pass(self):
"""Enable the EDL pass.
Returns
-------
:vtk:`vtkEDLShading`
The enabled EDL pass.
"""
if self._edl_pass is not None:
return None
self._edl_pass = _vtk.vtkEDLShading()
self._add_pass(self._edl_pass)
return self._edl_pass
def disable_edl_pass(self):
"""Disable the EDL pass."""
if self._edl_pass is None:
return
self._remove_pass(self._edl_pass)
self._edl_pass = None
def add_blur_pass(self):
"""Add a :vtk:`vtkGaussianBlurPass` pass.
This is a :vtk:`vtkImageProcessingPass` and delegates to the last pass.
Returns
-------
:vtk:`vtkGaussianBlurPass`
The added Gaussian blur pass.
"""
blur_pass = _vtk.vtkGaussianBlurPass()
self._add_pass(blur_pass)
self._blur_passes.append(blur_pass)
return blur_pass
def remove_blur_pass(self):
"""Remove a single :vtk:`vtkGaussianBlurPass` pass."""
if self._blur_passes:
# order of the blur passes does not matter
self._remove_pass(self._blur_passes.pop())
def enable_shadow_pass(self):
"""Enable shadow pass.
Returns
-------
:vtk:`vtkShadowMapPass`
The enabled shadow pass.
"""
# shadow pass can be directly added to the base pass collection
if self._shadow_map_pass is not None:
return None
self._shadow_map_pass = _vtk.vtkShadowMapPass()
self._pass_collection.AddItem(self._shadow_map_pass.GetShadowMapBakerPass())
self._pass_collection.AddItem(self._shadow_map_pass)
self._update_passes()
return self._shadow_map_pass
def disable_shadow_pass(self):
"""Disable shadow pass."""
if self._shadow_map_pass is None:
return
self._pass_collection.RemoveItem(self._shadow_map_pass.GetShadowMapBakerPass())
self._pass_collection.RemoveItem(self._shadow_map_pass)
self._update_passes()
@_deprecate_positional_args
def enable_depth_of_field_pass(self, automatic_focal_distance: bool = True): # noqa: FBT001, FBT002
"""Enable the depth of field pass.
Parameters
----------
automatic_focal_distance : bool, default: True
If ``True``, the depth of field effect will automatically compute
the focal distance. If ``False``, the user must specify the distance.
Returns
-------
:vtk:`vtkDepthOfFieldPass`
The enabled depth of field pass.
"""
if self._dof_pass is not None:
return None
if self._ssao_pass is not None:
msg = 'Depth of field pass is incompatible with the SSAO pass.'
raise RuntimeError(msg)
self._dof_pass = _vtk.vtkDepthOfFieldPass()
self._dof_pass.SetAutomaticFocalDistance(automatic_focal_distance)
self._add_pass(self._dof_pass)
return self._dof_pass
def disable_depth_of_field_pass(self):
"""Disable the depth of field pass."""
if self._dof_pass is None:
return
self._remove_pass(self._dof_pass)
self._dof_pass = None
@_deprecate_positional_args
def enable_ssao_pass( # noqa: PLR0917
self, radius, bias, kernel_size, blur
):
"""Enable the screen space ambient occlusion pass.
Parameters
----------
radius : float
Radius of occlusion generation.
bias : float
Bias to adjust the occlusion generation.
kernel_size : int
Size of the kernel for occlusion generation.
blur : bool
If ``True``, the pass uses a blur stage.
Returns
-------
:vtk:`vtkSSAOPass`
The enabled screen space ambient occlusion pass.
"""
if self._dof_pass is not None:
msg = 'SSAO pass is incompatible with the depth of field pass.'
raise RuntimeError(msg)
if self._ssao_pass is not None:
return None
self._ssao_pass = _vtk.vtkSSAOPass()
self._ssao_pass.SetRadius(radius)
self._ssao_pass.SetBias(bias)
self._ssao_pass.SetKernelSize(kernel_size)
self._ssao_pass.SetBlur(blur)
self._add_pass(self._ssao_pass)
return self._ssao_pass
def disable_ssao_pass(self):
"""Disable the screen space ambient occlusion pass."""
if self._ssao_pass is None:
return
self._remove_pass(self._ssao_pass)
self._ssao_pass = None
def enable_ssaa_pass(self):
"""Enable super-sample anti-aliasing pass.
Returns
-------
:vtk:`vtkSSAAPass`
The enabled super-sample anti-aliasing pass.
"""
if self._ssaa_pass is not None:
return None
self._ssaa_pass = _vtk.vtkSSAAPass()
self._add_pass(self._ssaa_pass)
return self._ssaa_pass
def disable_ssaa_pass(self):
"""Disable super-sample anti-aliasing pass."""
if self._ssaa_pass is None:
return
self._remove_pass(self._ssaa_pass)
self._ssaa_pass = None
def _update_passes(self):
"""Reassemble pass delegation."""
if hasattr(self._renderer, '_closed') and self._renderer._closed:
msg = 'The renderer has been closed.'
raise RuntimeError(msg)
current_pass = self._camera_pass
for class_name in PRE_PASS + POST_PASS:
if class_name in self._passes:
for render_pass in self._passes[class_name]:
render_pass.SetDelegatePass(current_pass)
current_pass = render_pass
# reset to the default rendering if no special passes have been added
if current_pass is self._camera_pass and self._shadow_map_pass is None:
self._renderer.SetPass(None)
else:
self._renderer.SetPass(current_pass)
def _add_pass(self, render_pass):
"""Add a render pass."""
class_name = render_pass.GetClassName()
if class_name in PRE_PASS and render_pass in self._passes:
return
if class_name not in self._passes:
self._passes[class_name] = [render_pass]
else:
self._passes[class_name].append(render_pass)
self._update_passes()
def _remove_pass(self, render_pass):
"""Remove a pass.
Remove a pass and reassemble the pass ordering.
"""
class_name = render_pass.GetClassName()
if class_name not in self._passes: # pragma: no cover
return
else:
self._passes[class_name].remove(render_pass)
if not self._passes[class_name]:
self._passes.pop(class_name)
self._update_passes()
|
