'\" t
.\"     Title: EDIT
.\"    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 "EDIT" "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"
edit \- Edits objects, using \fIsubcommand\fRs\&.
.SH "SYNOPSIS"
.HP \w'\fBedit\fR\ 'u
\fBedit\fR [(1)\ \fIsubcommand\fR\ [(2)\ \fIargs\fR]\ \fIobject\fR...]
.br

.br

.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.HP \w'(1)\ 'u
(1)\ help | translate | rotate | scale | ... 
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.HP \w'(2)\ 'u
(2)\ [(3)\ \fIfrom\fR] (4)\ \fIto\fR [(2)\ \fImore_args\fR...]
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.HP \w'(3)\ 'u
(3)\ [\fB\-n\fR] \fB\-k\fR {(6)\ \fIfrom_object\fR | (5)\ \fIfrom_position\fR}
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.HP \w'(4)\ 'u
(4)\ [\fB\-n\fR] [\fB\-a\fR | \fB\-r\fR] {(6)\ \fIto_object\fR | (5)\ \fIto_position\fR}
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.HP \w'(5)\ 'u
(5)\ {(7)\ \fIcoords\fR} | {[\ \fB\-x\fR\ {\fIx\fR\ |\ (6)\ \fIx\-obj\fR\ }\ ]\ [\ \fB\-y\fR\ {\fIy\fR\ |\ (6)\ \fIy\-obj\fR\ }\ ]\ [\ \fB\-z\fR\ {\fIz\fR\ |\ (6)\ \fIz\-obj\fR\ }\ ]} 
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.HP \w'(6)\ 'u
(6)\ [\fIpath/\fR]\ \fIobject\fR  [(7)\ \fIoffset_distance\fR]
.HP \w'(7)\ 'u
(7)\ \fIx\fR [\fIy\fR\ [\fIz\fR]]
.SH "DESCRIPTION"
.PP
Operates on objects in the database, solely through the use of
\fIsubcommand\fRs\&. The flexibility of the
\fBedit\fR
\fIsubcommand\fRs lies in their utilization of a common style of syntax\&. Coordinates in model space, offsets, and objects are all accepted interchangeably as reference points\&. A single reference point is equivalent to an absolute point in model space\&. A pair of reference points specifies a distance or an angle, and is supplied as a set of
\fIfrom\fR
\-
\fIto\fR
arguments (a
\fIfrom\fR
argument is similar to the concept of a keypoint)\&. Reference points may be incomplete, and specify only one or two coordinates\&.
.PP
The format of the standard options accepted by subcommands,
\fB\-n\fR,
\fB\-k\fR,
\fB\-a\fR/\fB\-r\fR, and
\fB\-x\fR/
\fB\-y\fR/\fB\-z\fR, is defined here\&. The interpretation of these options, however, is left up to the implementation of a given subcommand\&.
.PP
All edit commands interpret a lone point (\fB \&. \fR) as a special operator, called the batch operator\&. The batch operator is accepted as an argument to the options
\fB\-k\fR,
\fB\-a\fR, and
\fB\-r\fR\&. In a batch operation, each individual
\fIobject\fR
is operated on using the bounding box center of itself in place of the batch operator\&. While all
\fIobject\fR\*(Aqs move together in a non\-batch operation, in batch operations, each
\fIobject\fR
may move independently of all other
\fIobject\fR\*(Aqs\&.
.PP
If any
\fIfrom\fR
coordinates are omitted, they default to the bounding box center of the first
\fIobject\fR
is used as
\fIfrom\fR\&. To use the natural origin of the first
\fIobject\fR
as
\fIfrom\fR,
\fIfrom_object\fR
must be manually set to whatever
\fIobject\fR
is set to\&. If any
\fIto\fR
coordinates are omitted, they default to the values set in
\fIfrom\fR\&.
.PP
The quantity and arrangement of standard
\fBedit\fR
arguments as well as their interpretation depends upon the subcommand\&. See the manual page for a given subcommand for more information on its usage:
.sp
.if n \{\
.RS 4
.\}
.nf
mged> \fBman edit_\fR\fB\fIsubcommandName\fR\fR
.fi
.if n \{\
.RE
.\}
.sp
.SH "OPTIONS"
.PP
\fB\-n\fR
.RS 4
Use the natural origin of the object specified as an argument to
\fB\-k\fR,
\fB\-a\fR, or
\fB\-r\fR
rather than its bounding box center\&.
.RE
.PP
\fB\-k\fR
.RS 4
Sets the keypoint
\fIfrom\fR
to either
\fIfrom_object\fR\*(Aqs bounding box center or
\fIfrom_position\fR\&.
.RE
.PP
\fB\-a\fR
.RS 4
Sets the destination point
\fIto\fR
to either
\fIto_object\fR\*(Aqs bounding box center or
\fIto_position\fR\&.
.RE
.PP
\fB\-r\fR
.RS 4
Sets the destination point
\fIto\fR
to a point offset by
\fIto_position\fR
from the
\fIfrom\fR
point\&.
.RE
.PP
\fB\-x\fR \fB\-y\fR \fB\-z\fR
.RS 4
Sets the coordinate of a particular axis\&.
.RE
.SH "EXAMPLES"
.PP
\fBExample\ \&1.\ \& Get the authoritative list of available subcommands.\fR
.PP
> \fBedit\fR
.RS 4
.RE
.PP
> \fBedit help\fR
.RS 4
Prints usage and a list of available subcommands\&.
.RE
.PP
\fBExample\ \&2.\ \&Get the usage of a subcommand.\fR
.PP
> \fBedit translate\fR
.RS 4
Print usage of the translate subcommand
.RE
.PP
\fBExample\ \&3.\ \& Use the help subcommand to print extended usage of subcommands.\fR
.PP
> \fBedit translate help\fR
.RS 4
.RE
.PP
> \fBedit help translate\fR
.RS 4
Print extended usage of the translate subcommand\&. Each subcommand also accepts
\fIhelp\fR
as an argument, so that the extended usage is still available if
\fBedit translate\fR
is aliased to something else\&.
.RE
.PP
\fBExample\ \&4.\ \& A fake subcommand is used to show how standard edit arguments and nonstandard edit arguments are used.\fR
.PP
> \fBedit fake_subcmd \-B 12 \-k sph\&.s 1\&.5 7 \-a 0 0 0 cube\&.s\fR
.RS 4
The nonstandard
\fB\-B\fR
option is unique to
\fBfake_subcmd\fR\&. An explanation of how it is used would be found in the manual for fake_subcmd, if there were one\&. The remaining options and arguments are standardized\&. The
\fB\-k\fR
and
\fB\-a\fR
options are used to specify a
\fIfrom\fR
\-
\fIto\fR
pair, as defined in this manual for
\fBedit\fR\&. The interpretation of the vector created by these points would be defined in the
\fBfake_subcmd\fR
manual\&.
.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
