open3d::visualization Namespace Reference

Namespaces
	app
	gl_util
	glsl
	gui
	rendering
	visualizer
	webrtc_server

Data Structures
class	ColorMap
class	ColorMapGray
class	ColorMapJet
	See Matlab's Jet colormap. More...
class	ColorMapSummer
	See Matlab's Summer colormap. More...
class	ColorMapWinter
	See Matlab's Winter colormap. More...
class	ColorMapHot
struct	DrawObject
struct	DrawAction
class	PointCloudPicker
	A utility class to store picked points of a pointcloud. More...
class	SelectionPolygon
class	SelectionPolygonVolume
	Select a polygon volume for cropping. More...
class	GuiSettingsModel
class	GuiSettingsView
class	GuiVisualizer
class	SmallButton
class	SmallToggleButton
class	MessageProcessor
class	RenderOption
	Defines rendering options for visualizer. More...
class	RenderOptionWithEditing
class	ViewControl
	View controller for visualizer. More...
class	ViewControlWithCustomAnimation
class	ViewControlWithEditing
class	ViewParameters
class	ViewTrajectory
class	GLFWContext
	GLFW context, handled as a singleton. More...
class	Visualizer
	The main Visualizer class. More...
class	VisualizerWithCustomAnimation
class	VisualizerWithEditing
	Visualizer with editing capabilities. More...
class	VisualizerWithKeyCallback
	Visualizer with custom key callback capabilities. More...
class	VisualizerWithVertexSelection

Enumerations
enum	MenuId {   FILE_OPEN , FILE_EXPORT_RGB , FILE_QUIT , SETTINGS_LIGHT_AND_MATERIALS ,   HELP_KEYS , HELP_CAMERA , HELP_ABOUT , HELP_CONTACT ,   HELP_DEBUG }

Functions
const std::shared_ptr< const ColorMap >	GetGlobalColorMap ()
	Interface functions. More...
void	SetGlobalColorMap (ColorMap::ColorMapOption option)
void	Draw (const std::vector< std::shared_ptr< geometry::Geometry3D >> &geometries, const std::string &window_name, int width, int height, const std::vector< DrawAction > &actions)
void	Draw (const std::vector< std::shared_ptr< t::geometry::Geometry >> &tgeometries, const std::string &window_name, int width, int height, const std::vector< DrawAction > &actions)
void	Draw (const std::vector< std::shared_ptr< rendering::TriangleMeshModel >> &models, const std::string &window_name, int width, int height, const std::vector< DrawAction > &actions)
void	Draw (const std::vector< DrawObject > &objects, const std::string &window_name, int width, int height, const std::vector< DrawAction > &actions)
bool	DrawGeometries (const std::vector< std::shared_ptr< const geometry::Geometry >> &geometry_ptrs, const std::string &window_name="Open3D", int width=640, int height=480, int left=50, int top=50, bool point_show_normal=false, bool mesh_show_wireframe=false, bool mesh_show_back_face=false, Eigen::Vector3d *lookat=nullptr, Eigen::Vector3d *up=nullptr, Eigen::Vector3d *front=nullptr, double *zoom=nullptr)
	Function to draw a list of geometry objects. More...
bool	DrawGeometriesWithCustomAnimation (const std::vector< std::shared_ptr< const geometry::Geometry >> &geometry_ptrs, const std::string &window_name="Open3D", int width=640, int height=480, int left=50, int top=50, const std::string &json_filename="")
	Function to draw a list of geometry objects with a GUI that supports animation. More...
bool	DrawGeometriesWithAnimationCallback (const std::vector< std::shared_ptr< const geometry::Geometry >> &geometry_ptrs, std::function< bool(Visualizer *)> callback_func, const std::string &window_name="Open3D", int width=640, int height=480, int left=50, int top=50)
	Function to draw a list of geometry objects with a customized animation callback function. More...
bool	DrawGeometriesWithKeyCallbacks (const std::vector< std::shared_ptr< const geometry::Geometry >> &geometry_ptrs, const std::map< int, std::function< bool(Visualizer *)>> &key_to_callback, const std::string &window_name="Open3D", int width=640, int height=480, int left=50, int top=50)
	Function to draw a list of geometry. More...
bool	DrawGeometriesWithEditing (const std::vector< std::shared_ptr< const geometry::Geometry >> &geometry_ptrs, const std::string &window_name="Open3D", int width=640, int height=480, int left=50, int top=50)
	Function to draw a list of geometry. More...
bool	DrawGeometriesWithVertexSelection (const std::vector< std::shared_ptr< const geometry::Geometry >> &geometry_ptrs, const std::string &window_name, int width, int height, int left, int top)
std::shared_ptr< gui::Slider >	MakeSlider (const gui::Slider::Type type, const double min, const double max, const double value)

Variables
const std::string	MODEL_NAME = "__model__"
const std::string	INSPECT_MODEL_NAME = "__inspect_model__"
const std::string	WIREFRAME_NAME = "__wireframe_model__"

Enumeration Type Documentation

MenuId

enum open3d::visualization::MenuId

Enumerator
FILE_OPEN
FILE_EXPORT_RGB
FILE_QUIT
SETTINGS_LIGHT_AND_MATERIALS
HELP_KEYS
HELP_CAMERA
HELP_ABOUT
HELP_CONTACT
HELP_DEBUG

Function Documentation

Draw() [1/4]

void open3d::visualization::Draw	(	const std::vector< DrawObject > &	objects,
		const std::string &	window_name,
		int	width,
		int	height,
		const std::vector< DrawAction > &	actions
	)

Draw() [2/4]

void open3d::visualization::Draw	(	const std::vector< std::shared_ptr< geometry::Geometry3D >> &	geometries,
		const std::string &	window_name,
		int	width,
		int	height,
		const std::vector< DrawAction > &	actions
	)

Draw() [3/4]

void open3d::visualization::Draw	(	const std::vector< std::shared_ptr< rendering::TriangleMeshModel >> &	models,
		const std::string &	window_name,
		int	width,
		int	height,
		const std::vector< DrawAction > &	actions
	)

Draw() [4/4]

void open3d::visualization::Draw	(	const std::vector< std::shared_ptr< t::geometry::Geometry >> &	tgeometries,
		const std::string &	window_name,
		int	width,
		int	height,
		const std::vector< DrawAction > &	actions
	)

DrawGeometries()

bool open3d::visualization::DrawGeometries	(	const std::vector< std::shared_ptr< const geometry::Geometry >> &	geometry_ptrs,
		const std::string &	window_name = "Open3D",
		int	width = 640,
		int	height = 480,
		int	left = 50,
		int	top = 50,
		bool	point_show_normal = false,
		bool	mesh_show_wireframe = false,
		bool	mesh_show_back_face = false,
		Eigen::Vector3d *	lookat = nullptr,
		Eigen::Vector3d *	up = nullptr,
		Eigen::Vector3d *	front = nullptr,
		double *	zoom = nullptr
	)

Function to draw a list of geometry objects.

The convenient function of drawing something This function is a wrapper that calls the core functions of Visualizer. This function MUST be called from the main thread. It blocks the main thread until the window is closed.

Parameters

geometry_ptrs	List of geometries to be visualized.
window_name	The displayed title of the visualization window.
width	The width of the visualization window.
height	The height of the visualization window.
left	margin of the visualization window.
top	The top margin of the visualization window.
point_show_normal	visualize point normals if set to true.
mesh_show_wireframe	visualize mesh wireframe if set to true.
mesh_show_back_face	visualize also the back face of the mesh triangles.
lookat	The lookat vector of the camera.
up	The up vector of the camera.
front	The front vector of the camera.
zoom	The zoom of the camera.

DrawGeometriesWithAnimationCallback()

bool open3d::visualization::DrawGeometriesWithAnimationCallback	(	const std::vector< std::shared_ptr< const geometry::Geometry >> &	geometry_ptrs,
		std::function< bool(Visualizer *)>	callback_func,
		const std::string &	window_name = "Open3D",
		int	width = 640,
		int	height = 480,
		int	left = 50,
		int	top = 50
	)

Function to draw a list of geometry objects with a customized animation callback function.

Parameters

geometry_ptrs	List of geometries to be visualized.
callback_func	Call back function to be triggered at a key press event.
window_name	The displayed title of the visualization window.
width	The width of the visualization window.
height	The height of the visualization window.
left	margin of the visualization window.
top	The top margin of the visualization window.

DrawGeometriesWithCustomAnimation()

bool open3d::visualization::DrawGeometriesWithCustomAnimation	(	const std::vector< std::shared_ptr< const geometry::Geometry >> &	geometry_ptrs,
		const std::string &	window_name = "Open3D",
		int	width = 640,
		int	height = 480,
		int	left = 50,
		int	top = 50,
		const std::string &	json_filename = ""
	)

Function to draw a list of geometry objects with a GUI that supports animation.

Parameters

geometry_ptrs	List of geometries to be visualized.
window_name	The displayed title of the visualization window.
width	The width of the visualization window.
height	The height of the visualization window.
left	margin of the visualization window.
top	The top margin of the visualization window.
json_filename	Camera trajectory json file path for custom animation.

DrawGeometriesWithEditing()

bool open3d::visualization::DrawGeometriesWithEditing	(	const std::vector< std::shared_ptr< const geometry::Geometry >> &	geometry_ptrs,
		const std::string &	window_name = "Open3D",
		int	width = 640,
		int	height = 480,
		int	left = 50,
		int	top = 50
	)

Function to draw a list of geometry.

Geometry providing user interaction.

Parameters

geometry_ptrs	List of geometries to be visualized.
window_name	The displayed title of the visualization window.
width	The width of the visualization window.
height	The height of the visualization window.
left	margin of the visualization window.
top	The top margin of the visualization window.

DrawGeometriesWithKeyCallbacks()

bool open3d::visualization::DrawGeometriesWithKeyCallbacks	(	const std::vector< std::shared_ptr< const geometry::Geometry >> &	geometry_ptrs,
		const std::map< int, std::function< bool(Visualizer *)>> &	key_to_callback,
		const std::string &	window_name = "Open3D",
		int	width = 640,
		int	height = 480,
		int	left = 50,
		int	top = 50
	)

Function to draw a list of geometry.

Geometry objects with a customized key-callback mapping

Parameters

geometry_ptrs	List of geometries to be visualized.
key_to_callback	Map of key to call back functions.
window_name	The displayed title of the visualization window.
width	The width of the visualization window.
height	The height of the visualization window.
left	margin of the visualization window.
top	The top margin of the visualization window.

DrawGeometriesWithVertexSelection()

bool open3d::visualization::DrawGeometriesWithVertexSelection	(	const std::vector< std::shared_ptr< const geometry::Geometry >> &	geometry_ptrs,
		const std::string &	window_name,
		int	width,
		int	height,
		int	left,
		int	top
	)

GetGlobalColorMap()

const std::shared_ptr< const ColorMap > open3d::visualization::GetGlobalColorMap

(

)

Interface functions.

MakeSlider()

std::shared_ptr<gui::Slider> open3d::visualization::MakeSlider	(	const gui::Slider::Type	type,
		const double	min,
		const double	max,
		const double	value
	)

SetGlobalColorMap()

void open3d::visualization::SetGlobalColorMap

(

ColorMap::ColorMapOption

option

)

Variable Documentation

INSPECT_MODEL_NAME

const std::string open3d::visualization::INSPECT_MODEL_NAME = "__inspect_model__"

MODEL_NAME

const std::string open3d::visualization::MODEL_NAME = "__model__"

WIREFRAME_NAME

const std::string open3d::visualization::WIREFRAME_NAME = "__wireframe_model__"