open3d.visualization.rendering.Open3DScene#

class open3d.visualization.rendering.Open3DScene#

High-level scene for rending

class LightingProfile(value)#

Enum for conveniently setting lighting

DARK_SHADOWS = 1#
HARD_SHADOWS = 0#
MED_SHADOWS = 2#
NO_SHADOWS = 4#
SOFT_SHADOWS = 3#
__init__(self: open3d.visualization.rendering.Open3DScene, arg0: open3d.visualization.rendering.Renderer) → None#
add_geometry(*args, **kwargs)#

Overloaded function.

  1. add_geometry(self: open3d.visualization.rendering.Open3DScene, name: str, geometry: open3d.geometry.Geometry3D, material: open3d.visualization.rendering.MaterialRecord, add_downsampled_copy_for_fast_rendering: bool = True) -> None

Adds a geometry with the specified name. Default visible is true.

  1. add_geometry(self: open3d.visualization.rendering.Open3DScene, name: str, geometry: open3d.t.geometry.Geometry, material: open3d.visualization.rendering.MaterialRecord, add_downsampled_copy_for_fast_rendering: bool = True) -> None

Adds a geometry with the specified name. Default visible is true.

add_model(self: open3d.visualization.rendering.Open3DScene, name: str, model: open3d.visualization.rendering.TriangleMeshModel) → None#

Adds TriangleMeshModel to the scene.

clear_geometry(self: open3d.visualization.rendering.Open3DScene) → None#
geometry_is_visible(self: open3d.visualization.rendering.Open3DScene, name: str) → bool#

Returns True if the geometry name is visible

get_geometry_transform(self: open3d.visualization.rendering.Open3DScene, name: str) → Annotated[numpy.typing.NDArray[numpy.float64], '[4, 4]']#

Returns the pose of the geometry name in the scene

has_geometry(self: open3d.visualization.rendering.Open3DScene, name: str) → bool#

Returns True if the geometry has been added to the scene, False otherwise

modify_geometry_material(self: open3d.visualization.rendering.Open3DScene, name: str, material: open3d.visualization.rendering.MaterialRecord) → None#

Modifies the material of the specified geometry

remove_geometry(self: open3d.visualization.rendering.Open3DScene, name: str) → None#

Removes the geometry with the given name

set_background(self: open3d.visualization.rendering.Open3DScene, color: Annotated[numpy.typing.ArrayLike, numpy.float32, '[4, 1]'], image: open3d.geometry.Image = None) → None#

set_background([r, g, b, a], image=None). Sets the background color and (optionally) image of the scene.

set_background_color(self: open3d.visualization.rendering.Open3DScene, arg0: Annotated[numpy.typing.ArrayLike, numpy.float32, '[4, 1]']) → None#

This function has been deprecated. Please use set_background() instead.

set_geometry_transform(self: open3d.visualization.rendering.Open3DScene, name: str, transform: Annotated[numpy.typing.ArrayLike, numpy.float64, '[4, 4]']) → None#

sets the pose of the geometry name to transform

set_lighting(self: open3d.visualization.rendering.Open3DScene, profile: open3d.visualization.rendering.Open3DScene.LightingProfile, sun_dir: Annotated[numpy.typing.ArrayLike, numpy.float32, '[3, 1]']) → None#

Sets a simple lighting model. The default value is set_lighting(Open3DScene.LightingProfile.MED_SHADOWS, (0.577, -0.577, -0.577))

set_view_size(self: open3d.visualization.rendering.Open3DScene, width: SupportsInt, height: SupportsInt) → None#

Sets the view size. This should not be used except for rendering to an image

show_axes(self: open3d.visualization.rendering.Open3DScene, enable: bool) → None#

Toggles display of xyz axes

show_geometry(self: open3d.visualization.rendering.Open3DScene, name: str, show: bool) → None#

Shows or hides the geometry with the given name

show_ground_plane(self: open3d.visualization.rendering.Open3DScene, enable: bool, plane: open3d.visualization.rendering.Scene.GroundPlane) → None#

Toggles display of ground plane

show_skybox(self: open3d.visualization.rendering.Open3DScene, enable: bool) → None#

Toggles display of the skybox

update_material(self: open3d.visualization.rendering.Open3DScene, material: open3d.visualization.rendering.MaterialRecord) → None#

Applies the passed material to all the geometries

DARK_SHADOWS = 1#
HARD_SHADOWS = 0#
MED_SHADOWS = 2#
NO_SHADOWS = 4#
SOFT_SHADOWS = 3#
property background_color#

The background color (read-only)

property bounding_box#

The bounding box of all the items in the scene, visible and invisible

property camera#

The camera object (read-only)

property downsample_threshold#

Minimum number of points before downsampled point clouds are created and used when rendering speed is important

property scene#

The low-level rendering scene object (read-only)

property view#

The low level view associated with the scene