htrdr

commit e797a6ef492552f1ff6a31844ff41a80a9d617e7
parent b2a30edb703380fad482fbdb2ce4afe5c51c389c
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Wed, 25 Aug 2021 15:51:48 +0200

Write the orthographic camera documentation

Diffstat:
M
doc/htrdr-atmosphere.1.txt.in
 | 
30
+++++++++++++++++++++++++-----
M
doc/htrdr-combustion.1.txt.in
 | 
30
+++++++++++++++++++++++++-----

2 files changed, 50 insertions(+), 10 deletions(-)
diff --git a/doc/htrdr-atmosphere.1.txt.in b/doc/htrdr-atmosphere.1.txt.in
@@ -106,7 +106,7 @@ OPTIONS
   **focal-dst**=**_dst_**;;
     Distance to focus on with a thin lens camera, that is, a camera whose
     *lens-radius* is not zero. The default focal distance is
-    @HTRDR_ARGS_DEFAULT_CAMERA_FOCAL_DST@ meter.
+    @HTRDR_ARGS_DEFAULT_CAMERA_PERSPECTIVE_FOCAL_DST@ meter.
 
   **focal-length**=**_length_**;;
     Focal length of a camera lens. It is another way to control the field of
@@ -115,14 +115,15 @@ OPTIONS
 
   **fov**=**_angle_**;;
     Vertical field of view of the camera in
-    ]@HTRDR_ARGS_CAMERA_FOV_EXCLUSIVE_MIN@,
-    @HTRDR_ARGS_CAMERA_FOV_EXCLUSIVE_MAX@[ degrees. By default _angle_ is set to
-    @HTRDR_ARGS_DEFAULT_CAMERA_FOV@ degrees.
+    ]@HTRDR_ARGS_CAMERA_PERSPECTIVE_FOV_EXCLUSIVE_MIN@,
+    @HTRDR_ARGS_CAMERA_PERSPECTIVE_FOV_EXCLUSIVE_MAX@[ degrees. By
+    default _angle_ is set to
+    @HTRDR_ARGS_DEFAULT_CAMERA_PERSPECTIVE_FOV@ degrees.
 
   **lens-radius**=**_radius_**;;
     Radius of the camera lens. A non-zero radius means that the camera is a
     thin lens camera while a zero radius defines a pinhole camera. By default
-    the lens radius is @HTRDR_ARGS_DEFAULT_CAMERA_LENS_RADIUS@.
+    the lens radius is @HTRDR_ARGS_DEFAULT_CAMERA_PERSPECTIVE_LENS_RADIUS@.
 
   **pos**=**_x_**,**_y_**,**_z_**;;
     Camera lens position. By default it is set to
@@ -212,6 +213,25 @@ OPTIONS
   File where *htrdr-atmosphere* writes its _output_ data. If not defined, write
   results to standard output.
 
+*-P* <__camera-parameter__:...>::
+  Define an orthographic camera. Available parameters are:
+
+  **height**=**_radius_**;;
+    Height of the image plane. By default it is set to
+    @HTRDR_ARGS_DEFAULT_CAMERA_ORTHOGRAPHIC_HEIGHT@.
+
+  **pos**=**_x_**,**_y_**,**_z_**;;
+    Camera lens position. By default it is set to
+    {@HTRDR_ARGS_DEFAULT_CAMERA_POS@}.
+
+  **tgt**=**_x_**,**_y_**,**_z_**;;
+    Position targeted by the camera. By default it is set to
+    {@HTRDR_ARGS_DEFAULT_CAMERA_TGT@}.
+
+  **up**=**_x_**,**_y_**,**_z_**;;
+    Up vector of the camera. By default it is set to
+    {@HTRDR_ARGS_DEFAULT_CAMERA_UP@}.
+
 *-p* <__rectangle-parameter__:...>::
   Switch in flux map computation. The flux is computed for the part of the
   sensor that is outside any geometry. The rectangular sensor onto which the
diff --git a/doc/htrdr-combustion.1.txt.in b/doc/htrdr-combustion.1.txt.in
@@ -84,7 +84,7 @@ OPTIONS
   **focal-dst**=**_dst_**;;
     Distance to focus on with a thin lens camera, that is, a camera whose
     *lens-radius* is not zero. The default focal distance is
-    @HTRDR_ARGS_DEFAULT_CAMERA_FOCAL_DST@ meter.
+    @HTRDR_ARGS_DEFAULT_CAMERA_PERSPECTIVE_FOCAL_DST@ meter.
 
   **focal-length**=**_length_**;;
     Focal length of a camera lens. It is another way to control the field of
@@ -93,14 +93,15 @@ OPTIONS
 
   **fov**=**_angle_**;;
     Vertical field of view of the camera in
-    ]@HTRDR_ARGS_CAMERA_FOV_EXCLUSIVE_MIN@,
-    @HTRDR_ARGS_CAMERA_FOV_EXCLUSIVE_MAX@[ degrees. By default _angle_ is set to
-    @HTRDR_ARGS_DEFAULT_CAMERA_FOV@ degrees.
+    ]@HTRDR_ARGS_CAMERA_PERSPECTIVE_FOV_EXCLUSIVE_MIN@,
+    @HTRDR_ARGS_CAMERA_PERSPECTIVE_FOV_EXCLUSIVE_MAX@[ degrees. By
+    default _angle_ is set to
+    @HTRDR_ARGS_DEFAULT_CAMERA_PERSPECTIVE_FOV@ degrees.
 
   **lens-radius**=**_radius_**;;
     Radius of the camera lens. A non-zero radius means that the camera is a
     thin lens camera while a zero radius defines a pinhole camera. By default
-    the lens radius is @HTRDR_ARGS_DEFAULT_CAMERA_LENS_RADIUS@.
+    the lens radius is @HTRDR_ARGS_DEFAULT_CAMERA_PERSPECTIVE_LENS_RADIUS@.
 
   **pos**=**_x_**,**_y_**,**_z_**;;
     Camera lens position. By default it is set to
@@ -229,6 +230,25 @@ OPTIONS
   Path to the file where *htrdr-combustion* writes the output data. If not set,
   data is written to standard output.
 
+*-P* <__camera-parameter__:...>::
+  Define an orthographic camera. Available parameters are:
+
+  **height**=**_radius_**;;
+    Height of the image plane. By default it is set to
+    @HTRDR_ARGS_DEFAULT_CAMERA_ORTHOGRAPHIC_HEIGHT@.
+
+  **pos**=**_x_**,**_y_**,**_z_**;;
+    Camera lens position. By default it is set to
+    {@HTRDR_ARGS_DEFAULT_CAMERA_POS@}.
+
+  **tgt**=**_x_**,**_y_**,**_z_**;;
+    Position targeted by the camera. By default it is set to
+    {@HTRDR_ARGS_DEFAULT_CAMERA_TGT@}.
+
+  **up**=**_x_**,**_y_**,**_z_**;;
+    Up vector of the camera. By default it is set to
+    {@HTRDR_ARGS_DEFAULT_CAMERA_UP@}.
+
 *-p* _thermprops_::
   Path to the *atrtp*(5) file that stores the thermodynamic properties of the
   combustion medium.