1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
#ifndef F3DOptionsTools_h
#define F3DOptionsTools_h
/**
* @class F3DOptionsTools
* @brief A namespace to handle and parse F3D Options
*/
#include <filesystem>
#include <map>
#include <string>
#include <tuple>
#include <vector>
namespace F3DOptionsTools
{
using OptionsDict = std::map<std::string, std::string>;
using OptionsEntry = std::tuple<OptionsDict, std::string, std::string>;
using OptionsEntries = std::vector<OptionsEntry>;
/**
* The "App" CLI options and their default values as string.
* Some F3D CLI options are not translated into libf3d options
* but into applicative code.
* Initialization is string based for easier processing in F3DStarter::UpdateOptions
* and ParseCLIOptions
*/
static inline const OptionsDict DefaultAppOptions = {
{ "input", "" },
{ "output", "" },
{ "list-bindings", "false" },
{ "no-background", "false" },
{ "config", "" },
{ "no-config", "false" },
{ "no-render", "false" },
{ "rendering-backend", "auto" },
{ "max-size", "" },
{ "animation-time", "" },
{ "watch", "false" },
{ "load-plugins", "" },
{ "screenshot-filename", "{app}/{model}_{n}.png" },
{ "verbose", "info" },
{ "multi-file-mode", "single" },
{ "resolution", "1000, 600" },
{ "position", "" },
{ "colormap-file", "" },
{ "camera-position", "" },
{ "camera-focal-point", "" },
{ "camera-view-up", "" },
{ "camera-view-angle", "0.0" },
{ "camera-direction", "" },
{ "camera-zoom-factor", "0.0" },
{ "camera-azimuth-angle", "0.0" },
{ "camera-elevation-angle", "0.0" },
{ "reference", "" },
{ "reference-threshold", "0.04" },
{ "interaction-test-record", "" },
{ "interaction-test-play", "" },
{ "command-script", "" },
{ "frame-rate", "30.0" },
};
/**
* Mapping of CLI option name to their libf3d options name counterpart
*/
static inline const std::map<std::string_view, std::string_view> LibOptionsNames = {
{ "loading-progress", "ui.loader_progress" },
{ "animation-progress", "ui.animation_progress" },
{ "up", "scene.up_direction" },
{ "axis", "ui.axis" },
{ "grid", "render.grid.enable" },
{ "grid-absolute", "render.grid.absolute" },
{ "grid-unit", "render.grid.unit" },
{ "grid-subdivisions", "render.grid.subdivisions" },
{ "grid-color", "render.grid.color" },
{ "edges", "render.show_edges" },
{ "armature", "render.armature.enable" },
{ "camera-index", "scene.camera.index" },
{ "interaction-trackball", "interactor.trackball" },
{ "invert-zoom", "interactor.invert_zoom" },
{ "animation-autoplay", "scene.animation.autoplay" },
{ "animation-index", "scene.animation.index" },
{ "animation-speed-factor", "scene.animation.speed_factor" },
{ "font-file", "ui.font_file" },
{ "font-scale", "ui.scale" },
{ "point-sprites", "model.point_sprites.enable" },
{ "point-sprites-type", "model.point_sprites.type" },
{ "point-sprites-size", "model.point_sprites.size" },
{ "point-size", "render.point_size" },
{ "line-width", "render.line_width" },
{ "backface-type", "render.backface_type" },
{ "color", "model.color.rgb" },
{ "opacity", "model.color.opacity" },
{ "roughness", "model.material.roughness" },
{ "metallic", "model.material.metallic" },
{ "hdri-file", "render.hdri.file" },
{ "hdri-ambient", "render.hdri.ambient" },
{ "hdri-skybox", "render.background.skybox" },
{ "texture-matcap", "model.matcap.texture" },
{ "texture-base-color", "model.color.texture" },
{ "texture-material", "model.material.texture" },
{ "texture-emissive", "model.emissive.texture" },
{ "emissive-factor", "model.emissive.factor" },
{ "texture-normal", "model.normal.texture" },
{ "normal-scale", "model.normal.scale" },
{ "background-color", "render.background.color" },
{ "fps", "ui.fps" },
{ "filename", "ui.filename" },
{ "metadata", "ui.metadata" },
{ "blur-background", "render.background.blur.enable" },
{ "blur-coc", "render.background.blur.coc" },
{ "scalar-coloring", "model.scivis.enable" },
{ "coloring-array", "model.scivis.array_name" },
{ "light-intensity", "render.light.intensity" },
{ "coloring-component", "model.scivis.component" },
{ "coloring-by-cells", "model.scivis.cells" },
{ "coloring-range", "model.scivis.range" },
{ "coloring-scalar-bar", "ui.scalar_bar" },
{ "colormap", "model.scivis.colormap" },
{ "volume", "model.volume.enable" },
{ "volume-inverse", "model.volume.inverse" },
{ "camera-orthographic", "scene.camera.orthographic" },
{ "raytracing", "render.raytracing.enable" },
{ "raytracing-samples", "render.raytracing.samples" },
{ "raytracing-denoise", "render.raytracing.denoise" },
{ "translucency-support", "render.effect.translucency_support" },
{ "ambient-occlusion", "render.effect.ambient_occlusion" },
{ "anti-aliasing", "render.effect.antialiasing.enable" },
{ "anti-aliasing-mode", "render.effect.antialiasing.mode" },
{ "tone-mapping", "render.effect.tone_mapping" },
{ "final-shader", "render.effect.final_shader" },
};
/**
* Browse through all possible option names to find one that have the smallest distance to the
* provided option.
* If checkLibAndReaders is true, even check in the libf3d and reader option names from plugins
* Return a pair containing the closest option name and the associated distance
*/
std::pair<std::string, int> GetClosestOption(
const std::string& option, bool checkLibAndReaders = false);
/**
* Parse CLI options from provided argc/argv and returns them as a OptionsDict.
* Also set positionals vector in the process.
* Do not parse option value into actual values.
*/
F3DOptionsTools::OptionsDict ParseCLIOptions(
int argc, char** argv, std::vector<std::string>& positionals);
/**
* Log provided key and help with nice formatting
*/
void PrintHelpPair(
std::string_view key, std::string_view help, int keyWidth = 10, int helpWidth = 70);
};
#endif
|
