pyvista.examples.downloads.download_room_surface_mesh#

download_room_surface_mesh(load=True)[source]#

Download the room surface mesh.

This mesh is for demonstrating the difference that depth peeling can provide when rendering translucent geometries.

This mesh is courtesy of Sam Potter.

Parameters:
loadbool, default: True

Load the dataset after downloading it when True. Set this to False and only the filename will be returned.

Returns:
pyvista.PolyData | str

DataSet or filename depending on load.

Examples

>>> from pyvista import examples
>>> dataset = examples.download_room_surface_mesh()
>>> dataset.plot()
../../../_images/pyvista-examples-downloads-download_room_surface_mesh-1_00_00.png

See Depth Peeling for an example using this dataset.