'\" t
.\"     Title: KNOB
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 04/13/2022
.\"    Manual: BRL-CAD User Commands
.\"    Source: BRL-CAD
.\"  Language: English
.\"
.TH "KNOB" "nged" "04/13/2022" "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"
knob \- Provides a method for simulating knob input\&. With no options, it will display the current values for the knobs\&.
.SH "SYNOPSIS"
.HP \w'\fBknob\fR\ 'u
\fBknob\fR [\-e\ \-i\ \-m\ \-v] [[\-o] | [v] | [m] | [e] | [k]] [[zap] | [zero] | [\fIid\fR\ [\fIval\fR]]]
.SH "DESCRIPTION"
.PP
\fBThe \fR\fB\fBknob\fR\fR\fB command is used internally by MGED in the processing of knob input devices and is not recommended for users\&.\fR
The
\fBknob \fR
command provides a method for simulating knob input\&. With no options, it will display the current values for the knobs\&. With the
\fB zap or zero \fR
command provided, all the knob values will be reset to zero\&. If an
\fIid\fR
and
\fIvalue\fRare provided, the specified knob setting will be simulated\&. If the
\fI\-i\fR
option is specified, then the value provided will be used as an increment to be applied to the indicated knob\&. The knobs have different functions depending on the current mode\&. For example, if in primitive or matrix edit mode and a rotation or translation function is selected, the knob effects are applied to the edited object by default\&. However, the
\fI\-v \fR(view coordinates) and
\fI\-m\fR
(model coordinates) options may be used to adjust the view without modifying primitives or matrices\&. The
\fI\-e\fR
option allows the knob effects to be applied to the edited object when they would normally be applied to the view\&. The
\fI\-o\fR
option allows the origin of rotation to be specified with
\fIv, m, e,\fR
and
\fIk\fR, indicating view, model, eye, and keypoint, respectively\&. The units for
\fIvalue\fR
are degrees for rotation and local units for translation\&. The available
\fIknob ids\fR
are:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBx\fR
\-\- rate\-based rotation about horizontal axis\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBy\fR
\-\- rate\-based rotation about vertical axis\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBz\fR
\-\- rate\-based rotation about axis normal to screen\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBX\fR
\-\- rate\-based translation in horizontal direction\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBY\fR
\-\- rate\-based translation in vertical direction\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBZ\fR
\-\- rate\-based translation in direction normal to screen\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBS\fR
\-\- rate\-based Scale or Zoom\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBax\fR
\-\- absolute rotation about horizontal axis\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBay\fR
\-\- absolute rotation about vertical axis\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBaz\fR
\-\- absolute rotation about axis normal to screen\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBaX\fR
\-\- absolute translation in horizontal direction\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBaY\fR
\-\- absolute translation in vertical direction\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBaZ\fR
\-\- absolute translation in direction normal to screen\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBaS\fR
\-\- absolute Scale or Zoom\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBxadc\fR
\-\- absolute translation of adc in horizontal direction (screen coordinates \-2048 to +2048)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fByadc\fR
\-\- absolute translation of adc in vertical direction (screen coordinates \-2048 to +2048)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBang1\fR
\-\- absolute rotation of adc angle1 (degrees)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBang2\fR
\-\- absolute rotation of adc angle2 (degrees)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBdistadc\fR
\-\- distance setting of the adc (screen coordinates \-2048 to +2048)\&.
.RE
.SH "EXAMPLES"
.PP
The example shows the use of the
\fBknob\fR
command with the
\fIy \fR
option to rotate a view about the vertical axis\&.
.PP
\fBExample\ \&1.\ \&Rotate a view about the vertical axis.\fR
.PP
mged> \fBknob y 1\fR
.RS 4
Starts the view rotating about the vertical axis\&.
.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
