Everything render_view() can be told to do. More...

#include <render_view.hpp>

Collaboration diagram for reusex::visualize::RenderOptions:

[legend]

Public Attributes
std::vector< Layer >	layers {Layer::cloud}
	Layers to draw.
std::string	cloud_name = "cloud"
	Named geometry cloud supplying point positions for every point layer.
std::string	mesh_name = "mesh"
	Named mesh drawn by Layer::mesh.
ViewPreset	view = ViewPreset::top
int	orbit_count = 8
	Number of viewpoints on the orbit ring (--view orbit:N).
int	orbit_index = 0
	Which of the orbit_count viewpoints to render, in [0, orbit_count).
double	orbit_elevation_deg = 25.0
	Height of the orbit ring above the scene centre, in degrees.
std::optional< CameraSpec >	camera
	Camera used when view == ViewPreset::explicit_camera.
bool	cut = false
	Clip away everything above a horizontal cut plane before rendering.
std::optional< double >	cut_height
	Height of the cut plane above the floor, in metres.
int	width = 1600
int	height = 1200
std::array< double, 3 >	background {0.11, 0.12, 0.14}
	Background colour as linear RGB in [0, 1].
double	point_size = 2.0
	Point sprite size in pixels.
double	margin = 1.08
	Framing slack around the scene bounding box: 1.0 is a tight fit, larger pulls back, smaller crops in.

Detailed Description

Everything render_view() can be told to do.

This struct is the single definition of every render default; rux render mirrors these values into its --help and never redefines them (STANDARDS §4).

Definition at line 130 of file render_view.hpp.

Member Data Documentation

◆ background

std::array<double, 3> reusex::visualize::RenderOptions::background {0.11, 0.12, 0.14}

Background colour as linear RGB in [0, 1].

Definition at line 171 of file render_view.hpp.

◆ camera

std::optional<CameraSpec> reusex::visualize::RenderOptions::camera

Camera used when view == ViewPreset::explicit_camera.

Definition at line 151 of file render_view.hpp.

◆ cloud_name

std::string reusex::visualize::RenderOptions::cloud_name = "cloud"

Named geometry cloud supplying point positions for every point layer.

Definition at line 137 of file render_view.hpp.

◆ cut

bool reusex::visualize::RenderOptions::cut = false

Clip away everything above a horizontal cut plane before rendering.

Implied by ViewPreset::plan and settable on its own, so any view can be cut — --view orbit:8 --cut-height 1.2 is a cut axonometric.

Definition at line 157 of file render_view.hpp.

◆ cut_height

std::optional<double> reusex::visualize::RenderOptions::cut_height

Height of the cut plane above the floor, in metres.

std::nullopt means derive it: kDefaultCutHeightM above the lowest horizontal plane in plane_centroids / plane_normals, or kDefaultCutBboxFraction of the vertical extent above the bounding box's lower face when the project has no plane segmentation.

Definition at line 165 of file render_view.hpp.

◆ height

int reusex::visualize::RenderOptions::height = 1200

Definition at line 168 of file render_view.hpp.

◆ layers

std::vector<Layer> reusex::visualize::RenderOptions::layers {Layer::cloud}

Layers to draw.

Empty is an error. All layers are opaque and depth-tested, so the order only matters where two layers put geometry at the same depth (e.g. cloud and planes, which draw the same points).

Definition at line 134 of file render_view.hpp.

◆ margin

double reusex::visualize::RenderOptions::margin = 1.08

Framing slack around the scene bounding box: 1.0 is a tight fit, larger pulls back, smaller crops in.

Must be positive.

Definition at line 178 of file render_view.hpp.

◆ mesh_name

std::string reusex::visualize::RenderOptions::mesh_name = "mesh"

Named mesh drawn by Layer::mesh.

Definition at line 139 of file render_view.hpp.

◆ orbit_count

int reusex::visualize::RenderOptions::orbit_count = 8

Number of viewpoints on the orbit ring (--view orbit:N).

Definition at line 144 of file render_view.hpp.

◆ orbit_elevation_deg

double reusex::visualize::RenderOptions::orbit_elevation_deg = 25.0

Height of the orbit ring above the scene centre, in degrees.

Definition at line 148 of file render_view.hpp.

◆ orbit_index

int reusex::visualize::RenderOptions::orbit_index = 0

Which of the orbit_count viewpoints to render, in [0, orbit_count).

Definition at line 146 of file render_view.hpp.

◆ point_size

double reusex::visualize::RenderOptions::point_size = 2.0

Point sprite size in pixels.

Definition at line 174 of file render_view.hpp.

◆ view

ViewPreset reusex::visualize::RenderOptions::view = ViewPreset::top

Definition at line 141 of file render_view.hpp.

◆ width

int reusex::visualize::RenderOptions::width = 1600

Definition at line 167 of file render_view.hpp.

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

libs/reusex/include/visualize/render_view.hpp

Public Attributes