Plotter#
- class Plotter(*args, **kwargs)[source]#
Plotting object to display VTK meshes or NumPy arrays.
- Parameters:
- off_screenbool,
optional Renders off screen when
True. Useful for automated screenshots.- notebookbool,
optional When
True, the resulting plot is placed inline a jupyter notebook. Assumes a jupyter console is active. Automatically enablesoff_screen.- shapesequence[
int],optional Number of sub-render windows inside of the main window. Specify two across with
shape=(2, 1)and a two by two grid withshape=(2, 2). By default there is only one render window. Can also accept a string descriptor as shape. E.g.:shape="3|1"means 3 plots on the left and 1 on the right,shape="4/2"means 4 plots on top and 2 at the bottom.
- groups
list,optional A list of sequences that defines the grouping of the subplots. Each group is given as
(rows, cols), where each entry is a row/column index or aslice, and the group spans from the smallest to the largest index it covers. The subplots in a group are merged into a single renderer. Groups may not overlap. See Multi-Window Plot for a full example.- row_weightssequence[
float],optional The relative heights of the rows, used to size the subplots when the plot window is resized. Must have one entry per row. Defaults to equal weights.
- col_weightssequence[
float],optional The relative widths of the columns, used to size the subplots when the plot window is resized. Must have one entry per column. Defaults to equal weights.
- borderbool | ‘interior’ | ‘exterior’,
optional Draw a border around the plotting area.
Truedraws both an outer frame and lines between subplots;Falsedraws neither.'interior'draws only the lines between subplots, and'exterior'only the outer frame. For a single subplot, there are no neighbors to separate, so'interior'has no effect and'exterior'draws the same thing asTrue. Defaults toFalsefor a single subplot and'interior'for more than one.Changed in version 0.49: Previously a plain
boolthat, whenTrue, drew a border around every individual subplot rather than the plotting area as a whole, and defaulted toTruefor more than one subplot.- border_color
ColorLike,optional Color of the border and/or subplot seams. Defaults to
pyvista.global_theme.border_color. Accepts a string, rgb list, or hex color string. For example:color='white'color='w'color=[1.0, 1.0, 1.0]color='#FFFFFF'
- border_width
float,optional Width of the border and/or subplot seams in pixels, when enabled. Defaults to
pyvista.global_theme.border_width.- window_sizesequence[
int],optional Window size in pixels. Defaults to
[1024, 768], unless set differently in the relevant theme’swindow_sizeproperty.- line_smoothingbool, default:
False If
True, enable line smoothing.- point_smoothingbool, default:
False If
True, enable point smoothing.- polygon_smoothingbool, default:
False If
True, enable polygon smoothing.- splitting_position
float,optional The position, between
0and1, at which to place the splitting line between plots whenshapeis given as a string descriptor such as"3|1". Defaults topyvista.global_theme.multi_rendering_splitting_position.- title
str,optional Title of the plotting window. Defaults to
pyvista.global_theme.title.- lighting
str, default: ‘light kit” Lighting to set up for the plotter. Accepted options:
'light kit': a vtk Light Kit composed of 5 lights.'three lights': illumination using 3 lights.'none': no light sources at instantiation.
The default is a
'light kit'(to be precise, 5 separate lights that act like a Light Kit).- theme
pyvista.plotting.themes.Theme|str,optional Plot-specific theme. Accepts a
Themeinstance or a registered theme name (for example,'dark'); seeregistered_themes().- image_scale
int,optional Scale factor when saving screenshots. Image sizes will be the
window_sizemultiplied by this scale factor.- stereo
StereoType| bool,optional Enable stereo rendering. If True, defaults to Anaglyph.
- off_screenbool,
Examples#
Download Python source code | Download Jupyter notebook
>>> import pyvista as pv
>>> mesh = pv.Cube()
>>> another_mesh = pv.Sphere()
>>> pl = pv.Plotter()
>>> actor = pl.add_mesh(mesh, color='red', style='wireframe', line_width=4)
>>> actor = pl.add_mesh(another_mesh, color='blue')
>>> pl.show()
See Also#
Used In#
Guides
- What Is a Mesh? (5 uses)
- PyVista Data Model (4 uses)
- Lights (2 uses)
- Basic API Usage (1 use)
- Cameras (1 use)
- Transitioning From VTK to PyVista (1 use)
- Why PyVista? (1 use)
Docstring Examples
Plotter.enable_camera_distortion(2 uses)Actor(1 use)Actor.add_shader_replacement(1 use)Actor.backface_prop(1 use)Actor.clear_point_sprite_shape(1 use)416 more
Actor.clear_shader_replacements(1 use)Actor.copy(1 use)Actor.disable_maximum_intensity_projection(1 use)Actor.enable_maximum_intensity_projection(1 use)Actor.force_opaque(1 use)Actor.pickable(1 use)Actor.prop(1 use)Actor.set_point_sprite_shape(1 use)Actor.texture(1 use)Actor.use_bounds(1 use)Actor.visibility(1 use)AffineWidget3D(1 use)AxesActor(1 use)AxesAssembly(1 use)AxesAssembly.scale(1 use)AxesAssembly.user_matrix(1 use)AxesAssemblySymmetric(1 use)AxesGeometrySource.symmetric_bounds(1 use)BlockAttributes(1 use)BlockAttributes.color(1 use)BlockAttributes.opacity(1 use)BlockAttributes.pickable(1 use)BlockAttributes.visible(1 use)Camera(1 use)Camera.azimuth(1 use)Camera.clipping_range(1 use)Camera.distance(1 use)Camera.elevation(1 use)Camera.focal_point(1 use)Camera.model_transform_matrix(1 use)Camera.parallel_projection(1 use)Camera.parallel_scale(1 use)Camera.position(1 use)Camera.roll(1 use)Camera.thickness(1 use)Camera.tight(1 use)Camera.up(1 use)Camera.view_angle(1 use)Camera.view_frustum(1 use)Camera.zoom(1 use)CameraPosition.to_list(1 use)CircularArc(1 use)CircularArcFromNormal(1 use)CompositeAttributes(1 use)CompositeAttributes.get_block(1 use)CompositeAttributes.reset_colors(1 use)CompositeAttributes.reset_opacities(1 use)CompositeAttributes.reset_pickabilities(1 use)CompositeAttributes.reset_visibilities(1 use)CompositePolyDataMapper.block_attr(1 use)CompositePolyDataMapper.color_missing_with_nan(1 use)CompositePolyDataMapper.dataset(1 use)CompositePolyDataMapper.set_unique_colors(1 use)CubeAxesActor(1 use)CubeFacesSource(1 use)Cylinder(1 use)CylinderSource(1 use)DataObjectFilters.cell_centers(1 use)DataObjectFilters.cell_validator(1 use)DataObjectFilters.convex_hull(1 use)DataObjectFilters.flip_normal(1 use)DataObjectFilters.flip_x(1 use)DataObjectFilters.flip_y(1 use)DataObjectFilters.flip_z(1 use)DataObjectFilters.rotate(1 use)DataObjectFilters.rotate_vector(1 use)DataObjectFilters.rotate_x(1 use)DataObjectFilters.rotate_y(1 use)DataObjectFilters.rotate_z(1 use)DataObjectFilters.scale(1 use)DataObjectFilters.slice_along_line(1 use)DataSet.arrows(1 use)DataSet.bounding_sphere(1 use)DataSet.cell_neighbors(1 use)DataSet.cell_neighbors_levels(1 use)DataSet.point_cell_ids(1 use)DataSet.point_neighbors(1 use)DataSet.point_neighbors_levels(1 use)DataSetFilters.align(1 use)DataSetFilters.align_xyz(1 use)DataSetFilters.bounding_box(1 use)DataSetFilters.color_labels(1 use)DataSetFilters.compute_boundary_mesh_quality(1 use)DataSetFilters.compute_implicit_distance(1 use)DataSetFilters.connectivity(1 use)DataSetFilters.extract_cells(1 use)DataSetFilters.extract_cells_by_type(1 use)DataSetFilters.extract_values(1 use)DataSetFilters.glyph(1 use)DataSetFilters.interpolate(1 use)DataSetFilters.oriented_bounding_box(1 use)DataSetFilters.sample_over_circular_arc(1 use)DataSetFilters.sample_over_circular_arc_normal(1 use)DataSetFilters.sample_over_line(1 use)DataSetFilters.sample_over_multiple_lines(1 use)DataSetFilters.select_interior_points(1 use)DataSetFilters.split_values(1 use)DataSetFilters.streamlines_evenly_spaced_2D(1 use)DataSetFilters.voxelize_binary_mask(1 use)DataSetFilters.voxelize_rectilinear(1 use)DataSetFilters.warp_by_vector(1 use)ExplicitStructuredGrid.neighbors(1 use)Follower(1 use)Icosphere(1 use)ImageData.origin(1 use)ImageDataFilters.contour_labels(1 use)ImageDataFilters.crop(1 use)ImageDataFilters.dilate(1 use)ImageDataFilters.erode(1 use)ImageDataFilters.label_connectivity(1 use)ImageDataFilters.pad_image(1 use)ImageDataFilters.resample(1 use)ImageDataFilters.select_values(1 use)Label(1 use)Light.attenuation_values(1 use)Light.cone_angle(1 use)Light.exponent(1 use)Light.intensity(1 use)Light.is_camera_light(1 use)Light.is_headlight(1 use)Light.is_scene_light(1 use)Light.light_type(1 use)Light.show_actor(1 use)LookupTable.apply_opacity(1 use)MultipleLines(1 use)OrthogonalPlanesSource(1 use)PickingComponent.disable_picking(1 use)PickingComponent.enable_block_picking(1 use)PickingComponent.enable_cell_picking(1 use)PickingComponent.enable_mesh_picking(1 use)PickingComponent.enable_point_picking(1 use)PickingComponent.enable_rectangle_picking(1 use)PickingComponent.enable_surface_point_picking(1 use)PlanesAssembly(1 use)PlanesAssembly.label_edge(1 use)PlanesAssembly.label_position(1 use)Plotter.add_affine_transform_widget(1 use)Plotter.add_arrows(1 use)Plotter.add_axes(1 use)Plotter.add_axes_at_origin(1 use)Plotter.add_background_image(1 use)Plotter.add_blurring(1 use)Plotter.add_bounding_box(1 use)Plotter.add_box_axes(1 use)Plotter.add_box_widget(1 use)Plotter.add_camera3d_widget(1 use)Plotter.add_camera_orientation_widget(1 use)Plotter.add_chart(1 use)Plotter.add_checkbox_button_widget(1 use)Plotter.add_composite(1 use)Plotter.add_cursor(1 use)Plotter.add_floor(1 use)Plotter.add_legend(1 use)Plotter.add_legend_scale(1 use)Plotter.add_light(1 use)Plotter.add_line_widget(1 use)Plotter.add_lines(1 use)Plotter.add_logo_widget(1 use)Plotter.add_mesh(1 use)Plotter.add_mesh_clip_box(1 use)Plotter.add_mesh_clip_plane(1 use)Plotter.add_mesh_isovalue(1 use)Plotter.add_mesh_slice(1 use)Plotter.add_mesh_slice_orthogonal(1 use)Plotter.add_north_arrow_widget(1 use)Plotter.add_orientation_widget(1 use)Plotter.add_plane_widget(1 use)Plotter.add_point_labels(1 use)Plotter.add_point_scalar_labels(1 use)Plotter.add_points(1 use)Plotter.add_radio_button_widget(1 use)Plotter.add_ruler(1 use)Plotter.add_scalar_bar(1 use)Plotter.add_silhouette(1 use)Plotter.add_slider_widget(1 use)Plotter.add_text(1 use)Plotter.add_timer_event(1 use)Plotter.add_title(1 use)Plotter.add_volume(1 use)Plotter.background_color(1 use)Plotter.bounds(1 use)Plotter.camera_position(1 use)Plotter.center(1 use)Plotter.clear(1 use)Plotter.disable_anti_aliasing(1 use)Plotter.disable_camera_distortion(1 use)Plotter.disable_depth_of_field(1 use)Plotter.disable_eye_dome_lighting(1 use)Plotter.disable_hidden_line_removal(1 use)Plotter.disable_picking(1 use)Plotter.disable_shadows(1 use)Plotter.disable_stereo_render(1 use)Plotter.enable_anti_aliasing(1 use)Plotter.enable_block_picking(1 use)Plotter.enable_cell_picking(1 use)Plotter.enable_depth_of_field(1 use)Plotter.enable_eye_dome_lighting(1 use)Plotter.enable_hidden_line_removal(1 use)Plotter.enable_interactor_style(1 use)Plotter.enable_lightkit(1 use)Plotter.enable_mesh_picking(1 use)Plotter.enable_point_picking(1 use)Plotter.enable_rectangle_picking(1 use)Plotter.enable_shadows(1 use)Plotter.enable_ssao(1 use)Plotter.enable_stereo_render(1 use)Plotter.enable_surface_point_picking(1 use)Plotter.generate_orbital_path(1 use)Plotter.get_image_depth(1 use)Plotter.hide_axes(1 use)Plotter.image(1 use)Plotter.import_3ds(1 use)Plotter.import_obj(1 use)Plotter.increment_point_size_and_line_width(1 use)Plotter.link_views(1 use)Plotter.orbit_on_path(1 use)Plotter.pickable_actors(1 use)Plotter.remove_actor(1 use)Plotter.remove_all_lights(1 use)Plotter.remove_background_image(1 use)Plotter.remove_blurring(1 use)Plotter.remove_bounding_box(1 use)Plotter.remove_bounds_axes(1 use)Plotter.remove_chart(1 use)Plotter.remove_environment_texture(1 use)Plotter.remove_floors(1 use)Plotter.remove_legend(1 use)Plotter.remove_scalar_bar(1 use)Plotter.renderer(1 use)Plotter.reset_camera(1 use)Plotter.reset_camera_clipping_range(1 use)Plotter.set_background(1 use)Plotter.set_color_cycler(1 use)Plotter.set_environment_texture(1 use)Plotter.set_focus(1 use)Plotter.set_position(1 use)Plotter.set_scale(1 use)Plotter.shape(1 use)Plotter.show(1 use)Plotter.show_axes(1 use)Plotter.show_axes_all(1 use)Plotter.show_bounds(1 use)Plotter.show_grid(1 use)Plotter.subplot(1 use)Plotter.theme(1 use)Plotter.view_xy(1 use)Plotter.view_xz(1 use)Plotter.view_yx(1 use)Plotter.view_yz(1 use)Plotter.view_zx(1 use)Plotter.view_zy(1 use)Plotter.where_is(1 use)Plotter.window_size(1 use)PointGaussianMapper.scale_array(1 use)PolyData(1 use)PolyDataFilters.boolean_difference(1 use)PolyDataFilters.boolean_intersection(1 use)PolyDataFilters.boolean_union(1 use)PolyDataFilters.collision(1 use)PolyDataFilters.contour_banded(1 use)PolyDataFilters.decimate_polyline(1 use)PolyDataFilters.geodesic(1 use)PolyDataFilters.intersection(1 use)PolyDataFilters.project_points_to_plane(1 use)PolyDataFilters.reconstruct_surface(1 use)PolyDataFilters.ruled_surface(1 use)PolyDataFilters.triangulate_contours(1 use)Prop3D.bounds(1 use)Prop3D.length(1 use)Prop3D.orientation(1 use)Prop3D.position(1 use)Prop3D.rotate_x(1 use)Prop3D.rotate_y(1 use)Prop3D.rotate_z(1 use)Prop3D.rotation_from(1 use)Prop3D.scale(1 use)Prop3D.user_matrix(1 use)Property(1 use)RenderWindowInteractor.add_observer(1 use)RenderWindowInteractor.add_timer_event(1 use)RenderWindowInteractor.enable_interactor_style(1 use)RenderWindowInteractor.remove_observer(1 use)RenderWindowInteractor.remove_observers(1 use)RenderWindowInteractor.style(1 use)Renderer.add_axes(1 use)Renderer.add_axes_at_origin(1 use)Renderer.add_blurring(1 use)Renderer.add_bounding_box(1 use)Renderer.add_box_axes(1 use)Renderer.add_chart(1 use)Renderer.add_floor(1 use)Renderer.add_legend(1 use)Renderer.add_legend_scale(1 use)Renderer.add_north_arrow_widget(1 use)Renderer.add_orientation_widget(1 use)Renderer.add_ruler(1 use)Renderer.axes_enabled(1 use)Renderer.disable_depth_of_field(1 use)Renderer.disable_eye_dome_lighting(1 use)Renderer.disable_shadows(1 use)Renderer.enable_depth_of_field(1 use)Renderer.enable_eye_dome_lighting(1 use)Renderer.enable_shadows(1 use)Renderer.enable_ssao(1 use)Renderer.get_charts(1 use)Renderer.hide_axes(1 use)Renderer.parallel_projection(1 use)Renderer.parallel_scale(1 use)Renderer.remove_actor(1 use)Renderer.remove_blurring(1 use)Renderer.remove_bounding_box(1 use)Renderer.remove_bounds_axes(1 use)Renderer.remove_chart(1 use)Renderer.remove_environment_texture(1 use)Renderer.remove_floors(1 use)Renderer.remove_legend(1 use)Renderer.reset_camera(1 use)Renderer.set_background(1 use)Renderer.set_color_cycler(1 use)Renderer.set_environment_texture(1 use)Renderer.set_focus(1 use)Renderer.set_position(1 use)Renderer.set_scale(1 use)Renderer.show_axes(1 use)Renderer.show_bounds(1 use)Renderer.show_grid(1 use)Renderer.view_xy(1 use)Renderer.view_xz(1 use)Renderer.view_yx(1 use)Renderer.view_yz(1 use)Renderer.view_zx(1 use)Renderer.view_zy(1 use)Renderer.viewport(1 use)Texture.repeat(1 use)Texture.wrap(1 use)Theme.allow_empty_mesh(1 use)Theme.color_cycler(1 use)Theme.interpolate_before_map(1 use)Theme.logo_file(1 use)Transform(1 use)UnstructuredGridFilters.clean(1 use)UnstructuredGridFilters.reconstruct_surface(1 use)Volume.copy(1 use)Volume.mapper(1 use)Volume.prop(1 use)VolumeProperty(1 use)VolumeProperty.apply_lookup_table(1 use)VolumeProperty.interpolation_type(1 use)WidgetComponent.add_affine_transform_widget(1 use)WidgetComponent.add_box_widget(1 use)WidgetComponent.add_camera3d_widget(1 use)WidgetComponent.add_camera_orientation_widget(1 use)WidgetComponent.add_checkbox_button_widget(1 use)WidgetComponent.add_line_widget(1 use)WidgetComponent.add_logo_widget(1 use)WidgetComponent.add_mesh_clip_box(1 use)WidgetComponent.add_mesh_clip_plane(1 use)WidgetComponent.add_mesh_isovalue(1 use)WidgetComponent.add_mesh_slice(1 use)WidgetComponent.add_mesh_slice_orthogonal(1 use)WidgetComponent.add_plane_widget(1 use)WidgetComponent.add_radio_button_widget(1 use)WidgetComponent.add_slider_widget(1 use)_BaseDataSetMapper.resolve(1 use)_BaseMapper.array_name(1 use)_BaseMapper.interpolate_before_map(1 use)_BaseMapper.scalar_map_mode(1 use)_BaseMapper.scalar_range(1 use)_BaseMapper.scalar_visibility(1 use)_Prop3DMixin.bounds(1 use)_Prop3DMixin.length(1 use)_Prop3DMixin.orientation(1 use)_Prop3DMixin.position(1 use)_Prop3DMixin.scale(1 use)_Prop3DMixin.user_matrix(1 use)create_axes_marker(1 use)create_axes_orientation_box(1 use)download_action_figure(1 use)download_avocado(1 use)download_bolt_nut(1 use)download_caffeine(1 use)download_coil_magnetic_field(1 use)download_cubemap_park(1 use)download_cubemap_space_16k(1 use)download_cubemap_space_4k(1 use)download_damaged_helmet(1 use)download_doorman(1 use)download_dual_sphere_animation(1 use)download_electronics_cooling(1 use)download_fea_hertzian_contact_cylinder(1 use)download_flamingo(1 use)download_gearbox(1 use)download_grasshopper(1 use)download_head(1 use)download_head_2(1 use)download_louis_louvre(1 use)download_lucy(1 use)download_m4_total_density(1 use)download_milk_truck(1 use)download_milkyway_sky_background(1 use)download_openfoam_tubes(1 use)download_reservoir(1 use)download_sextant(1 use)download_single_sphere_animation(1 use)download_sky_box_cube_map(1 use)download_stars_sky_background(1 use)download_teapot_vrml(1 use)download_victorian_goblet_face_illusion(1 use)download_whole_body_ct_female(1 use)download_whole_body_ct_male(1 use)fit_line_to_points(1 use)fit_plane_to_points(1 use)load_frog_tissues(1 use)orientation_cube(1 use)principal_axes(1 use)register_plotter_component(1 use)
Gallery Examples
Create a GIF Movie of a Static Object With a Moving Colormap
Attributes#
Return the actors of the active renderer. |
|
Return the background color of the active render window. |
|
Return the bounds of all VISIBLE actors present in the active rendering window. |
|
Forward to |
|
Forward to |
|
Forward to |
|
Return the active camera of the active renderer. |
|
Forward to |
|
Set or return the camera position of the active render window. |
|
Return or set if the camera of the active renderer has been set. |
|
Forward to |
|
Return the center of the active renderer. |
|
Forward to |
|
Return an image array of current render window. |
|
Return a depth image representing current render window. |
|
Get or set the scale factor when saving a screenshot. |
|
Forward to |
|
Legend actor. |
|
Return the length of the diagonal of the bounding box of the scene. |
|
Forward to |
|
Forward to |
|
Return plotter meshes. |
|
Return or set parallel projection state of active render window. |
|
Return or set parallel scale of active render window. |
|
Return or set the pickable actors. |
|
Picked actor. |
|
Picked block index. |
|
Picked cells. |
|
Picked geodesic polyline. |
|
Picked horizon ribbon surface. |
|
Picked mesh. |
|
Picked path polyline. |
|
Picked point. |
|
Forward to |
|
Forward to |
|
Forward to |
|
Forward to |
|
Forward to |
|
Access the vtkRenderWindow attached to this plotter. |
|
Return the active renderer. |
|
First scalar bar (kept for backwards compatibility). |
|
Return the scaling of the active renderer. |
|
Return the shape of the plotter. |
|
Forward to |
|
Forward to |
|
Forward to |
|
Forward to |
|
Get or set whether to suppress render calls. |
|
Return the theme used for this plotter. |
|
Forward to |
|
Return the render window size in |
Inherited Attributes#
Return the size of each axis of the object’s bounding box. |
Methods#
|
Add an actor to render window. |
|
Add a 3D affine transform widget. |
|
Add arrows to the plotter. |
|
Add an interactive axes widget in the bottom left corner. |
|
Add axes actor at origin. |
|
Add a background image to a plot. |
Add blurring. |
|
|
Add an unlabeled and unticked box at the boundaries of plot. |
|
Add an interactive color box axes widget in the bottom left corner. |
|
Add a box widget to the scene. |
Add a camera3d widget allow to move the camera. |
|
Add a camera orientation widget to the active renderer. |
|
|
Add a chart to this renderer. |
|
Add a checkbox button widget to the scene. |
|
Add a composite dataset to the plotter. |
|
Add a cursor of a PyVista or VTK dataset to the scene. |
|
Show a floor mesh. |
|
Add a function to callback when the given key is pressed. |
|
Add a legend to render window. |
|
Annotate the render window with scale and distance information. |
|
Add a Light to the scene. |
|
Add a line widget to the scene. |
|
Add lines to the plotting object. |
|
Add a logo widget to the top of the viewport. |
|
Interactively measure distance with a distance widget. |
|
Add any PyVista/VTK mesh or dataset that PyVista can wrap to the scene. |
|
Clip a mesh using a box widget. |
|
Clip a mesh using a plane widget. |
|
Create a contour of a mesh with a slider. |
|
Slice a mesh using a plane widget. |
|
Slice a mesh with three interactive planes. |
|
Slice a mesh with a spline widget. |
|
Apply a threshold on a mesh with a slider. |
Add a geographic north arrow to the scene. |
|
|
Add a method to be called post-render. |
|
Use the given actor in an orientation marker widget. |
|
Add a plane widget to the scene. |
|
Create a point actor with one label from list labels assigned to each point. |
|
Label the points from a dataset with the values of their scalars. |
|
Add points to a mesh. |
|
Add a radio button widget to the scene. |
|
Add ruler. |
|
Create a scalar bar. |
|
Add a silhouette of a PyVista or VTK dataset to the scene. |
|
Add a slider bar widget. |
|
Add one or many sphere widgets to a scene. |
|
Create and add a spline widget to the scene. |
|
Add text to plot object in the top left corner by default. |
|
Add a text slider bar widget. |
|
Add a function to callback as timer event. |
|
Add text to the top center of the plot. |
|
Add a volume, rendered using a smart mapper by default. |
|
Clip a volume using a plane widget. |
Clear plot by removing all actors and properties. |
|
Clear actors from all renderers. |
|
Remove all of the box widgets. |
|
Remove all of the button widgets. |
|
Remove all of the camera3d widgets. |
|
Remove all of the camera widgets. |
|
|
Remove the callbacks associated to the key. |
Remove all of the line widgets. |
|
Remove all of the logo widgets. |
|
Remove all of the measurement widgets. |
|
Clear all callback methods previously registered with |
|
Remove all of the plane widgets. |
|
Remove all of the radio button widgets. |
|
Remove all of the slider widgets. |
|
Remove all of the sphere widgets. |
|
Remove all of the spline widgets. |
|
Close the render window. |
|
|
Return the bounds of actors present in the renderer. |
Clean the plotter of the memory. |
|
Disable this renderer's camera from being interactive. |
|
Please use |
|
|
Disable anti-aliasing. |
Return every actor to the undistorted camera model. |
|
Disable depth of field plotting. |
|
Disable depth peeling. |
|
Disable eye dome lighting (EDL). |
|
Disable hidden line removal. |
|
Reset the camera to use perspective projection. |
|
Disable any active picking and remove observers. |
|
Disable shadows. |
|
Disable surface space ambient occlusion (SSAO). |
|
Disable anaglyph stereo rendering. |
|
Enable this renderer's camera to be interactive. |
|
Set the interactive style to 2D. |
|
|
Enable 3-lights illumination. |
|
Enable anti-aliasing. |
|
Enable composite block picking. |
|
Render every actor through a distorted camera model. |
|
Enable picking of cells with a rectangle selection tool. |
Set the interactive style to a custom style based on Trackball Camera. |
|
Enable depth of field plotting. |
|
|
Enable depth peeling to improve rendering of translucent geometry. |
|
Select individual elements on a mesh. |
Enable eye dome lighting (EDL). |
|
|
Set the camera to track right click positions. |
|
Enable picking at geodesic paths. |
Enable hidden line removal. |
|
|
Enable horizon picking. |
Set the interactive style to Image. |
|
|
Set the interactive style to a built-in or registered mode. |
Set the interactive style to Joystick Actor. |
|
Set the interactive style to Joystick Camera. |
|
|
Enable the default light-kit lighting. |
|
Enable picking of a mesh. |
Enable parallel projection. |
|
|
Enable picking at paths. |
|
Enable picking at points under the cursor. |
|
Enable rectangle based picking at cells. |
Enable rectangle based cell picking through the scene. |
|
Enable rectangle based cell picking on visible surfaces. |
|
Set the interactive style to Rubber Band 2D. |
|
Set the interactive style to Rubber Band Picking. |
|
Enable shadows. |
|
|
Enable surface space ambient occlusion (SSAO). |
Enable anaglyph stereo rendering. |
|
Enable picking of a point on the surface of a mesh. |
|
|
Set the interactive style to Terrain. |
Set the interactive style to Trackball Actor. |
|
Set the interactive style to Trackball Camera. |
|
Set the interactive style to Rubber Band Zoom. |
|
|
Export the current rendering scene as a glTF file. |
|
Export this plotter as an interactive scene to a HTML file. |
|
Export scene to OBJ format. |
|
Export the current rendering scene as a VRML file. |
|
Export this plotter as a VTK.js OfflineLocalView file. |
|
Move the current camera's focal point to a position point. |
|
Focus on last stored mouse position. |
|
Generate an orbital path around the data scene. |
|
Return the default focal points and |
|
Return a depth image representing current render window. |
Get the pick position or area. |
|
Hide the axes orientation widget. |
|
Hide the axes orientation widget in all renderers. |
|
|
Set the image scale in an isolated context. |
|
Import a 3DS file into the plotter. |
|
Import a glTF file into the plotter. |
|
Import from .obj wavefront files. |
|
Import a VRML file into the plotter. |
Increment point size and line width of all actors. |
|
Reset the camera to a default isometric view. |
|
Set the current interactive render window to isometric view. |
|
|
Listen for key press event. |
|
Register the event for a left button down click. |
|
Link the views' cameras. |
|
Open a gif file. |
|
Establish a connection to the ffmpeg writer. |
|
Orbit on the given path focusing on the focus point. |
Get corresponding click location in the 3D plot. |
|
Get corresponding mouse location in the 3D plot. |
|
|
Remove an actor from the Renderer. |
|
Remove all lights from the scene. |
Remove the background image at the current renderer. |
|
Remove a single blurring pass. |
|
|
Remove bounding box. |
Remove bounds axes. |
|
|
Remove a chart from this renderer. |
Remove the environment texture. |
|
|
Remove all floor actors. |
|
Remove the legend actor. |
|
Remove a scalar bar. |
Render the main window. |
|
|
Reset the camera of the active render window. |
Reset camera clipping planes. |
|
Reset all of the key press events to their defaults. |
|
|
Save a screenshot of the rendering window as a graphic file. |
|
Take screenshot at current camera position. |
|
Set the background color. |
|
Set or toggle interaction with charts for the active renderer. |
|
Set or reset the color cycler. |
|
Set the environment texture used for image based lighting. |
|
Set focus to a point. |
|
Set camera position to a point. |
|
Scale all the actors in the scene. |
|
Set camera |
|
Display the plotting window. |
Show the axes orientation widget. |
|
Show the axes orientation widget in all renderers. |
|
|
Add bounds axes. |
|
Show grid lines and bounds axes labels. |
|
Store click position in viewport coordinates. |
|
Store mouse position. |
|
Set the active subplot. |
|
Keep track of the click position. |
Keep track of the mouse position. |
|
|
Unlink the views' cameras. |
|
Stop tracking the click position. |
Stop tracking the mouse position. |
|
|
Update window, redraw, process messages query. |
Update the bounds axes of the render window. |
|
|
Update the value range of the active or named scalar bar. |
|
Update scalars of an object in the plotter. |
|
Reset the camera to a default isometric view. |
|
Point the camera in the direction of the given vector. |
|
View the XY plane. |
|
View the XZ plane. |
|
View the YX plane. |
|
View the YZ plane. |
|
View the ZX plane. |
|
View the ZY plane. |
|
Return the subplot coordinates of a given actor. |
|
Set the render window size in an isolated context. |
Write a single frame to the movie file. |
|
|
Zoom of the camera and render. |