pyvista.Renderer

class Renderer(*args, **kwargs)

Renderer class.

Methods

Renderer.add_actor(actor[, reset_camera, ...])	Add an actor to render window.
Renderer.add_axes([interactive, line_width, ...])	Add an interactive axes widget in the bottom left corner.
Renderer.add_axes_at_origin([x_color, ...])	Add axes actor at origin.
Renderer.add_blurring()	Add blurring.
Renderer.add_border([color, width])	Add borders around the frame.
Renderer.add_bounding_box([color, ...])	Add an unlabeled and unticked box at the boundaries of plot.
Renderer.add_box_axes(*[, interactive, ...])	Add an interactive color box axes widget in the bottom left corner.
Renderer.add_chart(chart, *charts)	Add a chart to this renderer.
Renderer.add_floor([face, i_resolution, ...])	Show a floor mesh.
Renderer.add_legend([labels, bcolor, ...])	Add a legend to render window.
Renderer.add_legend_scale([...])	Annotate the render window with scale and distance information.
Renderer.add_light(light)	Add a light to the renderer.
Renderer.add_north_arrow_widget([...])	Add a geographic north arrow to the scene.
Renderer.add_orientation_widget(actor[, ...])	Use the given actor in an orientation marker widget.
Renderer.add_ruler(pointa, pointb[, ...])	Add ruler.
Renderer.clear()	Remove all actors and properties.
Renderer.clear_actors()	Remove all actors (keep lights and properties).
Renderer.close()	Close out widgets and sensitive elements.
Renderer.compute_bounds(*[, ...])	Return the bounds of actors present in the renderer.
Renderer.deep_clean([render])	Clean the renderer of the memory.
Renderer.disable()	Disable this renderer's camera from being interactive.
Renderer.disable_anti_aliasing()	Disable all anti-aliasing.
Renderer.disable_depth_of_field()	Disable depth of field plotting.
Renderer.disable_depth_peeling()	Disable depth peeling.
Renderer.disable_eye_dome_lighting()	Disable eye dome lighting (EDL).
Renderer.disable_hidden_line_removal()	Disable hidden line removal.
Renderer.disable_parallel_projection()	Reset the camera to use perspective projection.
Renderer.disable_shadows()	Disable shadows.
Renderer.disable_ssao()	Disable surface space ambient occlusion (SSAO).
Renderer.enable()	Enable this renderer's camera to be interactive.
Renderer.enable_anti_aliasing([aa_type])	Enable anti-aliasing.
Renderer.enable_depth_of_field([...])	Enable depth of field plotting.
Renderer.enable_depth_peeling([...])	Enable depth peeling to improve rendering of translucent geometry.
Renderer.enable_eye_dome_lighting()	Enable eye dome lighting (EDL).
Renderer.enable_hidden_line_removal()	Enable hidden line removal.
Renderer.enable_parallel_projection()	Enable parallel projection.
Renderer.enable_shadows()	Enable shadows.
Renderer.enable_ssao([radius, bias, ...])	Enable surface space ambient occlusion (SSAO).
Renderer.get_charts()	Return a list of all charts in this renderer.
Renderer.get_default_cam_pos([negative])	Return the default focal points and viewup.
Renderer.get_pick_position()	Get the pick position/area as x0, y0, x1, y1.
Renderer.hide_axes()	Hide the axes orientation widget.
Renderer.isometric_view()	Reset the camera to a default isometric view.
Renderer.on_plotter_render()	Notify renderer components of explicit plotter render call.
Renderer.remove_actor(actor[, reset_camera, ...])	Remove an actor from the Renderer.
Renderer.remove_all_lights()	Remove all lights from the renderer.
Renderer.remove_blurring()	Remove a single blurring pass.
Renderer.remove_bounding_box([render])	Remove bounding box.
Renderer.remove_bounds_axes()	Remove bounds axes.
Renderer.remove_chart(chart_or_index)	Remove a chart from this renderer.
Renderer.remove_environment_texture()	Remove the environment texture.
Renderer.remove_floors([clear_kwargs, render])	Remove all floor actors.
Renderer.remove_legend([render])	Remove the legend actor.
Renderer.reset_camera([render, bounds])	Reset the camera of the active render window.
Renderer.reset_camera_clipping_range()	Reset the camera clipping range based on the bounds of the visible actors.
Renderer.set_background(color[, top, right, ...])	Set the background color of this renderer.
Renderer.set_chart_interaction(interactive)	Set or toggle interaction with charts for this renderer.
Renderer.set_color_cycler(color_cycler)	Set or reset this renderer's color cycler.
Renderer.set_environment_texture(texture[, ...])	Set the environment texture used for image based lighting.
Renderer.set_focus(point)	Set focus to a point.
Renderer.set_position(point[, reset, render])	Set camera position to a point.
Renderer.set_scale([xscale, yscale, zscale, ...])	Scale all the actors in the scene.
Renderer.set_viewup(vector[, reset, render])	Set camera viewup vector.
Renderer.show_axes()	Show the axes orientation widget.
Renderer.show_bounds([mesh, bounds, ...])	Add bounds axes.
Renderer.show_grid(**kwargs)	Show grid lines and bounds axes labels.
Renderer.update_bounds_axes()	Update the bounds axes of the render window.
Renderer.view_isometric([negative, render, ...])	Reset the camera to a default isometric view.
Renderer.view_vector(vector[, viewup, ...])	Point the camera in the direction of the given vector.
Renderer.view_xy([negative, render, bounds])	View the XY plane.
Renderer.view_xz([negative, render, bounds])	View the XZ plane.
Renderer.view_yx([negative, render, bounds])	View the YX plane.
Renderer.view_yz([negative, render, bounds])	View the YZ plane.
Renderer.view_zx([negative, render, bounds])	View the ZX plane.
Renderer.view_zy([negative, render, bounds])	View the ZY plane.

Attributes

Renderer.actors	Return a dictionary of actors assigned to this renderer.
Renderer.axes_enabled	Return True when the axes widget is enabled.
Renderer.background_color	Return the background color of this renderer.
Renderer.border_color	Return the border color.
Renderer.border_width	Return the border width.
Renderer.bounds	Return the bounds of all VISIBLE actors present in the rendering window.
Renderer.camera	Return the active camera for the rendering scene.
Renderer.camera_position	Return or set the camera position of active render window.
Renderer.camera_set	Get or set whether this camera has been configured.
Renderer.center	Return the center of the bounding box around all data present in the scene.
Renderer.has_border	Return if the renderer has a border.
Renderer.has_charts	Return whether this renderer has charts.
Renderer.height	Height of the renderer.
Renderer.layer	Return or set the current layer of this renderer.
Renderer.legend	Legend actor.
Renderer.length	Return the length of the diagonal of the bounding box of the scene.
Renderer.lights	Return a list of all lights in the renderer.
Renderer.next_color	Return next color from this renderer's color cycler.
Renderer.parallel_projection	Return parallel projection state of active render window.
Renderer.parallel_scale	Return parallel scale of active render window.
Renderer.viewport	Viewport of the renderer.
Renderer.width	Width of the renderer.