Easy3D 2.5.3
easy3d::setting Namespace Reference

Default parameters used for initializing rendering and UI. More...

Functions

void initialize (const std::string &setting_file="default")
 Initializes the default setting for rendering. More...
 
bool save (const std::string &filename)
 Save the setting (i.e., rendering parameters) to a file.
 
bool load (const std::string &filename)
 Load the setting (i.e., rendering parameters) from a file.
 

Variables

vec4 background_color = vec4(0.9f, 0.9f, 1.0f, 1.0f)
 background color of the viewer
 
vec4 highlight_color = vec4(1.0f, 0.0f, 0.0f, 1.0f)
 highlight: color for highlighted/selected primitives
 
vec4 light_position = vec4(0.27f, 0.27f, 0.92f, 0.0f)
 lighting
 
vec4 material_ambient = vec4(0.05f, 0.05f, 0.05f, 1.0f)
 material
 
vec4 material_specular = vec4(0.4f, 0.4f, 0.4f, 1.0f)
 
float material_shininess = 64.0f
 
float effect_ssao_radius = 2.0f
 effect
 
float effect_ssao_intensity = 1.5f
 
float effect_ssao_bias = 0.1f
 
float effect_ssao_sharpness = 40.0f
 
bool effect_edl_enabled = false
 
bool effect_transparency_enabled = false
 
bool effect_shadow_enabled = false
 
float effect_shadow_light_distance = 50.0f
 
float effect_shadow_softness = 0.5f
 
float effect_shadow_darkness = 0.6f
 
bool points_drawable_two_side_lighting = true
 points drawable
 
bool points_drawable_distinct_backside_color = false
 
vec4 points_drawable_backside_color = vec4(0.8f, 0.4f, 0.4f, 1.0f)
 
bool lines_drawable_two_side_lighting = false
 
bool lines_drawable_distinct_backside_color = false
 
vec4 lines_drawable_backside_color = vec4(0.8f, 0.4f, 0.4f, 1.0f)
 
bool triangles_drawable_two_side_lighting = true
 
bool triangles_drawable_distinct_backside_color = true
 
vec4 triangles_drawable_backside_color = vec4(0.8f, 0.4f, 0.4f, 1.0f)
 
bool point_cloud_vertices_visible = true
 point cloud
 
vec4 point_cloud_vertices_color = vec4(0.33f, 0.67f, 1.0f, 1.0f)
 
bool point_cloud_vertices_impostors = false
 
float point_cloud_vertices_size = 3.0f
 
bool surface_mesh_faces_phong_shading = false
 surface mesh - surface
 
bool surface_mesh_faces_visible = true
 
vec4 surface_mesh_faces_color = vec4(1.0f, 0.8f, 0.4f, 1.0f)
 
float surface_mesh_faces_opacity = 0.6f
 
bool surface_mesh_vertices_visible = false
 surface mesh - vertices
 
vec4 surface_mesh_vertices_color = vec4(0.0f, 1.0f, 0.0f, 1.0f)
 
bool surface_mesh_vertices_imposters = true
 
float surface_mesh_vertices_size = 5.0f
 
bool surface_mesh_edges_visible = false
 surface mesh - edges
 
vec4 surface_mesh_edges_color = vec4(0.0f, 0.0f, 0.0f, 1.0f)
 
bool surface_mesh_edges_imposters = false
 
float surface_mesh_edges_size = 1.0f
 
bool surface_mesh_borders_visible = false
 surface mesh - borders
 
vec4 surface_mesh_borders_color = vec4(1.0f, 0.0f, 0.0f, 1.0f)
 
bool surface_mesh_borders_imposters = true
 
float surface_mesh_borders_size = 2.0f
 
bool graph_vertices_visible = true
 graph: vertices
 
vec4 graph_vertices_color = vec4(0.8f, 0.0f, 0.5f, 1.0f)
 
bool graph_vertices_imposters = true
 
float graph_vertices_size = 15
 
bool graph_edges_visible = true
 graph: edges
 
vec4 graph_edges_color = vec4(1.0f, 0.67f, 0.5f, 1.0f)
 
bool graph_edges_imposters = true
 
float graph_edges_size = 3.0f
 
bool poly_mesh_faces_visible = true
 polyhedral mesh - surface
 
vec4 poly_mesh_faces_color = vec4(1.0f, 0.8f, 0.4f, 1.0f)
 
bool poly_mesh_vertices_visible = false
 polyhedral mesh - vertices
 
vec4 poly_mesh_vertices_color = vec4(0.0f, 1.0f, 0.0f, 1.0f)
 
bool poly_mesh_vertices_imposters = true
 
float poly_mesh_vertices_size = 5.0f
 
bool poly_mesh_edges_visible = false
 polyhedral mesh - edges
 
vec4 poly_mesh_edges_color = vec4(0.0f, 0.0f, 0.0f, 1.0f)
 
bool poly_mesh_edges_imposters = false
 
float poly_mesh_edges_size = 1.0f
 
vec4 clipping_plane_color = vec4(1.0f, 0.0f, 0.0f, 0.2f)
 clipping plane
 

Detailed Description

Default parameters used for initializing rendering and UI.

Function Documentation

◆ initialize()

void initialize ( const std::string &  setting_file = "default")

Initializes the default setting for rendering.

By calling this function with a valid file name, a setting file with an extension ".ini" will be created on the first startup of the program. This setting file stores the default rendering parameters. Users can modify this file to change the default rendering parameters, then the changes will be effective for the future.

Parameters
setting_fileA string specifying the name of setting file. Three different values are accepted:
  • ""(an empty string): indicating that no setting file will be created.
  • "default": create a setting file with a title in the form "AppName.ini" next to the executable file.
  • any non-empty string: (if it is a valid path) a setting file with the same name will be created and rendering parameters will be written to this file.