RECT(nged)

manage the rubber band selection rectangle in the view

📅 published 7.44.0, from nixpkgs unstable

🎀 NAME

rect — the command that runs the rubber band selection rectangle in your view, bestie 💅

✨ SYNOPSIS

rect vname subcommand [args]

💖 DESCRIPTION

Okay so picture this: rect is the girl who manages the rubber band rectangle overlay that gets drawn on top of your current view. You can position her, resize her, and style her — either by clicking around interactively or by telling her exactly what to do programmatically. She's got range 🦋

What is she for, you ask? Two iconic jobs, no cap: marquee selection, and raytracing a sub-region of the view. That's it. That's the gig.

The very first argument is always the view name (vname) — non-negotiable, she needs to know which view she's serving 💁‍♀️ The second argument is the subcommand. And here's the pattern, the way that every single subcommand works the same way: either you give it no extra args and it hands you back the current value, or you give it extra args and it sets that thing. Get/set. That's the whole vibe. Periodt.

🦋 Subcommands

  • rect vname bg [r g b] — get or set the rectangle's background fill color, as RGB integers in the range (0–255). No extra args? She returns r g b. Three args? She sets the color. Slay 🎨
  • rect vname color [r g b] — get or set the rectangle's border/line color as RGB integers. No extra args → returns r g b. Three args → sets the color.
  • rect vname cdim [w h] — get or set the canvas dimensions (that's the full window/display size, in pixels ✨). This one's the main character because it's used to compute the normalized view coordinates for the rectangle. No extra args → returns w h. Two args → sets the canvas size and recalculates the rectangle's normalized position and dimensions. She's doing math for you, you're welcome 💅
  • rect vname dim [w h] — get or set the rectangle's dimensions in pixels. No extra args → returns w h. Two args → sets the width and height and recalculates the normalized position.
  • rect vname draw [0|1] — get or set whether the rectangle is actually drawn. 0 hides, 1 shows 👀 No extra args → returns the current draw flag.
  • rect vname lstyle [0|1] — get or set the line style. 0 = solid (that's the default, iykyk), 1 = dashed. No extra args → returns the current style. Heads up: non-zero values set dashed, and zero or negative values set solid.
  • rect vname lwidth [w] — get or set the line width in pixels. No extra args → returns the current width. Non-positive values set the width to 0. Like, all the way to zero. Not a vibe, but it's the rule 🫶
  • rect vname pos [x y] — get or set the rectangle's anchor position in pixels (origin is at the top-left, bestie). No extra args → returns x y. Two args → sets the position and recalculates the normalized coordinates.
  • rect vname rt port — raytrace the geometry inside the current rectangle area, sending the output to the framebuffer at the given port number 🔥 Requires exactly one argument. Has no effect if the rectangle has zero size (girl can't trace nothing 💀).
  • rect vname zoom — zoom the view so the area enclosed by the rectangle fills the screen. She adjusts the rectangle to match the window aspect ratio before zooming, because she's thoughtful like that 🌸 Has no effect if the rectangle has zero size.
  • rect vname vars — print all current rectangle parameters as variable = value pairs. Perfect for inspecting the complete rectangle state, like a full vibe check of every setting 👑
  • rect vname help — print the usage summary for all subcommands. When in doubt, ask for help, no shame 🫶

🌈 EXAMPLES

Example 1. Show the rectangle

mged> rect default draw 1

Enables display of the rubber band rectangle on the default view. She's visible, she's here, she's serving ✨

Example 2. Position and size the rectangle

mged> rect default cdim 1024 768
mged> rect default pos 200 100
mged> rect default dim 400 300

Sets the canvas to 1024×768 pixels, anchors the rectangle at pixel (200, 100), and gives it a 400×300 pixel size. The normalized view coordinates are calculated automatically — you don't have to lift a finger 💅

Example 3. Set the rectangle color to red

mged> rect default color 255 0 0

Sets the border color of the rectangle to red. Iconic. Powerful. Red. 🍓

Example 4. Use dashed lines

mged> rect default lstyle 1

Switches the rectangle border to a dashed line style. A little texture, a little drama 🎀

Example 5. Zoom to the rectangle area

mged> rect default zoom

Adjusts the view so that the area within the rectangle fills the display. Main character energy fr fr 👑

Example 6. Inspect all rectangle parameters

mged> rect default vars

Prints all current rectangle settings, e.g. position, dimensions, colors, draw flag, line style, and line width. The full scoop, the whole story 🦋

👑 AUTHOR

BRL-CAD Team — the collective. The girlies. The legends. 💜

💀 BUG REPORTS

Spotted a bug? A problem? Something lowkey broken? 🫶 Reports of bugs or problems should be submitted via electronic mail to devs@brlcad.org. Go tell them, they wanna know, I promise 😭

Okay that's the whole page, bestie — this was RECT(nged), brought to you by BRL-CAD ✨ mwah, go select something pretty 💖🎀🦋

📦 where this page comes from