From 3181090230ca3903ed7f02c3d91ecf82b57a3eec Mon Sep 17 00:00:00 2001 From: joshbaker22 <141415098+joshbaker22@users.noreply.github.com> Date: Mon, 14 Aug 2023 14:06:57 -0400 Subject: [PATCH] add man pages for ae2dir and viewdir --- doc/docbook/system/mann/CMakeLists.txt | 2 + doc/docbook/system/mann/ae2dir.xml | 60 ++++++++++++++++++++++++++ doc/docbook/system/mann/qvrot.xml | 5 ++- doc/docbook/system/mann/viewdir.xml | 56 ++++++++++++++++++++++++ 4 files changed, 122 insertions(+), 1 deletion(-) create mode 100644 doc/docbook/system/mann/ae2dir.xml create mode 100644 doc/docbook/system/mann/viewdir.xml diff --git a/doc/docbook/system/mann/CMakeLists.txt b/doc/docbook/system/mann/CMakeLists.txt index cec6af42c80..c4b1f387798 100644 --- a/doc/docbook/system/mann/CMakeLists.txt +++ b/doc/docbook/system/mann/CMakeLists.txt @@ -6,6 +6,7 @@ set(mann_EN Z.xml adc.xml ae.xml + ae2dir.xml analyze.xml animmate.xml apropos.xml @@ -229,6 +230,7 @@ set(mann_EN vars.xml vdraw.xml view.xml + viewdir.xml viewsize.xml vnirt.xml voxelize.xml diff --git a/doc/docbook/system/mann/ae2dir.xml b/doc/docbook/system/mann/ae2dir.xml new file mode 100644 index 00000000000..4031517315c --- /dev/null +++ b/doc/docbook/system/mann/ae2dir.xml @@ -0,0 +1,60 @@ + + + + VIEWDIR + nged + BRL-CAD + BRL-CAD MGED Commands + + + + viewdir + Returns the direction vector using the provided azimuth and elevation (AE). + + + + + + + viewdir + -i + azimuth + elevation + + + +DESCRIPTION + + Returns the direction vector using the provided azimuth and elevation as input. The + -i option results in the angles supplied being interpreted as increments. + See also the viewdir and qvrot commands. + + + + +EXAMPLES + + The example shows the use of the ae2dir command to get the direction vector. + + + Find the direction vector using the provided azimuth and elevation. + + + mged> ae2dir 35 25 + + Returns the direction vector using an azimuth of 35 and elevation of 25. + + + + + +AUTHORBRL-CAD Team + +BUG REPORTS + + + Reports of bugs or problems should be submitted via electronic + mail to devs@brlcad.org + + + diff --git a/doc/docbook/system/mann/qvrot.xml b/doc/docbook/system/mann/qvrot.xml index 4089fb6cacb..b63c9627b92 100644 --- a/doc/docbook/system/mann/qvrot.xml +++ b/doc/docbook/system/mann/qvrot.xml @@ -27,7 +27,10 @@ DESCRIPTION Adjusts the current MGED viewing direction such that the eye - is positioned along the direction vector (dx dy dz) from the view center and is looking towards the view center. The angle (in degrees) allows for a twist about the viewing direction. The ae command provides a similar capability. + is positioned along the direction vector (dx dy dz) from the view center and is + looking towards the view center. The angle (in degrees) allows for a twist about the + viewing direction. The ae command provides a similar capability. See also the + ae2dir and viewdir commands. diff --git a/doc/docbook/system/mann/viewdir.xml b/doc/docbook/system/mann/viewdir.xml new file mode 100644 index 00000000000..caddf090d6d --- /dev/null +++ b/doc/docbook/system/mann/viewdir.xml @@ -0,0 +1,56 @@ + + + + VIEWDIR + nged + BRL-CAD + BRL-CAD MGED Commands + + + + viewdir + Returns the direction vector using the current azimuth and elevation (AE). + + + + + + + viewdir + + + +DESCRIPTION + + Returns the direction vector using the current azimuth and elevation as input. See also the + ae2dir and qvrot commands. + + + + +EXAMPLES + + The example shows the use of the viewdir command to get the direction vector. + + + Find the current direction vector. + + + mged> viewdir + + Returns the direction vector using the current azimuth and elevation. + + + + + +AUTHORBRL-CAD Team + +BUG REPORTS + + + Reports of bugs or problems should be submitted via electronic + mail to devs@brlcad.org + + +