open3d::visualization::rendering::Scene Class Reference

#include <Scene.h>

Inheritance diagram for open3d::visualization::rendering::Scene:

Public Types
enum class	GroundPlane { XZ , XY , YZ }
using	Transform = Eigen::Transform< float, 3, Eigen::Affine >

Public Member Functions
	Scene (Renderer &renderer)
virtual	~Scene ()=default
virtual Scene *	Copy ()=0
virtual ViewHandle	AddView (std::int32_t x, std::int32_t y, std::uint32_t w, std::uint32_t h)=0
virtual View *	GetView (const ViewHandle &view_id) const =0
virtual void	SetViewActive (const ViewHandle &view_id, bool is_active)=0
virtual void	SetRenderOnce (const ViewHandle &view_id)=0
virtual void	RemoveView (const ViewHandle &view_id)=0
virtual void	AddCamera (const std::string &camera_name, std::shared_ptr< Camera > cam)=0
virtual void	RemoveCamera (const std::string &camera_name)=0
virtual void	SetActiveCamera (const std::string &camera_name)=0
virtual bool	AddGeometry (const std::string &object_name, const geometry::Geometry3D &geometry, const MaterialRecord &material, const std::string &downsampled_name="", size_t downsample_threshold=SIZE_MAX)=0
virtual bool	AddGeometry (const std::string &object_name, const t::geometry::Geometry &geometry, const MaterialRecord &material, const std::string &downsampled_name="", size_t downsample_threshold=SIZE_MAX)=0
virtual bool	AddGeometry (const std::string &object_name, const TriangleMeshModel &model)=0
virtual bool	HasGeometry (const std::string &object_name) const =0
virtual void	UpdateGeometry (const std::string &object_name, const t::geometry::PointCloud &point_cloud, uint32_t update_flags)=0
virtual void	RemoveGeometry (const std::string &object_name)=0
virtual void	ShowGeometry (const std::string &object_name, bool show)=0
virtual bool	GeometryIsVisible (const std::string &object_name)=0
virtual void	OverrideMaterial (const std::string &object_name, const MaterialRecord &material)=0
virtual void	GeometryShadows (const std::string &object_name, bool cast_shadows, bool receive_shadows)=0
virtual void	SetGeometryCulling (const std::string &object_name, bool enable)=0
virtual void	SetGeometryPriority (const std::string &object_name, uint8_t priority)=0
virtual void	QueryGeometry (std::vector< std::string > &geometry)=0
virtual void	SetGeometryTransform (const std::string &object_name, const Transform &transform)=0
virtual Transform	GetGeometryTransform (const std::string &object_name)=0
virtual geometry::AxisAlignedBoundingBox	GetGeometryBoundingBox (const std::string &object_name)=0
virtual void	OverrideMaterialAll (const MaterialRecord &material, bool shader_only=true)=0
virtual bool	AddPointLight (const std::string &light_name, const Eigen::Vector3f &color, const Eigen::Vector3f &position, float intensity, float falloff, bool cast_shadows)=0
virtual bool	AddSpotLight (const std::string &light_name, const Eigen::Vector3f &color, const Eigen::Vector3f &position, const Eigen::Vector3f &direction, float intensity, float falloff, float inner_cone_angle, float outer_cone_angle, bool cast_shadows)=0
virtual bool	AddDirectionalLight (const std::string &light_name, const Eigen::Vector3f &color, const Eigen::Vector3f &direction, float intensity, bool cast_shadows)=0
virtual Light &	GetLight (const std::string &light_name)=0
virtual void	RemoveLight (const std::string &light_name)=0
virtual void	UpdateLight (const std::string &light_name, const Light &light)=0
virtual void	UpdateLightColor (const std::string &light_name, const Eigen::Vector3f &color)=0
virtual void	UpdateLightPosition (const std::string &light_name, const Eigen::Vector3f &position)=0
virtual void	UpdateLightDirection (const std::string &light_name, const Eigen::Vector3f &direction)=0
virtual void	UpdateLightIntensity (const std::string &light_name, float intensity)=0
virtual void	UpdateLightFalloff (const std::string &light_name, float falloff)=0
virtual void	UpdateLightConeAngles (const std::string &light_name, float inner_cone_angle, float outer_cone_angle)=0
virtual void	EnableLightShadow (const std::string &light_name, bool cast_shadows)=0
virtual void	SetSunLight (const Eigen::Vector3f &direction, const Eigen::Vector3f &color, float intensity)=0
virtual void	EnableSunLight (bool enable)=0
virtual void	EnableSunLightShadows (bool enable)=0
virtual void	SetSunLightColor (const Eigen::Vector3f &color)=0
virtual Eigen::Vector3f	GetSunLightColor ()=0
virtual void	SetSunLightIntensity (float intensity)=0
virtual float	GetSunLightIntensity ()=0
virtual void	SetSunLightDirection (const Eigen::Vector3f &direction)=0
virtual Eigen::Vector3f	GetSunLightDirection ()=0
virtual void	SetSunAngularRadius (float radius)=0
virtual void	SetSunHaloSize (float size)=0
virtual void	SetSunHaloFalloff (float falloff)=0
virtual bool	SetIndirectLight (const std::string &ibl_name)=0
virtual const std::string &	GetIndirectLight ()=0
virtual void	EnableIndirectLight (bool enable)=0
virtual void	SetIndirectLightIntensity (float intensity)=0
virtual float	GetIndirectLightIntensity ()=0
virtual void	SetIndirectLightRotation (const Transform &rotation)=0
virtual Transform	GetIndirectLightRotation ()=0
virtual void	ShowSkybox (bool show)=0
virtual bool	GetSkyboxVisible () const =0
virtual void	SetBackground (const Eigen::Vector4f &color, const std::shared_ptr< geometry::Image > image=nullptr)=0
virtual void	SetBackground (TextureHandle image)=0
virtual void	EnableGroundPlane (bool enable, GroundPlane plane)=0
virtual void	SetGroundPlaneColor (const Eigen::Vector4f &color)=0
virtual void	RenderToImage (std::function< void(std::shared_ptr< geometry::Image >)> callback)=0
	Size of image is the size of the window. More...
virtual void	RenderToDepthImage (std::function< void(std::shared_ptr< geometry::Image >)> callback)=0
	Size of image is the size of the window. More...

Static Public Attributes
static const uint32_t	kUpdatePointsFlag = (1 << 0)
static const uint32_t	kUpdateNormalsFlag = (1 << 1)
static const uint32_t	kUpdateColorsFlag = (1 << 2)
static const uint32_t	kUpdateUv0Flag = (1 << 3)

Protected Attributes
Renderer &	renderer_

Member Typedef Documentation

Transform

using open3d::visualization::rendering::Scene::Transform = Eigen::Transform<float, 3, Eigen::Affine>

Member Enumeration Documentation

GroundPlane

enum open3d::visualization::rendering::Scene::GroundPlane

strong

Enumerator
XZ
XY
YZ

Constructor & Destructor Documentation

Scene()

open3d::visualization::rendering::Scene::Scene ( Renderer &  renderer )

inline

~Scene()

virtual open3d::visualization::rendering::Scene::~Scene ( )

virtualdefault

Member Function Documentation

AddCamera()

virtual void open3d::visualization::rendering::Scene::AddCamera ( const std::string &  camera_name, std::shared_ptr< Camera >  cam  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

AddDirectionalLight()

virtual bool open3d::visualization::rendering::Scene::AddDirectionalLight ( const std::string &  light_name, const Eigen::Vector3f &  color, const Eigen::Vector3f &  direction, float  intensity, bool  cast_shadows  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

AddGeometry() [1/3]

virtual bool open3d::visualization::rendering::Scene::AddGeometry ( const std::string &  object_name, const geometry::Geometry3D &  geometry, const MaterialRecord &  material, const std::string &  downsampled_name = "", size_t  downsample_threshold = SIZE_MAX  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

AddGeometry() [2/3]

virtual bool open3d::visualization::rendering::Scene::AddGeometry ( const std::string &  object_name, const t::geometry::Geometry &  geometry, const MaterialRecord &  material, const std::string &  downsampled_name = "", size_t  downsample_threshold = SIZE_MAX  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

AddGeometry() [3/3]

virtual bool open3d::visualization::rendering::Scene::AddGeometry ( const std::string &  object_name, const TriangleMeshModel &  model  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

AddPointLight()

virtual bool open3d::visualization::rendering::Scene::AddPointLight ( const std::string &  light_name, const Eigen::Vector3f &  color, const Eigen::Vector3f &  position, float  intensity, float  falloff, bool  cast_shadows  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

AddSpotLight()

virtual bool open3d::visualization::rendering::Scene::AddSpotLight ( const std::string &  light_name, const Eigen::Vector3f &  color, const Eigen::Vector3f &  position, const Eigen::Vector3f &  direction, float  intensity, float  falloff, float  inner_cone_angle, float  outer_cone_angle, bool  cast_shadows  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

AddView()

virtual ViewHandle open3d::visualization::rendering::Scene::AddView ( std::int32_t  x, std::int32_t  y, std::uint32_t  w, std::uint32_t  h  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

Copy()

virtual Scene* open3d::visualization::rendering::Scene::Copy ( )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

EnableGroundPlane()

virtual void open3d::visualization::rendering::Scene::EnableGroundPlane ( bool  enable, GroundPlane  plane  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

EnableIndirectLight()

virtual void open3d::visualization::rendering::Scene::EnableIndirectLight ( bool  enable )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

EnableLightShadow()

virtual void open3d::visualization::rendering::Scene::EnableLightShadow ( const std::string &  light_name, bool  cast_shadows  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

EnableSunLight()

virtual void open3d::visualization::rendering::Scene::EnableSunLight ( bool  enable )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

EnableSunLightShadows()

virtual void open3d::visualization::rendering::Scene::EnableSunLightShadows ( bool  enable )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

GeometryIsVisible()

virtual bool open3d::visualization::rendering::Scene::GeometryIsVisible ( const std::string &  object_name )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

GeometryShadows()

virtual void open3d::visualization::rendering::Scene::GeometryShadows ( const std::string &  object_name, bool  cast_shadows, bool  receive_shadows  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

GetGeometryBoundingBox()

virtual geometry::AxisAlignedBoundingBox open3d::visualization::rendering::Scene::GetGeometryBoundingBox ( const std::string &  object_name )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

GetGeometryTransform()

virtual Transform open3d::visualization::rendering::Scene::GetGeometryTransform ( const std::string &  object_name )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

GetIndirectLight()

virtual const std::string& open3d::visualization::rendering::Scene::GetIndirectLight ( )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

GetIndirectLightIntensity()

virtual float open3d::visualization::rendering::Scene::GetIndirectLightIntensity ( )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

GetIndirectLightRotation()

virtual Transform open3d::visualization::rendering::Scene::GetIndirectLightRotation ( )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

GetLight()

virtual Light& open3d::visualization::rendering::Scene::GetLight ( const std::string &  light_name )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

GetSkyboxVisible()

virtual bool open3d::visualization::rendering::Scene::GetSkyboxVisible ( ) const

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

GetSunLightColor()

virtual Eigen::Vector3f open3d::visualization::rendering::Scene::GetSunLightColor ( )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

GetSunLightDirection()

virtual Eigen::Vector3f open3d::visualization::rendering::Scene::GetSunLightDirection ( )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

GetSunLightIntensity()

virtual float open3d::visualization::rendering::Scene::GetSunLightIntensity ( )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

GetView()

virtual View* open3d::visualization::rendering::Scene::GetView ( const ViewHandle &  view_id ) const

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

HasGeometry()

virtual bool open3d::visualization::rendering::Scene::HasGeometry ( const std::string &  object_name ) const

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

OverrideMaterial()

virtual void open3d::visualization::rendering::Scene::OverrideMaterial ( const std::string &  object_name, const MaterialRecord &  material  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

OverrideMaterialAll()

virtual void open3d::visualization::rendering::Scene::OverrideMaterialAll ( const MaterialRecord &  material, bool  shader_only = true  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

QueryGeometry()

virtual void open3d::visualization::rendering::Scene::QueryGeometry ( std::vector< std::string > &  geometry )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

RemoveCamera()

virtual void open3d::visualization::rendering::Scene::RemoveCamera ( const std::string &  camera_name )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

RemoveGeometry()

virtual void open3d::visualization::rendering::Scene::RemoveGeometry ( const std::string &  object_name )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

RemoveLight()

virtual void open3d::visualization::rendering::Scene::RemoveLight ( const std::string &  light_name )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

RemoveView()

virtual void open3d::visualization::rendering::Scene::RemoveView ( const ViewHandle &  view_id )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

RenderToDepthImage()

virtual void open3d::visualization::rendering::Scene::RenderToDepthImage ( std::function< void(std::shared_ptr< geometry::Image >)>  callback )

pure virtual

Size of image is the size of the window.

Implemented in open3d::visualization::rendering::FilamentScene.

RenderToImage()

virtual void open3d::visualization::rendering::Scene::RenderToImage ( std::function< void(std::shared_ptr< geometry::Image >)>  callback )

pure virtual

Size of image is the size of the window.

Implemented in open3d::visualization::rendering::FilamentScene.

SetActiveCamera()

virtual void open3d::visualization::rendering::Scene::SetActiveCamera ( const std::string &  camera_name )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

SetBackground() [1/2]

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

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

SetBackground() [2/2]

virtual void open3d::visualization::rendering::Scene::SetBackground ( TextureHandle  image )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

SetGeometryCulling()

virtual void open3d::visualization::rendering::Scene::SetGeometryCulling ( const std::string &  object_name, bool  enable  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

SetGeometryPriority()

virtual void open3d::visualization::rendering::Scene::SetGeometryPriority ( const std::string &  object_name, uint8_t  priority  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

SetGeometryTransform()

virtual void open3d::visualization::rendering::Scene::SetGeometryTransform ( const std::string &  object_name, const Transform &  transform  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

SetGroundPlaneColor()

virtual void open3d::visualization::rendering::Scene::SetGroundPlaneColor ( const Eigen::Vector4f &  color )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

SetIndirectLight()

virtual bool open3d::visualization::rendering::Scene::SetIndirectLight ( const std::string &  ibl_name )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

SetIndirectLightIntensity()

virtual void open3d::visualization::rendering::Scene::SetIndirectLightIntensity ( float  intensity )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

SetIndirectLightRotation()

virtual void open3d::visualization::rendering::Scene::SetIndirectLightRotation ( const Transform &  rotation )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

SetRenderOnce()

virtual void open3d::visualization::rendering::Scene::SetRenderOnce ( const ViewHandle &  view_id )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

SetSunAngularRadius()

virtual void open3d::visualization::rendering::Scene::SetSunAngularRadius ( float  radius )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

SetSunHaloFalloff()

virtual void open3d::visualization::rendering::Scene::SetSunHaloFalloff ( float  falloff )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

SetSunHaloSize()

virtual void open3d::visualization::rendering::Scene::SetSunHaloSize ( float  size )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

SetSunLight()

virtual void open3d::visualization::rendering::Scene::SetSunLight ( const Eigen::Vector3f &  direction, const Eigen::Vector3f &  color, float  intensity  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

SetSunLightColor()

virtual void open3d::visualization::rendering::Scene::SetSunLightColor ( const Eigen::Vector3f &  color )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

SetSunLightDirection()

virtual void open3d::visualization::rendering::Scene::SetSunLightDirection ( const Eigen::Vector3f &  direction )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

SetSunLightIntensity()

virtual void open3d::visualization::rendering::Scene::SetSunLightIntensity ( float  intensity )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

SetViewActive()

virtual void open3d::visualization::rendering::Scene::SetViewActive ( const ViewHandle &  view_id, bool  is_active  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

ShowGeometry()

virtual void open3d::visualization::rendering::Scene::ShowGeometry ( const std::string &  object_name, bool  show  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

ShowSkybox()

virtual void open3d::visualization::rendering::Scene::ShowSkybox ( bool  show )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

UpdateGeometry()

virtual void open3d::visualization::rendering::Scene::UpdateGeometry ( const std::string &  object_name, const t::geometry::PointCloud &  point_cloud, uint32_t  update_flags  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

UpdateLight()

virtual void open3d::visualization::rendering::Scene::UpdateLight ( const std::string &  light_name, const Light &  light  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

UpdateLightColor()

virtual void open3d::visualization::rendering::Scene::UpdateLightColor ( const std::string &  light_name, const Eigen::Vector3f &  color  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

UpdateLightConeAngles()

virtual void open3d::visualization::rendering::Scene::UpdateLightConeAngles ( const std::string &  light_name, float  inner_cone_angle, float  outer_cone_angle  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

UpdateLightDirection()

virtual void open3d::visualization::rendering::Scene::UpdateLightDirection ( const std::string &  light_name, const Eigen::Vector3f &  direction  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

UpdateLightFalloff()

virtual void open3d::visualization::rendering::Scene::UpdateLightFalloff ( const std::string &  light_name, float  falloff  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

UpdateLightIntensity()

virtual void open3d::visualization::rendering::Scene::UpdateLightIntensity ( const std::string &  light_name, float  intensity  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

UpdateLightPosition()

virtual void open3d::visualization::rendering::Scene::UpdateLightPosition ( const std::string &  light_name, const Eigen::Vector3f &  position  )

pure virtual

Implemented in open3d::visualization::rendering::FilamentScene.

Field Documentation

kUpdateColorsFlag

const uint32_t open3d::visualization::rendering::Scene::kUpdateColorsFlag = (1 << 2)

static

kUpdateNormalsFlag

const uint32_t open3d::visualization::rendering::Scene::kUpdateNormalsFlag = (1 << 1)

static

kUpdatePointsFlag

const uint32_t open3d::visualization::rendering::Scene::kUpdatePointsFlag = (1 << 0)

static

kUpdateUv0Flag

const uint32_t open3d::visualization::rendering::Scene::kUpdateUv0Flag = (1 << 3)

static

renderer_

Renderer& open3d::visualization::rendering::Scene::renderer_

protected

---

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

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