'\" t
.\"     Title: IN
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 08/28/2023
.\"    Manual: BRL-CAD User Commands
.\"    Source: BRL-CAD
.\"  Language: English
.\"
.TH "IN" "nged" "08/28/2023" "BRL\-CAD" "BRL\-CAD User Commands"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
in \- Allows the user to type in the arguments needed to create a shape with the name \fInew_shape_name\fR of the type \fIshape_type\fR\&. The command may be invoked with no arguments, and it will prompt the user for all needed information\&.
.SH "SYNOPSIS"
.HP \w'\fBin\fR\ 'u
\fBin\fR [[\-f] | [\-s]] [\fInew_shape_name\fR] [\fIshape_type\fR] {\fIparameters\fR}
.SH "DESCRIPTION"
.PP
Allows the user to type in the arguments needed to create a shape with the name
\fInew_shape_name\fR
of the type
\fIshape_type\fR\&. The command may be invoked with no arguments, and it will prompt the user for all needed information\&. The
\fI\-s\fR
option will invoke the primitive edit mode on the new shape immediately after creation\&. The
\fI\-f\fR
option does not draw the new shape, and therefore the
\fI\-s\fR
option may not be used in conjunction with
\fI\-f\fR\&. The possible values for
\fIshape_type\fR
are:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
arb8 \-\- ARB (eight vertices)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
arb7 \-\- ARB (seven vertices)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
arb 6 \-\- ARB (six vertices)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
arb 5 \-\- ARB (five vertices)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
arb 4 \-\- ARB (four vertices)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
arbn \-\- Arbitrary polyhedron with arbitrary number of vertices (plane equations)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
bot \-\- Bag of Triangles\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
dsp \-\- Displacement Map\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
pipe \-\- Pipe (run of connected pipe or wire)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ebm \-\- Extruded Bit Map\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
vol \-\- Voxels\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
hf \-\- Height Field deprecated, see dsp\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ars \-\- Arbitrary Faceted Solid\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
half \-\- Half Space\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
sph \-\- Ellipsoid (center and radius)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ell \-\- Ellipsoid (center and three semi\-axes)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ellg \-\- Ellipsoid (foci and chord length)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ell1 \-\- Ellipsoid (center, one semi\-axis, and a radius of revolution)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
tor \-\- Torus\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
tgc \-\- Truncated General Cone (most general TGC)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
tec \-\- TGC (top radii are scaled from base radii)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
rec \-\- TGC (right elliptical cylinder)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
trc \-\- TGC (truncated right circular cone)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
rcc \-\- TGC (right circular cylinder)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
box \-\- ARB (vertex and three vectors)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
raw \-\- ARB (right angle wedge)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
rpp \-\- ARB (axis aligned rectangular parallelepiped)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
rpc \-\- Right Parabolic Cylinder\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
rhc \-\- Right Hyperbolic Cylinder\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
epa \-\- Elliptical Paraboloid\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ehy \-\- Elliptical Hyperboloid\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
eto \-\- Elliptical Torus\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
part \-\- Particle\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ebm \-\- Extruded bitmap
.RE
.SH "EXAMPLES"
.PP
The example shows the use of the
\fBin\fR
command to create a shape of a specified type\&.
.PP
\fBExample\ \&1.\ \&Create a new shape in the form of a right angle wedge.\fR
.PP
mged> \fBin new1 raw 0 0 0 0 0 1 1 0 0 0 1 0\fR
.RS 4
Creates an
\fIARB\fR
named
\fInew1\fR
in the form of a right angle wedge\&.
.RE
.PP
\fBExample\ \&2.\ \&Creating ebm from bitmap file\fR
.PP
mged> \fBin new1\&.s ebm f image_name\&.bw 350 350 20\fR
.RS 4
Creates an
\fIebm\fR
named
\fInew1\&.s\fR
using file image_name\&.bw, dimensions of image_name\&.bw (e\&.g\&. \*(Aq350 350\*(Aq), and the desired extrusion distance (e\&.g\&. \*(Aq20\*(Aq)\&.
.RE
.PP
\fBExample\ \&3.\ \&Creating ebm with database objects\fR
.PP
mged> \fBin new1\&.s ebm o dbobj 350 350 20\fR
.RS 4
Creates an
\fIebm\fR
named
\fInew1\&.s\fR
using database object dbobj, dimensions of original bitmap image (e\&.g\&. \*(Aq350 350\*(Aq), and the desired extrusion distance (e\&.g\&. \*(Aq20\*(Aq)\&. (see \*(Aqbo\*(Aq command for creating database object)\&.
.RE
.SH "AUTHOR"
.PP
BRL\-CAD Team
.SH "BUG REPORTS"
.PP
Reports of bugs or problems should be submitted via electronic mail to
devs@brlcad\&.org
