Skip to content

Commit

Permalink
Update doc again
Browse files Browse the repository at this point in the history
  • Loading branch information
mwestphal committed Dec 23, 2024
1 parent d67fe39 commit 71d7de4
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 25 deletions.
10 changes: 5 additions & 5 deletions doc/libf3d/OPTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ Option|Type<br>Default<br>Trigger|Description|F3D option
:---:|:---:|:---|:---:
model.matcap.texture|string<br>optional<br>render|Path to a texture file containing a material capture. All other model options for surfaces are ignored if this is set. Model specified by default.|\-\-texture-matcap
model.color.opacity|double<br>optional<br>render|Set *opacity* on the geometry. Usually used with Depth Peeling option. Multiplied with the `model.color.texture` when present. Model specified by default.|\-\-opacity
model.color.rgb|double_vector<br>optional<br>render|Set a *color* on the geometry. Multiplied with the `model.color.texture` when present. Model specified by default.|\-\-color
model.color.rgb|vector\<double\><br>optional<br>render|Set a *color* on the geometry. Multiplied with the `model.color.texture` when present. Model specified by default.|\-\-color
model.color.texture|string<br>optional<br>render|Path to a texture file that sets the color of the object. Will be multiplied with rgb and opacity. Model specified by default.|\-\-texture-base-color
model.emissive.factor|double_vector<br>optional<br>render| Multiply the emissive color when an emissive texture is present. Model specified by default.|\-\-emissive-factor
model.emissive.factor|vector\<double\><br>optional<br>render| Multiply the emissive color when an emissive texture is present. Model specified by default.|\-\-emissive-factor
model.emissive.texture|string<br><br>render|Path to a texture file that sets the emitted light of the object. Multiplied with the `model.emissive.factor`. Model specified by default.|\-\-texture-emissive
model.material.metallic|double<br>optional<br>render|Set the *metallic coefficient* on the geometry (0.0-1.0). Multiplied with the `model.material.texture` when present. Model specified by default.|\-\-metallic
model.material.roughness|double<br>optional<br>render|Set the *roughness coefficient* on the geometry (0.0-1.0). Multiplied with the `model.material.texture` when present. Model specified by default.|\-\-roughness
Expand All @@ -54,10 +54,10 @@ model.normal.scale|double<br>optional<br>render|Normal scale affects the strengt
model.normal.texture|string<br>optional<br>render|Path to a texture file that sets the normal map of the object. Model specified by default.|\-\-texture-normal
model.scivis.enable|bool<br>false<br>render|*Color by an array* present in on the data. If `model.scivis.array_name` is not set, the first available array will be used.|\-\-scalar-coloring
model.scivis.cells|bool<br>false<br>render|Color the data with value found *on the cells* instead of points|\-\-cells
model.scivis.colormap|double_vector<br>\<inferno\><br>render|Set a *custom colormap for the coloring*.<br>This is a list of colors in the format `val1,red1,green1,blue1,...,valN,redN,greenN,blueN`<br>where all values are in the range (0,1).|\-\-colormap
model.scivis.colormap|vector\<double\><br>\<inferno\><br>render|Set a *custom colormap for the coloring*.<br>This is a list of colors in the format `val1,red1,green1,blue1,...,valN,redN,greenN,blueN`<br>where all values are in the range (0,1).|\-\-colormap
model.scivis.component|int<br>-1<br>render|Specify the component to color with. -1 means *magnitude*. -2 means *direct values*.|\-\-comp
model.scivis.array_name|string<br><br>render|Select the name of the array to color with.|\-\-coloring-array
model.scivis.range|double_vector<br>optional<br>render|Set the *coloring range*. Automatically computed by default.|\-\-range
model.scivis.range|vector\<double\><br>optional<br>render|Set the *coloring range*. Automatically computed by default.|\-\-range
model.point_sprites.enable|bool<br>false<br>render|Show sphere *points sprites* instead of the geometry.|\-\-point-sprites
model.point_sprites.type|string<br>sphere<br>render|Set the sprites type when showing point sprites (can be `sphere` or `gaussian`).|\-\-point-stripes-type
model.point_sprites.size|double<br>10.0<br>render|Set the *size* of point sprites.|\-\-point-stripes-size
Expand Down Expand Up @@ -87,7 +87,7 @@ render.raytracing.samples|int<br>5<br>render|The number of *samples per pixel*.|
render.raytracing.denoise|bool<br>false<br>render|*Denoise* the raytracing rendering.|\-\-denoise
render.hdri.file|string<br>optional<br>render|Set the *HDRI* image that can be used for ambient lighting and skybox.<br>Valid file format are hdr, exr, png, jpg, pnm, tiff, bmp.<br>If not set, a default is provided.|\-\-hdri-file
render.hdri.ambient|bool<br>false<br>render|Light the scene using the *HDRI* image as ambient lighting<br>The environment act as a light source and is reflected on the material.|\-\-hdri-ambient
render.background.color|double_vector<br>0.2,0.2,0.2<br>render|Set the window *background color*.<br>Ignored if a *hdri* skybox is used.|\-\-background-color
render.background.color|vector\<double\><br>0.2,0.2,0.2<br>render|Set the window *background color*.<br>Ignored if a *hdri* skybox is used.|\-\-background-color
render.background.skybox|bool<br>false<br>render|Show the *HDRI* image as a skybox<br>Overrides the the background color if any|\-\-hdri-skybox
render.background.blur.enable|bool<br>false<br>render|Blur background, useful with a skybox.|\-\-blur-background
render.background.blur.coc|double<br>20.0<br>render|Blur background circle of confusion radius.|\-\-blur-coc
Expand Down
22 changes: 11 additions & 11 deletions doc/user/OPTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Options|Type<br>Default|Description
-g, \-\-grid|bool<br>false|Show *a grid* aligned with the horizontal (orthogonal to the Up direction) plane.
\-\-grid\-unit=\<length\>|double<br>-|Set the size of the *unit square* for the grid. If not set (the default) a suitable value will be automatically computed.
\-\-grid\-subdivisions=\<count\>|int<br>10|Set the number of subdivisions for the grid.
\-\-grid\-color=\<color\>|double_vector<br>(0,0,0)|Set the color grid lines.
\-\-grid\-color=\<color\>|vector\<double\><br>(0,0,0)|Set the color grid lines.
-e, \-\-edges|bool<br>false|Show the *cell edges*.
\-\-camera-index=\<idx\>|int<br>-|Select the scene camera to use when available in the file. Automatically computed by default.
-k, \-\-trackball|bool<br>false|Enable trackball interaction.
Expand All @@ -59,7 +59,7 @@ Options|Type<br>Default|Description
\-\-point-size=\<size\>|double<br>-|Set the *size* of points when showing vertices. Model specified by default.
\-\-line-width=\<size\>|double<br>-|Set the *width* of lines when showing edges. Model specified by default.
\-\-backface-type=\<visible\|hidden\>|string<br>-|Set the Backface type. Model specified by default.
\-\-color=\<R,G,B\>|double_vector<br>-| Set a *color* on the geometry. Multiplied with the base color texture when present. <br>Model specified by default.
\-\-color=\<R,G,B\>|vector\<double\><br>-| Set a *color* on the geometry. Multiplied with the base color texture when present. <br>Model specified by default.
\-\-opacity=\<opacity\>|double<br>-|Set *opacity* on the geometry. Multiplied with the base color texture when present. <br>Model specified by default. Usually used with Depth Peeling option.
\-\-roughness=\<roughness\>|double<br>-|Set the *roughness coefficient* on the geometry (0.0-1.0). Multiplied with the material texture when present. <br>Model specified by default.
\-\-metallic=\<metallic\>|double<br>-|Set the *metallic coefficient* on the geometry (0.0-1.0). Multiplied with the material texture when present. <br>Model specified by default.
Expand All @@ -69,15 +69,15 @@ Options|Type<br>Default|Description
\-\-texture-base-color=\<texture file\>|string<br>-|Set the texture file to control the color of the object. Please note this will be multiplied with the color and opacity options. Must be in sRGB color space. <br>Model specified by default.
\-\-texture-material=\<texture file\>|string<br>-|Set the texture file to control the occlusion, roughness and metallic values of the object. Please note this will be multiplied with the roughness and metallic options, which have impactful default values. To obtain true results, use \-\-roughness=1 \-\-metallic=1. Must be in linear color space. <br>Model specified by default.
\-\-texture-emissive=\<texture file\>|string<br>-|Set the texture file to control the emitted light of the object. Please note this will be multiplied with the emissive factor. Must be in sRGB color space. <br>Model specified by default.
\-\-emissive-factor=\<R,G,B\>|double_vector<br>-|Set the emissive factor. This value is multiplied with the emissive color when an emissive texture is present. <br>Model specified by default.
\-\-emissive-factor=\<R,G,B\>|vector\<double\><br>-|Set the emissive factor. This value is multiplied with the emissive color when an emissive texture is present. <br>Model specified by default.

## Window options

Options|Type<br>Default|Description
------|------|------
\-\-background-color=\<R,G,B\>|double_vector<br>0.2, 0.2, 0.2|Set the window *background color*.<br>Ignored if *hdri* is set.
\-\-resolution=\<width,height\>|double_vector<br>1000, 600|Set the *window resolution*.
\-\-position=\<x,y\>|double_vector<br>-|Set the *window position* (top left corner) , in pixels, starting from the top left of your screens.
\-\-background-color=\<R,G,B\>|vector\<double\><br>0.2, 0.2, 0.2|Set the window *background color*.<br>Ignored if *hdri* is set.
\-\-resolution=\<width,height\>|vector\<double\><br>1000, 600|Set the *window resolution*.
\-\-position=\<x,y\>|vector\<double\><br>-|Set the *window position* (top left corner) , in pixels, starting from the top left of your screens.
-z, \-\-fps|bool<br>false|Display a rendering *frame per second counter*.
-n, \-\-filename|bool<br>false|Display the *name of the file* on top of the window.
-m, \-\-metadata|bool<br>false|Display the *metadata*.
Expand All @@ -94,7 +94,7 @@ Options|Type<br>Default|Description
\-\-coloring-array=\<array_name\>|string<br>-|The coloring array name to use when coloring.<br>Use \-\-verbose to recover the usable array names.
-y, \-\-comp=\<comp_index\>|int<br>-1|Specify the *component from the scalar* array to color with.<br>Use with the scalar option. -1 means *magnitude*. -2 or the short option, -y, means *direct values*.<br>When using *direct values*, components are used as L, LA, RGB, RGBA values depending on the number of components.
-c, \-\-cells|bool<br>false|Specify that the scalar array is to be found *on the cells* instead of on the points.<br>Use with the scalar option.
\-\-range=\<min,max\>|double_vector<br>-|Set the *coloring range*. Automatically computed by default.<br>Use with the scalar option.
\-\-range=\<min,max\>|vector\<double\><br>-|Set the *coloring range*. Automatically computed by default.<br>Use with the scalar option.
-b, \-\-bar|bool<br>false|Show *scalar bar* of the coloring by array.<br>Use with the scalar option.
\-\-colormap\-file=\<name\>|string<br>-|Set a *colormap file for the coloring*.<br>See [color maps](COLOR_MAPS.md).<br>Use with the scalar option.
\-\-colormap=\<color_list\>|string<br>-|Set a *custom colormap for the coloring*.<br>This is a list of colors in the format `val1,red1,green1,blue1,...,valN,redN,greenN,blueN`<br>where all values are in the range (0,1).<br>Ignored if `--colormap-file` option is specified.<br>Use with the scalar option.
Expand All @@ -105,11 +105,11 @@ Options|Type<br>Default|Description

Options|Type<br>Default|Description
------|------|------
\-\-camera-position=\<X,Y,Z\>|double_vector<br>-|Set the camera position, overrides --camera-direction and camera-zoom-factor.
\-\-camera-focal-point=\<X,Y,Z\>|double_vector<br>-|Set the camera focal point.
\-\-camera-view-up=\<X,Y,Z\>|double_vector<br>-|Set the camera view up vector. Will be orthogonalized.
\-\-camera-position=\<X,Y,Z\>|vector\<double\><br>-|Set the camera position, overrides --camera-direction and camera-zoom-factor.
\-\-camera-focal-point=\<X,Y,Z\>|vector\<double\><br>-|Set the camera focal point.
\-\-camera-view-up=\<X,Y,Z\>|vector\<double\><br>-|Set the camera view up vector. Will be orthogonalized.
\-\-camera-view-angle=\<angle\>|double<br>-|Set the camera view angle, a strictly positive value in degrees.
\-\-camera-direction=\<X,Y,Z\>|double_vector<br>-|Set the camera direction, looking at the focal point.
\-\-camera-direction=\<X,Y,Z\>|vector\<double\><br>-|Set the camera direction, looking at the focal point.
\-\-camera-zoom-factor=\<factor\>|double<br>-|Set the camera zoom factor relative to the autozoom on data, a strictly positive value.
\-\-camera-azimuth-angle=\<angle\>|double<br>0.0|Apply an azimuth transformation to the camera, in degrees, added after other camera options.
\-\-camera-elevation-angle=\<angle\>|double<br>0.0|Apply an elevation transformation to the camera, in degrees, added after other camera options.
Expand Down
19 changes: 10 additions & 9 deletions doc/user/PARSING.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
# Parsing options

When setting options from the [CLI Options](OPTIONS.md), the [commands](COMMANDS.md) or using the [libf3d options string API](../libf3d/OPTIONS.md#string-api), the values are parsed according to their type. If parsing fails, the values is not changed.
When setting options from the [CLI Options](OPTIONS.md), the [commands](COMMANDS.md) or using the [libf3d options string API](../libf3d/OPTIONS.md#string-api), the values are parsed according to their type. If parsing fails, the value is not changed.

The following types are supported:
- bool
- int
- double
- ratio
- string
- bool: A boolean, true or false.
- int: An signed integer.
- double: A floating point number.
- ratio: A double dividend over a double divisor, stored in a double.
- string: A string of characters.

As well as vectors for each of these types.
As well as a list for each of these types, noted as
- vector\<type\>

## Bool

Expand Down Expand Up @@ -39,8 +40,8 @@ with removing the point and precision when the value is exactly an integer.
## Ratio

The following formats are supported when parsing a string into a ratio:
- percent%
- dividend/divisor
- percent% where percent is a double
- dividend/divisor where both are doubles
- double

Percent, dividend, divisor are then parsed as double.
Expand Down

0 comments on commit 71d7de4

Please sign in to comment.