Revision: 76478
http://sourceforge.net/p/brlcad/code/76478
Author: brlcad
Date: 2020-07-25 04:44:50 +0000 (Sat, 25 Jul 2020)
Log Message:
-----------
update bo docs to include & explain the 'u' type. include a dsp example too.
Modified Paths:
--------------
brlcad/trunk/NEWS
brlcad/trunk/doc/docbook/system/mann/bo.xml
Modified: brlcad/trunk/NEWS
===================================================================
--- brlcad/trunk/NEWS 2020-07-25 01:46:30 UTC (rev 76477)
+++ brlcad/trunk/NEWS 2020-07-25 04:44:50 UTC (rev 76478)
@@ -13,6 +13,7 @@
--- 20XX-XX-XX Release 7.3X.X ---
----------------------------------------------------------------------
+* expanded 'bo' command docs with a DSP input example - Sean Morrison
* fixed 'in' making joint, superell, & script objects - Sean Morrison
* Creo converter always writes out CREO_NAME attribute - Sean Morrison
* improved gdiff -F filtering option behavior - Cliff Yapp
Modified: brlcad/trunk/doc/docbook/system/mann/bo.xml
===================================================================
--- brlcad/trunk/doc/docbook/system/mann/bo.xml 2020-07-25 01:46:30 UTC (rev
76477)
+++ brlcad/trunk/doc/docbook/system/mann/bo.xml 2020-07-25 04:44:50 UTC (rev
76478)
@@ -17,10 +17,10 @@
<cmdsynopsis sepchar=" ">
<command>bo</command>
<group choice="req" rep="norepeat">
- <arg choice="opt" rep="norepeat">-i {type}</arg>
+ <arg choice="opt" rep="norepeat">-i u {type}</arg>
<arg choice="opt" rep="norepeat">-o</arg>
</group>
- <arg choice="req" rep="norepeat"><replaceable>{destination}
{source}</replaceable></arg>
+ <arg choice="req"
rep="norepeat"><replaceable>destination</replaceable></arg> <arg choice="req"
rep="norepeat"><replaceable>source</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
@@ -27,23 +27,19 @@
<refsection xml:id="description"><title>DESCRIPTION</title>
<para>
- Used to create or retrieve binary opaque objects. Currently,
- only uniform binary objects (arrays of values) are
- supported. One of <emphasis>-i</emphasis> or
- <emphasis>-o</emphasis> must be
- specified. The <emphasis>-i</emphasis> is for "input," or
- creating a binary object, and the <emphasis>-o</emphasis> option
- is used for "output," or retrieving a binary
- object. The <emphasis>type</emphasis> argument must be supplied
- when <emphasis>-i</emphasis> is used, to indicate the type of
- uniform binary object to be created. On input,
- the <emphasis>destination</emphasis> is the name of the object
- to be created, and the source is the path to a file containing
- the values in the local host format. On
+ Used to create or export binary opaque objects. One of
+ <emphasis>-i</emphasis> or <emphasis>-o</emphasis> must be
+ specified to input or output data respectively. The
+ <emphasis>-i</emphasis> option will create a binary object, and
+ the <emphasis>-o</emphasis> option will write out a binary
+ object's data. Currently, only uniform binary objects (arrays of
+ values) are supported on input. On input, the
+ <emphasis>destination</emphasis> is the name of the object to be
+ created, and the source is the path to a file to read. On
output, <emphasis>destination</emphasis> is the path to a file
- to receive the contents of the binary object whose name appears
- in <emphasis>source</emphasis>. The
- <emphasis>type</emphasis> may be one of:
+ to write out with the contents of the binary object specified as
+ the <emphasis>source</emphasis>. The <emphasis>type</emphasis>
+ may be one of:
<simplelist type="vert">
<member>f -> float</member>
@@ -77,6 +73,12 @@
</para>
</example>
+ <example><title>Import data for a displacement map (DSP) object</title>
+
+ <para><prompt>mged></prompt> <userinput>bo -i u S dsp.data
/path/to/file.dsp</userinput></para>
+ <para>This imports a file named <emphasis>file.dsp</emphasis> that
contains DSP data, i.e., raw data in unsigned short (16-bit) format. The data
is saved in the .g database into an object named <emphasis>dsp.data</emphasis>.
When creating a DSP, this <emphasis>dsp.data</emphasis> object can be
specified as the data source.</para>
+ </example>
+
<example><title>Copy the contents of a particular binary object into a
specified file.</title>
<para><prompt>mged></prompt> <userinput>bo -o /home/jim/cmds.html
cmds</userinput></para>
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
