OVERLAY(nged)

NAME

overlay - Plots the specified UNIX __plot_file__ in the MGED display.

On this page

SYNOPSIS
DESCRIPTION
OPTIONS
EXAMPLES
AUTHOR
BUG REPORTS

SYNOPSIS

overlay [options] file
overlay -F [-i] [-c] [-z] [-X #] [-Y #] [-w #] [-n #] [-S #] [--format fmt] {img_file}

Plots the specified UNIX plot_file in the current application display or the specified image file in the current application embedded framebuffer. When displaying plot files, multiple files may be specified using a pattern match (e.g., overlay *.plot3).

When displaying plot files, phony object names are created for each part of the plot file(s) with a unique color. The names are created by adding a color to the specified viewobj_name, or to PLOT_OVERLAY if no name is provided. The color suffix is built by converting the RGB color to a six-digit hex number. Each color corresponds to 2 hex digits, so that white becomes "ffffff," red becomes "ff0000," green is "00ff00," etc.

Image files will be display in the currently active framebuffer. Currently multiple images cannot be specified by a single overlay command (but as the images would overrwrite each other this feature would not be terribly useful in any case.) However, mulitiple images can be written in succession to the same framebuffer using the -X and -Y offset specification options to offset their positions for simultaneous display. Alternately, if the user wishes to reset the framebuffer before drawing the new image the -c option may be specified.

The -w, -n, and -S options are used to specify image size for formats such as PIX that do not encode the image size in their own data. Similarly, --format may be used to explicitly specify an image format if the filename does not make the format clear.

By default, images are displayed in the framebuffer using their original size. If the users wishes to use all available space in the image window to display an image, the -z may be specified to focus the framebuffer on the image. The -i option may be used to invert an image’s display in the y (vertical) direction.

OPTIONS

-h, --help: Print help and exit.
-F, --fb: Interpret the input as an image to be drawn in the framebuffer rather than as a UNIX plot file.
-s, --size size: Set plot character size when drawing plot overlays.
-N, --view-obj name: Set the base view-object name used for plot overlay objects.
-i, --inverse: Draw framebuffer images upside-down.
-c, --clear: Clear the framebuffer before drawing a new image.
-v, --verbose: Enable verbose framebuffer reporting.
-z, --zoom: Zoom the framebuffer image to fill the available screen area.
-X, --scr_xoff offset: Set the framebuffer X offset.
-Y, --scr_yoff offset: Set the framebuffer Y offset.
-w, --width pixels: Set the image width for raw formats that do not encode dimensions.
-n, --height pixels: Set the image height for raw formats that do not encode dimensions.
-S, --square pixels: Set both image width and height for square raw images.
--format fmt: Explicitly specify the framebuffer image format.