'\" t
.\"     Title: QRAY
.\"    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 "QRAY" "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"
qray \- Gets/sets \fIquery ray\fR characteristics\&.
.SH "SYNOPSIS"
.HP \w'\fBqray\fR\ 'u
\fBqray\fR [\fIsubcommand\fR]
.SH "DESCRIPTION"
.PP
Gets/sets
\fIquery ray\fR
characteristics\&. Without a subcommand, the usage message is printed\&. The
\fIqray\fR
command accepts the following subcommands:
.PP
\fBvars\fR
.RS 4
Prints a list of all query ray variables\&.
.RE
.PP
\fBbasename\fR [\fIstr\fR]
.RS 4
If
\fIstr\fR
is specified, then set basename to
\fIstr\fR\&. Otherwise, return the basename\&. Note that the basename is the name used to create the fake shape names corresponding to the query ray\&. There will be one fake shape for every color used along the ray\&.
.RE
.PP
\fBeffects\fR[\fIt|g|b\fR]
.RS 4
Set or get the type of
\fIeffects\fR
that will occur when firing a query ray\&. The effects of firing a ray can be either
\fIt\fR
for textual output,
\fIg \fR
for graphical output, or
\fIb\fR
for both textual and graphical\&.
.RE
.PP
\fBecho\fR [\fI0|1\fR]
.RS 4
Sets or gets the value of
\fIecho\fR\&. If set to 1, the actual
\fBnirt \fR
command used will be echoed to the screen\&.
.RE
.PP
\fBoddcolor\fR [\fIr g b\fR]
.RS 4
Sets or gets the color of odd partitions\&.
.RE
.PP
\fBevencolor\fR [\fIr g b\fR]
.RS 4
Sets or gets the color of even partitions\&.
.RE
.PP
\fBvoidcolor\fR [\fIr g b\fR]
.RS 4
Sets or gets the color of areas where the ray passes through nothing\&.
.RE
.PP
\fBoverlapcolor\fR [\fIr g b\fR]
.RS 4
Sets or gets the color of areas that overlap\&.
.RE
.PP
\fBfmt\fR [\fIr|h|p|f|m|o\fR [\fIstr\fR]]
.RS 4
Sets or gets the format string(s)\&. See the
\fIman\fR
page of
\fBnirt\fR
for more details\&.
.RE
.PP
\fBscript\fR [\fIstr\fR]
.RS 4
Sets or gets the
\fBnirt\fR
script string\&.
.RE
.PP
\fBhelp\fR
.RS 4
Prints the usage message\&.
.RE
.SH "EXAMPLES"
.PP
The four examples show the use of the
\fBqray\fR
command without a subcommand and with three of the listed subcommands\&.
.PP
\fBExample\ \&1.\ \&Print the usage message.\fR
.PP

mged>\fBqray\fR
.PP
Prints the usage message\&.
.PP
\fBExample\ \&2.\ \&Return the overlap format string.\fR
.PP

mged>\fBqray fmt o\fR
.PP
Returns the overlap format string\&.
.PP
\fBExample\ \&3.\ \&Return the rgb color used to color odd partitions.\fR
.PP

mged>\fBqray oddcolor\fR
.PP
Returns the rgb color used to color odd partitions\&.
.PP
\fBExample\ \&4.\ \&Set the odd partition color to red.\fR
.PP

mged>\fBqray oddcolor 255 0 0\fR
.PP
Sets the odd partition color to red\&.
.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
