Defines rendering options for visualizer. More...

#include <RenderOption.h>

Inheritance diagram for open3d::visualization::RenderOption:

Public Types
enum	TextureInterpolationOption { TextureInterpolationOption::Nearest = 0, TextureInterpolationOption::Linear = 1 }

enum	DepthFunc { DepthFunc::Never = 0, DepthFunc::Less = 1, DepthFunc::Equal = 2, DepthFunc::LEqual = 3, DepthFunc::Greater = 4, DepthFunc::NotEqual = 5, DepthFunc::GEqual = 6, DepthFunc::Always = 7 }

enum	PointColorOption { PointColorOption::Default = 0, PointColorOption::Color = 1, PointColorOption::XCoordinate = 2, PointColorOption::YCoordinate = 3, PointColorOption::ZCoordinate = 4, PointColorOption::Normal = 9 }
	Enum class for point color for PointCloud. More...

enum	MeshShadeOption { MeshShadeOption::FlatShade = 0, MeshShadeOption::SmoothShade = 1 }
	Enum class for mesh shading for TriangleMesh. More...

enum	MeshColorOption { MeshColorOption::Default = 0, MeshColorOption::Color = 1, MeshColorOption::XCoordinate = 2, MeshColorOption::YCoordinate = 3, MeshColorOption::ZCoordinate = 4, MeshColorOption::Normal = 9 }
	Enum class for color for TriangleMesh. More...

enum	ImageStretchOption { ImageStretchOption::OriginalSize = 0, ImageStretchOption::StretchKeepRatio = 1, ImageStretchOption::StretchWithWindow = 2 }

Public Member Functions
	RenderOption ()
	Default Constructor. More...

	~RenderOption () override

bool	ConvertToJsonValue (Json::Value &value) const override

bool	ConvertFromJsonValue (const Json::Value &value) override

void	ToggleLightOn ()

void	ToggleInterpolationOption ()

void	ChangePointSize (double change)

void	SetPointSize (double size)

void	ChangeLineWidth (double change)

void	TogglePointShowNormal ()

void	ToggleShadingOption ()

void	ToggleMeshShowBackFace ()

void	ToggleMeshShowWireframe ()

void	ToggleImageStretchOption ()

int	GetGLDepthFunc () const

Public Member Functions inherited from open3d::utility::IJsonConvertible
virtual	~IJsonConvertible ()

virtual std::string	ToString () const
	Convert to a styled string representation of JSON data for display. More...

Data Fields
const double	POINT_SIZE_MAX = 25.0

const double	POINT_SIZE_MIN = 1.0

const double	POINT_SIZE_STEP = 1.0

const double	POINT_SIZE_DEFAULT = 5.0

const double	LINE_WIDTH_MAX = 10.0

const double	LINE_WIDTH_MIN = 1.0

const double	LINE_WIDTH_STEP = 1.0

const double	LINE_WIDTH_DEFAULT = 1.0

Eigen::Vector3d	background_color_ = Eigen::Vector3d::Ones()
	Background RGB color. More...

TextureInterpolationOption	interpolation_option_

DepthFunc	depthFunc_ = DepthFunc::Less

bool	light_on_ = true
	Whether to turn on Phong lighting. More...

Eigen::Vector3d	light_position_relative_ [4]

Eigen::Vector3d	light_color_ [4]

Eigen::Vector3d	light_ambient_color_ = Eigen::Vector3d::Zero()

double	light_diffuse_power_ [4]

double	light_specular_power_ [4]

double	light_specular_shininess_ [4]

double	point_size_ = POINT_SIZE_DEFAULT
	Point size for PointCloud. More...

PointColorOption	point_color_option_ = PointColorOption::Default
	Point color option for PointCloud. More...

bool	point_show_normal_ = false
	Whether to show normal for PointCloud. More...

MeshShadeOption	mesh_shade_option_ = MeshShadeOption::FlatShade
	Mesh shading option for TriangleMesh. More...

MeshColorOption	mesh_color_option_ = MeshColorOption::Color
	Color option for TriangleMesh. More...

bool	mesh_show_back_face_ = false
	Whether to show back faces for TriangleMesh. More...

bool	mesh_show_wireframe_ = false

Eigen::Vector3d	default_mesh_color_ = Eigen::Vector3d(0.7, 0.7, 0.7)

double	line_width_ = LINE_WIDTH_DEFAULT
	Line width for LineSet. More...

ImageStretchOption	image_stretch_option_

int	image_max_depth_ = 3000

bool	show_coordinate_frame_ = false
	Whether to show coordinate frame. More...

Additional Inherited Members
Static Public Member Functions inherited from open3d::utility::IJsonConvertible
static bool	EigenVector3dFromJsonArray (Eigen::Vector3d &vec, const Json::Value &value)

static bool	EigenVector3dToJsonArray (const Eigen::Vector3d &vec, Json::Value &value)

static bool	EigenVector4dFromJsonArray (Eigen::Vector4d &vec, const Json::Value &value)

static bool	EigenVector4dToJsonArray (const Eigen::Vector4d &vec, Json::Value &value)

static bool	EigenMatrix3dFromJsonArray (Eigen::Matrix3d &mat, const Json::Value &value)

static bool	EigenMatrix3dToJsonArray (const Eigen::Matrix3d &mat, Json::Value &value)

static bool	EigenMatrix4dFromJsonArray (Eigen::Matrix4d &mat, const Json::Value &value)

static bool	EigenMatrix4dToJsonArray (const Eigen::Matrix4d &mat, Json::Value &value)

static bool	EigenMatrix4dFromJsonArray (Eigen::Matrix4d_u &mat, const Json::Value &value)

static bool	EigenMatrix4dToJsonArray (const Eigen::Matrix4d_u &mat, Json::Value &value)

static bool	EigenMatrix6dFromJsonArray (Eigen::Matrix6d &mat, const Json::Value &value)

static bool	EigenMatrix6dToJsonArray (const Eigen::Matrix6d &mat, Json::Value &value)

static bool	EigenMatrix6dFromJsonArray (Eigen::Matrix6d_u &mat, const Json::Value &value)

static bool	EigenMatrix6dToJsonArray (const Eigen::Matrix6d_u &mat, Json::Value &value)

Detailed Description

Defines rendering options for visualizer.

Member Enumeration Documentation

◆ DepthFunc

enum open3d::visualization::RenderOption::DepthFunc

strong

Enumerator
Never
Less
Equal
LEqual
Greater
NotEqual
GEqual
Always

◆ ImageStretchOption

enum open3d::visualization::RenderOption::ImageStretchOption

strong

Enumerator
OriginalSize
StretchKeepRatio
StretchWithWindow

◆ MeshColorOption

enum open3d::visualization::RenderOption::MeshColorOption

strong

Enum class for color for TriangleMesh.

Enumerator
Default
Color
XCoordinate
YCoordinate
ZCoordinate
Normal

◆ MeshShadeOption

enum open3d::visualization::RenderOption::MeshShadeOption

strong

Enum class for mesh shading for TriangleMesh.

Enumerator
FlatShade
SmoothShade

◆ PointColorOption

enum open3d::visualization::RenderOption::PointColorOption

strong

Enum class for point color for PointCloud.

Enumerator
Default
Color
XCoordinate
YCoordinate
ZCoordinate
Normal

◆ TextureInterpolationOption

enum open3d::visualization::RenderOption::TextureInterpolationOption

strong

Enumerator
Nearest
Linear

Constructor & Destructor Documentation

◆ RenderOption()

open3d::visualization::RenderOption::RenderOption ( )

inline

Default Constructor.

◆ ~RenderOption()

open3d::visualization::RenderOption::~RenderOption ( )

inlineoverride

Member Function Documentation

◆ ChangeLineWidth()

void open3d::visualization::RenderOption::ChangeLineWidth ( double change )

◆ ChangePointSize()

void open3d::visualization::RenderOption::ChangePointSize ( double change )

◆ ConvertFromJsonValue()

bool open3d::visualization::RenderOption::ConvertFromJsonValue ( const Json::Value & value )

overridevirtual

Implements open3d::utility::IJsonConvertible.

Reimplemented in open3d::visualization::RenderOptionWithEditing.

◆ ConvertToJsonValue()

bool open3d::visualization::RenderOption::ConvertToJsonValue ( Json::Value & value ) const

overridevirtual

Implements open3d::utility::IJsonConvertible.

Reimplemented in open3d::visualization::RenderOptionWithEditing.

◆ GetGLDepthFunc()

int open3d::visualization::RenderOption::GetGLDepthFunc ( ) const

◆ SetPointSize()

void open3d::visualization::RenderOption::SetPointSize ( double size )

◆ ToggleImageStretchOption()

void open3d::visualization::RenderOption::ToggleImageStretchOption ( )

inline

◆ ToggleInterpolationOption()

void open3d::visualization::RenderOption::ToggleInterpolationOption ( )

inline

◆ ToggleLightOn()

void open3d::visualization::RenderOption::ToggleLightOn ( )

inline

◆ ToggleMeshShowBackFace()

void open3d::visualization::RenderOption::ToggleMeshShowBackFace ( )

inline

◆ ToggleMeshShowWireframe()

void open3d::visualization::RenderOption::ToggleMeshShowWireframe ( )

inline

◆ TogglePointShowNormal()

void open3d::visualization::RenderOption::TogglePointShowNormal ( )

inline

◆ ToggleShadingOption()

void open3d::visualization::RenderOption::ToggleShadingOption ( )

inline

Field Documentation

◆ background_color_

Eigen::Vector3d open3d::visualization::RenderOption::background_color_ = Eigen::Vector3d::Ones()

Background RGB color.

◆ default_mesh_color_

Eigen::Vector3d open3d::visualization::RenderOption::default_mesh_color_ = Eigen::Vector3d(0.7, 0.7, 0.7)

◆ depthFunc_

DepthFunc open3d::visualization::RenderOption::depthFunc_ = DepthFunc::Less

◆ image_max_depth_

int open3d::visualization::RenderOption::image_max_depth_ = 3000

◆ image_stretch_option_

ImageStretchOption open3d::visualization::RenderOption::image_stretch_option_

Initial value:

=

ImageStretchOption::StretchKeepRatio

◆ interpolation_option_

TextureInterpolationOption open3d::visualization::RenderOption::interpolation_option_

Initial value:

=

TextureInterpolationOption::Nearest

◆ light_ambient_color_

Eigen::Vector3d open3d::visualization::RenderOption::light_ambient_color_ = Eigen::Vector3d::Zero()

◆ light_color_

Eigen::Vector3d open3d::visualization::RenderOption::light_color_[4]

◆ light_diffuse_power_

double open3d::visualization::RenderOption::light_diffuse_power_[4]

◆ light_on_

bool open3d::visualization::RenderOption::light_on_ = true

Whether to turn on Phong lighting.

◆ light_position_relative_

Eigen::Vector3d open3d::visualization::RenderOption::light_position_relative_[4]

◆ light_specular_power_

double open3d::visualization::RenderOption::light_specular_power_[4]

◆ light_specular_shininess_

double open3d::visualization::RenderOption::light_specular_shininess_[4]

◆ line_width_

double open3d::visualization::RenderOption::line_width_ = LINE_WIDTH_DEFAULT

Line width for LineSet.

◆ LINE_WIDTH_DEFAULT

const double open3d::visualization::RenderOption::LINE_WIDTH_DEFAULT = 1.0

◆ LINE_WIDTH_MAX

const double open3d::visualization::RenderOption::LINE_WIDTH_MAX = 10.0

◆ LINE_WIDTH_MIN

const double open3d::visualization::RenderOption::LINE_WIDTH_MIN = 1.0

◆ LINE_WIDTH_STEP

const double open3d::visualization::RenderOption::LINE_WIDTH_STEP = 1.0

◆ mesh_color_option_

MeshColorOption open3d::visualization::RenderOption::mesh_color_option_ = MeshColorOption::Color

Color option for TriangleMesh.

◆ mesh_shade_option_

MeshShadeOption open3d::visualization::RenderOption::mesh_shade_option_ = MeshShadeOption::FlatShade

Mesh shading option for TriangleMesh.

◆ mesh_show_back_face_

bool open3d::visualization::RenderOption::mesh_show_back_face_ = false

Whether to show back faces for TriangleMesh.

◆ mesh_show_wireframe_

bool open3d::visualization::RenderOption::mesh_show_wireframe_ = false

◆ point_color_option_

PointColorOption open3d::visualization::RenderOption::point_color_option_ = PointColorOption::Default

Point color option for PointCloud.

◆ point_show_normal_

bool open3d::visualization::RenderOption::point_show_normal_ = false

Whether to show normal for PointCloud.

◆ point_size_

double open3d::visualization::RenderOption::point_size_ = POINT_SIZE_DEFAULT

Point size for PointCloud.

◆ POINT_SIZE_DEFAULT

const double open3d::visualization::RenderOption::POINT_SIZE_DEFAULT = 5.0

◆ POINT_SIZE_MAX

const double open3d::visualization::RenderOption::POINT_SIZE_MAX = 25.0

◆ POINT_SIZE_MIN

const double open3d::visualization::RenderOption::POINT_SIZE_MIN = 1.0

◆ POINT_SIZE_STEP

const double open3d::visualization::RenderOption::POINT_SIZE_STEP = 1.0

◆ show_coordinate_frame_

bool open3d::visualization::RenderOption::show_coordinate_frame_ = false

Whether to show coordinate frame.

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

/home/runner/work/Open3D/Open3D/cpp/open3d/visualization/visualizer/RenderOption.h (313315d (Wed Dec 23 23:39:47 2020 -0800))
/home/runner/work/Open3D/Open3D/cpp/open3d/visualization/visualizer/RenderOption.cpp (313315d (Wed Dec 23 23:39:47 2020 -0800))

Public Types

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ DepthFunc

◆ ImageStretchOption

◆ MeshColorOption

◆ MeshShadeOption

◆ PointColorOption

◆ TextureInterpolationOption

Constructor & Destructor Documentation

◆ RenderOption()

◆ ~RenderOption()

Member Function Documentation

◆ ChangeLineWidth()

◆ ChangePointSize()

◆ ConvertFromJsonValue()

◆ ConvertToJsonValue()

◆ GetGLDepthFunc()

◆ SetPointSize()

◆ ToggleImageStretchOption()

◆ ToggleInterpolationOption()

◆ ToggleLightOn()

◆ ToggleMeshShowBackFace()

◆ ToggleMeshShowWireframe()

◆ TogglePointShowNormal()

◆ ToggleShadingOption()

Field Documentation

◆ background_color_

◆ default_mesh_color_

◆ depthFunc_

◆ image_max_depth_

◆ image_stretch_option_

◆ interpolation_option_

◆ light_ambient_color_

◆ light_color_

◆ light_diffuse_power_

◆ light_on_

◆ light_position_relative_

◆ light_specular_power_

◆ light_specular_shininess_

◆ line_width_

◆ LINE_WIDTH_DEFAULT

◆ LINE_WIDTH_MAX

◆ LINE_WIDTH_MIN

◆ LINE_WIDTH_STEP

◆ mesh_color_option_

◆ mesh_shade_option_

◆ mesh_show_back_face_

◆ mesh_show_wireframe_

◆ point_color_option_

◆ point_show_normal_

◆ point_size_

◆ POINT_SIZE_DEFAULT

◆ POINT_SIZE_MAX

◆ POINT_SIZE_MIN

◆ POINT_SIZE_STEP

◆ show_coordinate_frame_