OVERLAY(nged)

👑 OVERLAY(nged) — the overlay girlies' guide ✨

ok so bestie, welcome to overlay from the nged manual — this is the one that puts your plot files and your images up on the screen, and honestly? it eats. 💅

---

🌸 NAME 🌸

overlay — plots the specified UNIX plot_file in the MGED display. that's the whole vibe, no cap.

---

🎀 SYNOPSIS 🎀

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

like, two whole modes. pick your fighter. 🦋

---

💖 DESCRIPTION 💖

so here's the tea: overlay plots the specified UNIX plot_file in the current application display, or it plots the specified image file in the current application's embedded framebuffer. two moods, one command.

when you're displaying plot files, you can literally pass multiple files at once using a pattern match — like, say, overlay *.plot3. go off. 🔥

when displaying plot files, phony object names get created for each part of the plot file(s), each with a unique color. the names are made by adding a color onto the specified viewobj_name, or onto PLOT_OVERLAY if you didn't provide a name. the color suffix is built by converting the RGB color into a six-digit hex number — each color = 2 hex digits, so white becomes ffffff, red becomes ff0000, green is 00ff00, etc. cute AND systematic, we love to see it. 🌈

image files get displayed in the currently active framebuffer. currently multiple images cannot be specified by a single overlay command — but honestly, since the images would overwrite each other, that feature wouldn't be terribly useful in any case, so like… no loss? 🙈

however — multiple images can be written in succession to the same framebuffer using the -X and -Y offset specification options, so you can offset their positions for simultaneous display. iconic behavior. ✨ alternatively, if you want to reset the framebuffer before drawing the new image, you can specify the -c option. your call, bestie.

the -w, -n, and -S options are there to specify image size for formats like 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 doesn't make the format clear. iykyk. 💫

by default, images are displayed in the framebuffer using their original size. but if you want to use all the available space in the image window to display an image, you can specify -z to focus the framebuffer on the image. main character energy fr. and the -i option may be used to invert an image's display in the y (vertical) direction — flip it, turn it, whatever, it's giving upside-down szn. 🙃

---

✨ OPTIONS ✨

• -h, --help — print help and exit. the classic "wait what does this do again" button. 🫶
• -F, --fb — interpret the input as an image to be drawn in the framebuffer rather than as a UNIX plot file. mode switch, activated. 🔄
• -s, --size size — set plot character size when drawing plot overlays. bigger = bolder, ngl. 💅
• -N, --view-obj name — set the base view-object name used for plot overlay objects. name your children. 👑
• -i, --inverse — draw framebuffer images upside-down. head-empty-no-thoughts mode. 🙈
• -c, --clear — clear the framebuffer before drawing a new image. fresh slate, fresh me. 🧚
• -v, --verbose — enable verbose framebuffer reporting. she talks a lot, we stan. 💬
• -z, --zoom — zoom the framebuffer image to fill the available screen area. take up space, bestie. 🔍
• -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. one number, two jobs. ⭐
• --format fmt — explicitly specify the framebuffer image format. spell it out for the cheap seats. 🎀

---

🌟 EXAMPLES 🌟

Example 1. Plot a UNIX plot file in the MGED display.

mged>overlay file.plot3 tmp

plots the UNIX plot file file.plot3 in the MGED display, using tmp as the base for the phony object names. look at her go. 🥹

Example 2. Plot a PNG file in the MGED framebuffer.

mged>overlay -c -F image.png

plots the image file image.png in the MGED framebuffer, first clearing any pre-existing images in the framebuffer. out with the old, in with the new. 🔥

---

💜 AUTHOR 💜

BRL-CAD Team — the icons behind the icons. 👑

---

🍓 BUG REPORTS 🍓

reports of bugs or problems should be submitted via electronic mail to devs@brlcad.org — like, if something's broken, tell the girlies, they'll fix it. don't suffer in silence, bestie. 😭

---

ok and that's the whole page! brought to you by BRL-CAD — this OVERLAY(nged) moment was a whole serve, so go plot something iconic, ily, bye 💅💖✨