pyvista.Plotter.compute_bounds

pyvista.Plotter.compute_bounds#

Plotter.compute_bounds(
*,
force_visibility: bool = False,
force_use_bounds: bool = False,
ignore_actors: Sequence[str | vtkProp | type[vtkProp]] | None = None,
) BoundsTuple[source]#

Return the bounds of actors present in the renderer.

By default, only visible actors are included in the bounds computation. Optionally, the bounds of all actors may be computed, regardless if they have their visibility or use_bounds disabled. Specific actors may also be removed from the computation.

Added in version 0.45.

Parameters:
force_visibilitybool, default: False

Include actors with visibility disabled in the computation. By default, invisible actors are excluded.

force_use_boundsbool, default: False

Include actors with use_bounds disabled in the computation. By default, actors with use bounds disabled are excluded.

ignore_actorssequence[str | vtkProp | type[vtkProp]]

List of actors to ignore. The bounds of any actors included will be ignored. Specify actors by name, type, or by instance.

Returns:
BoundsTuple

Bounds of selected actors in the active renderer.

See also

bounds

Bounds of all specified actors.