From 58dcade50665b6e13b10e23c5648b56c45c8307e Mon Sep 17 00:00:00 2001 From: Ravi Peters Date: Thu, 6 Apr 2023 15:23:24 +0200 Subject: [PATCH] try to clarify help strings for cli parameters --- src/cli.rs | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/src/cli.rs b/src/cli.rs index 659187c..e2533f9 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -52,36 +52,34 @@ pub struct Cli { /// By default, explicit tiling is created for the 3D Tiles output. #[arg(long = "3dtiles-implicit")] pub cesium3dtiles_implicit: bool, - /// Set the geometric error on the parent nodes of leafs. This controls at what - /// camera distance leaf nodes become visible, recommended values in between - /// 10 and 15. Higher values make content visible earlier when zooming in. + /// Set the geometric error (see 3D Tiles specification) on the parent nodes of leafs. This controls at what + /// camera distance leaf nodes become visible. Higher values make content visible earlier when zooming in. #[arg(long, short = 'e', default_value = "12")] pub geometric_error_above_leaf: Option, - /// Set the 2D cell size for the grid that is used for constructing the quadtree. + /// Set the 2D cell size for the grid that is used for constructing the quadtree. In input units (eg. meters). #[arg(long, default_value = "250")] pub grid_cellsize: Option, /// Limit the minimum z coordinate for the bounding box that is computed from the /// features. Useful if the features contain errors with extremely small z - /// coordinates. + /// coordinates. In input units (eg. meters). #[arg(long)] pub grid_minz: Option, /// Limit the maximum z coordinate for the bounding box that is computed from the /// features. Useful if the features contain errors with extremely large z - /// coordinates. + /// coordinates. In input units (eg. meters). #[arg(long)] pub grid_maxz: Option, /// Export the grid and the feature centroids in to .tsv files in the working /// directory. Used for debugging. #[arg(long)] pub grid_export: bool, - /// The capacity of a leaf of the quadtree. If a quadrant has less than or equal - /// the capacity, its subtiles are merged. + /// The maximum number of vertices in a leaf of the quadtree. #[arg(long, default_value = "42000")] pub qtree_capacity: Option, /// Path to the geoflow executable for clipping and exporting the gltf files. #[arg(long, value_parser = existing_path)] pub exe_geof: Option, - /// Use mesh simplification to reduce the number of vertices per object by this fraction. Value should be a float between 0.0 and 1.0. Ignored for building object types. + /// Use mesh simplification to reduce the number of vertices per object by this fraction. Value should be a float between 0.0 (100% reduction) and 1.0 (do not use simplification). Ignored for building object types. #[arg(long, default_value = "0.05")] pub reduce_vertices: Option, /// LoD to use in output for Building features