PLANAR(1)

💅 PLANAR(1) — planar, bestie 💅

Okay so welcome to the PLANAR(1) page from the User Commands section. The main character is planar, and she converts overlapping coplanar polygons to tiles. Slay. 💖

🌸 NAME 🌸

planar — convert overlapping coplanar polygons to tiles

🦋 SYNOPSIS 🦋

planar [options] [input_file]

✨ DESCRIPTION ✨

So planar reads a file in OFF format and turns overlapping coplanar polygons into non-overlapping polygon tiles. Literally the glow-up. If input_file is not given, the program reads from standard input. Periodt. 💅

✨ Options ✨

• -h,--help — this help message (run off_util -H help for general help), iykyk.
• --version — version information.
• -l <lim> — minimum distance for unique vertex locations as a negative exponent. Default: 12, giving 1e-12.
• -o <file> — write output to file. Default: write to standard output.

🎀 Scene Options 🎀

• -M <mode> — color system mode. HSV=1, HSL=2, RGB=3 (default: 2).
• -d <opt> — blend overlapping (tile) or adjacent (merge) planar faces. tile=1, merge=2 (default: none).
• -p <opt> — polygon fill algorithm. angular=1, modulo2=2 (pnpoly), triangulation=3, even_overlap=4, alt_modulo2=5 (default: 1).
• -S — stitch seams created by tiling or merging.
• -R — split pinched faces.
• -r — rebuild compound model to separate vertices.
• -I — rid faces of extra in-line vertices.
• -e <opt> — blend existing explicit edges and/or vertices using blend options. e - edges, v - vertices, b - both (-d forces b, otherwise none).
• -E <opt> — remove explicit edges, blend new ones using face colors (sets -S). e - edges only, v - also blend vertices (default: none), V - also blend invisible vertices, s - strip edges and vertices.
• -c — CMY mode. Complementary colors. RGB->(RYB/GMO)->CMY->blend.
• -b <val> — brightness adjustment for areas of blended colors. Valid values -1.0 to +1.0 (default: no adjustment). Negative is darker, positive is lighter. At 0, an area with 2 blended colors will not change, but areas with 3 or more will become slightly darker. 💀

🌀 Winding Options 🌀

• -w <opt> — winding rule; include face parts according to winding number. Options: odd, even, positive, negative, nonzero, zero (default: none), zodd, zeven, zpositive, znegative (includes zero), or a symbol that comes before an integer: eq, ne, gt, ge, lt, le, meaning equal, not equal, greater than, greater than or equal, less than, less than or equal. Use a for absolute value, e.g. gea2.
• -z — use direction of normals for hemispherical winding numbers.
• -D — delete invisible faces created by winding rule.
• -O <opt> — orient the faces first (if possible) then for volume. positive=1, negative=2, reverse=3, or use flip=4, which reverses the orientation of the model as it was input.
• -C <xyz> — center of model for normals, three comma separated coordinates. 0 for origin (default: centroid).
• -H — turn off hole detection.
• -V — verbose output (list of winding numbers).

💖 Color Blending Options (for option -d, -M 1,2) 💖

• -s <sat> — HSV/HSL saturation curve. Greater than 0 (default: 1). 1.0 - no curve. Lower than 1.0 makes blends more pastel.
• -t <val> — HSV/HSL threshold to use average saturation (default: 1). Between 0.0 (all averaging) and 1.0 (no averaging).
• -v <val> — HSV/HSL value curve. Positive integer (default: 0). Simulates subtractive coloring for blending 3 or more colors. RGB: Red+Green+Blue = White, Cyan+Magenta+Yellow = Black. RYB: Red+Yellow+Blue = Black, Green+Magenta+Orange = White. 1.0 - no curve. A lower-than-1.0 number makes blends lighter. 0.0 - use average value instead.
• -u <val> — HSV/HSL value advance. Rotates meaning of white and black. Valid values 0.0 to 120.0 degrees (default: 0).
• -a <int> — alpha for blend. average=1, minimum=2, maximum=3 (default: 3).
• -y — RYB mode. Blend colors as in Red-Yellow-Blue color wheel.

🌈 Coloring Options (run off_util -H color for help on color formats) 🌈

• -F <opt> — take face colors from map (processed before -d). n - unique color for faces with same normals, p - unique color for faces on same planes only, o - unique color for faces on same and opposite normals.
• -T <t,e> — transparency. From 0 (invisible) to 255 (opaque). Element is any or all of: v - vertices, e - edges, f - faces, a - all (default: f).
• -Z <col> — color for areas found colorless by winding (default: invisible). Keyword: b - force a color blend.
• -W <opt> — color by winding number, using maps (overrides option -F). w - use actual winding number, a - absolute value of winding number, n - negative of absolute value of winding number.
• -m <maps> — color maps for faces to be tried in turn (default: compound).
• -n <maps> — maps for negative winding numbers (default: calculated). (Map position zero not used for negative winding maps.)

💜 SEE ALSO 💜

The full documentation for planar is maintained as a Texinfo manual. If the info and planar programs are properly installed at your site, the command

info planar

should give you access to the complete manual. 🫶

🫶 Cute sign-off: version Antiprism 0.32, source http://www..., manual tag PLANAR(1), and the original footer did not list a date, so I’m not making one up. Mwah 💋