open3d::visualization::rendering::Open3DScene Class Reference

#include <Open3DScene.h>

Public Types
enum class	LightingProfile {   HARD_SHADOWS , DARK_SHADOWS , MED_SHADOWS , SOFT_SHADOWS ,   NO_SHADOWS }
enum class	LOD { HIGH_DETAIL , FAST }

Public Member Functions
	Open3DScene (Renderer &renderer)
	~Open3DScene ()
View *	GetView () const
ViewHandle	GetViewId () const
void	SetViewport (std::int32_t x, std::int32_t y, std::uint32_t width, std::uint32_t height)
void	ShowSkybox (bool enable)
void	ShowAxes (bool enable)
void	SetBackground (const Eigen::Vector4f &color, std::shared_ptr< geometry::Image > image=nullptr)
const Eigen::Vector4f	GetBackgroundColor () const
void	ShowGroundPlane (bool enable, Scene::GroundPlane plane)
void	SetLighting (LightingProfile profile, const Eigen::Vector3f &sun_dir)
void	SetDownsampleThreshold (size_t n_points)
size_t	GetDownsampleThreshold () const
void	ClearGeometry ()
void	AddGeometry (const std::string &name, const geometry::Geometry3D *geom, const MaterialRecord &mat, bool add_downsampled_copy_for_fast_rendering=true)
	Adds a geometry with the specified name. Default visible is true. More...
void	AddGeometry (const std::string &name, const t::geometry::Geometry *geom, const MaterialRecord &mat, bool add_downsampled_copy_for_fast_rendering=true)
bool	HasGeometry (const std::string &name) const
void	RemoveGeometry (const std::string &name)
void	ShowGeometry (const std::string &name, bool show)
	Shows or hides the geometry with the specified name. More...
bool	GeometryIsVisible (const std::string &name)
void	SetGeometryTransform (const std::string &name, const Eigen::Matrix4d &transform)
Eigen::Matrix4d	GetGeometryTransform (const std::string &name)
void	ModifyGeometryMaterial (const std::string &name, const MaterialRecord &mat)
void	AddModel (const std::string &name, const TriangleMeshModel &model)
void	UpdateMaterial (const MaterialRecord &mat)
	Updates all geometries to use this material. More...
void	UpdateModelMaterial (const std::string &name, const TriangleMeshModel &model)
	Updates the named model to use this material. More...
std::vector< std::string >	GetGeometries ()
const geometry::AxisAlignedBoundingBox &	GetBoundingBox ()
void	SetLOD (LOD lod)
LOD	GetLOD () const
Scene *	GetScene () const
Camera *	GetCamera () const
Renderer &	GetRenderer () const

Member Enumeration Documentation

LightingProfile

enum open3d::visualization::rendering::Open3DScene::LightingProfile

strong

Enumerator
HARD_SHADOWS
DARK_SHADOWS
MED_SHADOWS
SOFT_SHADOWS
NO_SHADOWS

LOD

enum open3d::visualization::rendering::Open3DScene::LOD

strong

Enumerator
HIGH_DETAIL
FAST

Constructor & Destructor Documentation

Open3DScene()

open3d::visualization::rendering::Open3DScene::Open3DScene

(

Renderer &

renderer

)

~Open3DScene()

open3d::visualization::rendering::Open3DScene::~Open3DScene

(

)

Member Function Documentation

AddGeometry() [1/2]

void open3d::visualization::rendering::Open3DScene::AddGeometry	(	const std::string &	name,
		const geometry::Geometry3D *	geom,
		const MaterialRecord &	mat,
		bool	add_downsampled_copy_for_fast_rendering = true
	)

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

AddGeometry() [2/2]

void open3d::visualization::rendering::Open3DScene::AddGeometry	(	const std::string &	name,
		const t::geometry::Geometry *	geom,
		const MaterialRecord &	mat,
		bool	add_downsampled_copy_for_fast_rendering = true
	)

AddModel()

void open3d::visualization::rendering::Open3DScene::AddModel	(	const std::string &	name,
		const TriangleMeshModel &	model
	)

ClearGeometry()

void open3d::visualization::rendering::Open3DScene::ClearGeometry

(

)

GeometryIsVisible()

bool open3d::visualization::rendering::Open3DScene::GeometryIsVisible

(

const std::string &

name

)

GetBackgroundColor()

const Eigen::Vector4f open3d::visualization::rendering::Open3DScene::GetBackgroundColor

(

)

const

GetBoundingBox()

const geometry::AxisAlignedBoundingBox& open3d::visualization::rendering::Open3DScene::GetBoundingBox ( )

inline

GetCamera()

Camera * open3d::visualization::rendering::Open3DScene::GetCamera

(

)

const

GetDownsampleThreshold()

size_t open3d::visualization::rendering::Open3DScene::GetDownsampleThreshold ( ) const

inline

GetGeometries()

std::vector< std::string > open3d::visualization::rendering::Open3DScene::GetGeometries

(

)

GetGeometryTransform()

Eigen::Matrix4d open3d::visualization::rendering::Open3DScene::GetGeometryTransform

(

const std::string &

name

)

GetLOD()

Open3DScene::LOD open3d::visualization::rendering::Open3DScene::GetLOD

(

)

const

GetRenderer()

Renderer & open3d::visualization::rendering::Open3DScene::GetRenderer

(

)

const

GetScene()

Scene * open3d::visualization::rendering::Open3DScene::GetScene

(

)

const

GetView()

View * open3d::visualization::rendering::Open3DScene::GetView

(

)

const

GetViewId()

ViewHandle open3d::visualization::rendering::Open3DScene::GetViewId ( ) const

inline

HasGeometry()

bool open3d::visualization::rendering::Open3DScene::HasGeometry

(

const std::string &

name

)

const

ModifyGeometryMaterial()

void open3d::visualization::rendering::Open3DScene::ModifyGeometryMaterial	(	const std::string &	name,
		const MaterialRecord &	mat
	)

RemoveGeometry()

void open3d::visualization::rendering::Open3DScene::RemoveGeometry

(

const std::string &

name

)

SetBackground()

void open3d::visualization::rendering::Open3DScene::SetBackground	(	const Eigen::Vector4f &	color,
		std::shared_ptr< geometry::Image >	image = nullptr
	)

SetDownsampleThreshold()

void open3d::visualization::rendering::Open3DScene::SetDownsampleThreshold ( size_t  n_points )

inline

Sets the maximum number of points before AddGeometry also adds a downsampled point cloud with number of points, used when rendering speed is important.

SetGeometryTransform()

void open3d::visualization::rendering::Open3DScene::SetGeometryTransform	(	const std::string &	name,
		const Eigen::Matrix4d &	transform
	)

SetLighting()

void open3d::visualization::rendering::Open3DScene::SetLighting	(	LightingProfile	profile,
		const Eigen::Vector3f &	sun_dir
	)

SetLOD()

void open3d::visualization::rendering::Open3DScene::SetLOD

(

LOD

lod

)

SetViewport()

void open3d::visualization::rendering::Open3DScene::SetViewport	(	std::int32_t	x,
		std::int32_t	y,
		std::uint32_t	width,
		std::uint32_t	height
	)

ShowAxes()

void open3d::visualization::rendering::Open3DScene::ShowAxes

(

bool

enable

)

ShowGeometry()

void open3d::visualization::rendering::Open3DScene::ShowGeometry	(	const std::string &	name,
		bool	show
	)

Shows or hides the geometry with the specified name.

ShowGroundPlane()

void open3d::visualization::rendering::Open3DScene::ShowGroundPlane	(	bool	enable,
		Scene::GroundPlane	plane
	)

ShowSkybox()

void open3d::visualization::rendering::Open3DScene::ShowSkybox

(

bool

enable

)

UpdateMaterial()

void open3d::visualization::rendering::Open3DScene::UpdateMaterial

(

const MaterialRecord &

mat

)

Updates all geometries to use this material.

UpdateModelMaterial()

void open3d::visualization::rendering::Open3DScene::UpdateModelMaterial	(	const std::string &	name,
		const TriangleMeshModel &	model
	)

Updates the named model to use this material.

---

The documentation for this class was generated from the following files:

• /home/runner/work/Open3D/Open3D/cpp/open3d/visualization/rendering/Open3DScene.h (9238339 (Tue Mar 14 18:49:09 2023 -0700))
• /home/runner/work/Open3D/Open3D/cpp/open3d/visualization/rendering/Open3DScene.cpp (9238339 (Tue Mar 14 18:49:09 2023 -0700))