<!-- Converted by db4-upgrade version 1.0 -->

<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="_3ptarb1">

<refmeta>
  <refentrytitle>3PTARB</refentrytitle>
  <manvolnum>nged</manvolnum>
  <refmiscinfo class="source">BRL-CAD</refmiscinfo>
  <refmiscinfo class="manual">BRL-CAD User Commands</refmiscinfo>
</refmeta>

<refnamediv xml:id="name">
  <refname>3ptarb</refname>
  <refpurpose>
    Build an ARB8 shape by extruding a quadrilateral through a given thickness.
  </refpurpose>
</refnamediv>

<!-- body begins here -->
<refsynopsisdiv xml:id="synopsis">
  <cmdsynopsis sepchar=" ">
    <command>3ptarb</command>    
    <arg choice="opt" rep="norepeat">arb_name</arg>
    <arg choice="opt" rep="norepeat">x1</arg>
    <arg choice="opt" rep="norepeat">y1</arg>
    <arg choice="opt" rep="norepeat">z1</arg>
    <arg choice="opt" rep="norepeat">x2</arg>
    <arg choice="opt" rep="norepeat">y2</arg>
    <arg choice="opt" rep="norepeat">z2</arg>
    <arg choice="opt" rep="norepeat">x3</arg>
    <arg choice="opt" rep="norepeat">y3</arg>
    <arg choice="opt" rep="norepeat">z3</arg>
    <arg choice="opt" rep="norepeat">x/y/z</arg>
    <arg choice="opt" rep="norepeat">coord1</arg>
    <arg choice="opt" rep="norepeat">coord2</arg>
    <arg choice="opt" rep="norepeat">thickness</arg>
  </cmdsynopsis>
</refsynopsisdiv>

<refsection xml:id="description"><info><title>DESCRIPTION</title></info>
  
  <para>
    Build an ARB8 shape by extruding a quadrilateral
    through a given thickness. The arguments may be 
    provided on the command line; if they are not, they 
    will be prompted for. The x1, y1, and z1 are the 
    coordinates of one corner of the quadrilateral. 
    x2, y2, z2, and x3, y3, z3 are the coordinates of 
    two other corners. Only two coordinates of the 
    fourth point are specified, and the code calculates 
    the third coordinate to ensure all four points are 
    coplanar. The x|y|z parameter indicates which 
    coordinate of the fourth point will be calculated by 
    the code. The coord1 and coord2 parameters supply the 
    other two coordinates. The direction of extrusion for 
    the quadrilateral is determined from the order of the 
    four resulting points by the right-hand rule; the 
    quadrilateral is extruded toward a viewer for whom 
    the points appear in counter-clockwise order.  
  </para>
</refsection>

<refsection xml:id="examples"><info><title>EXAMPLES</title></info>
  
  <para>
    The following are run from the MGED command prompt:
  </para>
  <example><info><title>3ptarb example with BRL-CAD prompting for information</title></info>
    
    <variablelist>
      <varlistentry>
	   <term><prompt>mged&gt; </prompt> <userinput>3ptarb</userinput></term>
	   <listitem>
	     <para>
	       Start the <command>3ptarb</command> command.
	     </para>
	   </listitem>
      </varlistentry>
      <varlistentry>
	   <term><prompt>Enter name for this arb: </prompt> <userinput>thing</userinput></term>
	   <listitem>
	     <para>
	       The new ARB8 will be named <emphasis>thing</emphasis>.
	     </para>
	   </listitem>
      </varlistentry>
       <varlistentry>
	   <term><prompt>Enter X, Y, Z for point 1: </prompt> <userinput>0 0 0</userinput></term>
	   <listitem>
	     <para>
	       Point one is at the origin.
	     </para>
	   </listitem>
      </varlistentry>
      <varlistentry>
	   <term><prompt>Enter X, Y, Z for point 2: </prompt> <userinput>1 0 0</userinput></term>
	   <listitem>
	     <para>
	       Point two is at (1, 0, 0). 
	     </para>
	   </listitem>
      </varlistentry>
      <varlistentry>
	   <term><prompt>Enter X, Y, Z for point 3: </prompt> <userinput>1 1 0</userinput></term>
	   <listitem>
	     <para>
	       Point three is at (1, 1, 0). 
	     </para>
	   </listitem>
      </varlistentry>

      <varlistentry>
	   <term><prompt>Enter coordinate to solve for (x, y, or z): </prompt> <userinput>z</userinput></term>
	   <listitem>
	     <para>
	       The code will calculate the z coordinate of the fourth point.
	     </para>
	   </listitem>
      </varlistentry>
      <varlistentry>
	   <term><prompt>Enter the X, Y coordinate values: </prompt> <userinput>0 1</userinput></term>
	   <listitem>
	     <para>
	       The x and y coordinates of the fourth point are 0 and 1. 
	     </para>
	   </listitem>
      </varlistentry>
      <varlistentry>
	   <term><prompt>Enter thickness for this arb: </prompt> <userinput>3</userinput></term>
	   <listitem>
	     <para>
	       The new ARB8 will be 3 units thick. 
	     </para>
	   </listitem>
      </varlistentry>
    </variablelist>
  </example>
       
  <example><info><title>3ptarb command as single line input</title></info>
    
    <para>
      <prompt>mged&gt; </prompt><userinput>3ptarb thing 0 0 0 1 0 0 1 1 0 z 0 1 3</userinput>
    </para>
    <para>
      Same as above example, but with all arguments supplied on the command line. 
    </para>
  </example>
 
</refsection>

<info><corpauthor>BRL-CAD Team</corpauthor></info>

<refsection xml:id="bug_reports"><info><title>BUG REPORTS</title></info>
  
  <para>
    Reports of bugs or problems should be submitted via electronic
    mail to &lt;devs@brlcad.org&gt;, or via the "cadbug.sh" script.
  </para>
</refsection>
</refentry>
