Open3D (C++ API)  0.11.0
Data Structures | Public Types | Public Member Functions
open3d::visualization::gui::SceneWidget Class Reference

#include <SceneWidget.h>

Inheritance diagram for open3d::visualization::gui::SceneWidget:
open3d::visualization::gui::Widget

Data Structures

struct  Impl
 

Public Types

enum  Controls {
  ROTATE_CAMERA, FLY, ROTATE_SUN, ROTATE_IBL,
  ROTATE_MODEL
}
 
enum  Quality { Quality::FAST, Quality::BEST }
 
enum  CameraPreset { CameraPreset::PLUS_X, CameraPreset::PLUS_Y, CameraPreset::PLUS_Z }
 
- Public Types inherited from open3d::visualization::gui::Widget
enum  DrawResult { DrawResult::NONE, DrawResult::REDRAW, DrawResult::RELAYOUT }
 
enum  EventResult { EventResult::IGNORED, EventResult::CONSUMED, EventResult::DISCARD }
 

Public Member Functions

 SceneWidget ()
 
 ~SceneWidget () override
 
void SetFrame (const Rect &f) override
 
void SetViewControls (Controls mode)
 
void SetupCamera (float verticalFoV, const geometry::AxisAlignedBoundingBox &geometry_bounds, const Eigen::Vector3f &center_of_rotation)
 
void SetOnCameraChanged (std::function< void(visualization::rendering::Camera *)> on_cam_changed)
 
void SetOnSunDirectionChanged (std::function< void(const Eigen::Vector3f &)> on_dir_changed)
 
void ShowSkybox (bool is_on)
 Enables showing the skybox while in skybox ROTATE_IBL mode. More...
 
void SetScene (std::shared_ptr< rendering::Open3DScene > scene)
 
std::shared_ptr< rendering::Open3DScene > GetScene () const
 
rendering::View * GetRenderView () const
 
void EnableSceneCaching (bool enable)
 
void ForceRedraw ()
 
void SetRenderQuality (Quality level)
 
Quality GetRenderQuality () const
 
void GoToCameraPreset (CameraPreset preset)
 
void Layout (const Theme &theme) override
 
Widget::DrawResult Draw (const DrawContext &context) override
 
Widget::EventResult Mouse (const MouseEvent &e) override
 
Widget::EventResult Key (const KeyEvent &e) override
 
Widget::DrawResult Tick (const TickEvent &e) override
 
- Public Member Functions inherited from open3d::visualization::gui::Widget
 Widget ()
 
 Widget (const std::vector< std::shared_ptr< Widget >> &children)
 
virtual ~Widget ()
 
void AddChild (std::shared_ptr< Widget > child)
 
const std::vector< std::shared_ptr< Widget > > GetChildren () const
 
const Rect & GetFrame () const
 Returns the frame size in pixels. More...
 
const Color & GetBackgroundColor () const
 
bool IsDefaultBackgroundColor () const
 
void SetBackgroundColor (const Color &color)
 
bool IsVisible () const
 
virtual void SetVisible (bool vis)
 
bool IsEnabled () const
 
virtual void SetEnabled (bool enabled)
 
virtual Size CalcPreferredSize (const Theme &theme) const
 

Additional Inherited Members

- Static Public Attributes inherited from open3d::visualization::gui::Widget
static constexpr int DIM_GROW = 10000
 
- Protected Member Functions inherited from open3d::visualization::gui::Widget
void DrawImGuiPushEnabledState ()
 
void DrawImGuiPopEnabledState ()
 

Member Enumeration Documentation

◆ CameraPreset

enum open3d::visualization::gui::SceneWidget::CameraPreset
strong
Enumerator
PLUS_X 
PLUS_Y 
PLUS_Z 

◆ Controls

enum open3d::visualization::gui::SceneWidget::Controls
Enumerator
ROTATE_CAMERA 
FLY 
ROTATE_SUN 
ROTATE_IBL 
ROTATE_MODEL 

◆ Quality

enum open3d::visualization::gui::SceneWidget::Quality
strong
Enumerator
FAST 
BEST 

Constructor & Destructor Documentation

◆ SceneWidget()

open3d::visualization::gui::SceneWidget::SceneWidget ( )
explicit

◆ ~SceneWidget()

open3d::visualization::gui::SceneWidget::~SceneWidget ( )
override

Member Function Documentation

◆ Draw()

Widget::DrawResult open3d::visualization::gui::SceneWidget::Draw ( const DrawContext &  context)
overridevirtual

Draws the widget. If this is a Dear ImGUI widget, this is where the actual event processing happens. Return NONE if no action needs to be taken, REDRAW if the widget needs to be redrawn (e.g. its value changed), and RELAYOUT if the widget wishes to change size.

Reimplemented from open3d::visualization::gui::Widget.

◆ EnableSceneCaching()

void open3d::visualization::gui::SceneWidget::EnableSceneCaching ( bool  enable)

Enable (or disable) caching of scene to improve UI responsiveness when dealing with large scenes (especially point clouds)

◆ ForceRedraw()

void open3d::visualization::gui::SceneWidget::ForceRedraw ( )

Forces the scene to redraw regardless of Renderer caching settings.

◆ GetRenderQuality()

SceneWidget::Quality open3d::visualization::gui::SceneWidget::GetRenderQuality ( ) const

◆ GetRenderView()

rendering::View * open3d::visualization::gui::SceneWidget::GetRenderView ( ) const

◆ GetScene()

std::shared_ptr< rendering::Open3DScene > open3d::visualization::gui::SceneWidget::GetScene ( ) const

◆ GoToCameraPreset()

void open3d::visualization::gui::SceneWidget::GoToCameraPreset ( CameraPreset  preset)

◆ Key()

Widget::EventResult open3d::visualization::gui::SceneWidget::Key ( const KeyEvent &  e)
overridevirtual

Widgets that use Dear ImGUI should not need to override this, as Dear ImGUI will take care of all the key handling during the Draw().

Reimplemented from open3d::visualization::gui::Widget.

◆ Layout()

void open3d::visualization::gui::SceneWidget::Layout ( const Theme &  theme)
overridevirtual

Reimplemented from open3d::visualization::gui::Widget.

◆ Mouse()

Widget::EventResult open3d::visualization::gui::SceneWidget::Mouse ( const MouseEvent &  e)
overridevirtual

Widgets that use Dear ImGUI should not need to override this, as Dear ImGUI will take care of all the mouse handling during the Draw().

Reimplemented from open3d::visualization::gui::Widget.

◆ SetFrame()

void open3d::visualization::gui::SceneWidget::SetFrame ( const Rect &  f)
overridevirtual

The frame is in pixels. The size of a pixel varies on different and operatings sytems now frequently scale text sizes on high DPI monitors. Prefer using a Layout to using this function, but if you must use it, it is best to use a multiple of Window::GetTheme().fontSize, which represents 1em and is scaled according to the scaling factor of the window.

Reimplemented from open3d::visualization::gui::Widget.

◆ SetOnCameraChanged()

void open3d::visualization::gui::SceneWidget::SetOnCameraChanged ( std::function< void(visualization::rendering::Camera *)>  on_cam_changed)

◆ SetOnSunDirectionChanged()

void open3d::visualization::gui::SceneWidget::SetOnSunDirectionChanged ( std::function< void(const Eigen::Vector3f &)>  on_dir_changed)

Enables changing the directional light with the mouse. SceneWidget will update the light's direction, so onDirChanged is only needed if other things need to be updated (like a UI).

◆ SetRenderQuality()

void open3d::visualization::gui::SceneWidget::SetRenderQuality ( Quality  level)

◆ SetScene()

void open3d::visualization::gui::SceneWidget::SetScene ( std::shared_ptr< rendering::Open3DScene >  scene)

◆ SetupCamera()

void open3d::visualization::gui::SceneWidget::SetupCamera ( float  verticalFoV,
const geometry::AxisAlignedBoundingBox &  geometry_bounds,
const Eigen::Vector3f &  center_of_rotation 
)

◆ SetViewControls()

void open3d::visualization::gui::SceneWidget::SetViewControls ( Controls  mode)

◆ ShowSkybox()

void open3d::visualization::gui::SceneWidget::ShowSkybox ( bool  is_on)

Enables showing the skybox while in skybox ROTATE_IBL mode.

◆ Tick()

Widget::DrawResult open3d::visualization::gui::SceneWidget::Tick ( const TickEvent &  e)
overridevirtual

Tick events are sent regularly and allow for things like smoothly moving the camera based on keys that are pressed, or animations. Return DrawResult::REDRAW if you want to be redrawn.

Reimplemented from open3d::visualization::gui::Widget.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.13