ADMESH(1)

Okay bestie, welcome to the ADMESH(1) page, the General Commands Manual entry for ADMesh, so it's official and it's giving main character πŸ’…πŸŽ€

✨ NAME ✨

ADMesh πŸ’– is a program for processing triangulated solid meshes 🫢

πŸŽ€ SYNOPSIS πŸŽ€

admesh [OPTION]... file

🌸 DESCRIPTION 🌸

Okay so, ADMesh is a program for processing triangulated solid meshes ✨ Right now it only reads the STL file format (the one used for rapid prototyping apps), but it can write STL, VRML, OFF, and DXF files too πŸ’…

By default, ADMesh runs all of the mesh checking and repairing options on your input file πŸ”₯ That means it checks exact, nearby, remove-unconnected, fill-holes, normal-directions, and normal-values. The file type (ASCII or binary) gets detected automatically 🧚 Your input file is not modified unless you ask for it with the --write option πŸ™ˆ So if you type this:

admesh sphere.stl

ADMesh opens and reads sphere.stl, checks it, fixes anything that needs fixing, and prints the results. The results are not saved πŸ’€

The default tolerance is the length of the shortest edge of the mesh πŸ“ The default number of iterations is 2, and the default increment is 0.01% of the diameter of a sphere that encloses the entire mesh ✨

⚠️ If you give any of --exact, --nearby, --remove-unconnected, --fill-holes, --normal-directions, --reverse-all, --normal-values, or --no-check, then ADMesh skips every other check, except the ones you ask for or the ones it needs before your chosen check can run 😀

For example, this command:

admesh --remove-unconnected sphere.stl

would first do an exact check, since it's required, and then remove the unconnected facets. The results get printed and no other checks happen πŸ¦‹

πŸ’œ OPTIONS πŸ’œ

  • --x-rotate=angle β€” Spin it counter-clockwise (CCW) around the x-axis by angle degrees πŸŒ€
  • --y-rotate=angle β€” Spin it CCW around the y-axis by angle degrees πŸŒ€
  • --z-rotate=angle β€” Spin it CCW around the z-axis by angle degrees πŸŒ€
  • --xy-mirror β€” Mirror it across the xy plane πŸͺž
  • --yz-mirror β€” Mirror it across the yz plane πŸͺž
  • --xz-mirror β€” Mirror it across the xz plane πŸͺž
  • --scale=factor β€” Scale the file by factor, which means multiply by factor πŸ“
  • --translate=x,y,z β€” Translate (move) the file to x, y, and z πŸš€
  • --merge=name β€” Merge the file called name with your input file πŸ«‚
  • -e, --exact β€” Only check for perfectly matched edges πŸ’…
  • -n, --nearby β€” Find and connect nearby facets, and fix the bad ones πŸ”§
  • -t, --tolerance=tol β€” Set the initial tolerance for the nearby check to tol 🎯
  • -i, --iterations=i β€” Set the number of iterations for the nearby check to i πŸ”
  • -m, --increment=inc β€” How much to bump the tolerance by after each iteration, inc πŸ“ˆ
  • -u, --remove-unconnected β€” Remove facets that have 0 neighbors πŸ—‘οΈ
  • -f, --fill-holes β€” Add facets to fill holes πŸ•³οΈ
  • -d, --normal-directions β€” Check and fix the direction of the normals (i.e. cw, ccw) 🧭
  • --reverse-all β€” Reverse the directions of all facets and normals πŸ”„
  • -v, --normal-values β€” Check and fix the normal values πŸ’―
  • -c, --no-check β€” Don't run any checks on the input file πŸ™…
  • -b, --write-binary-stl=name β€” Output a binary STL file called name πŸ’Ύ
  • -a, --write-ascii-stl=name β€” Output an ascii STL file called name πŸ“
  • --write-off=name β€” Output a Geomview OFF format file called name πŸ¦„
  • --write-dxf=name β€” Output a DXF format file called name 🌈
  • --write-vrml=name β€” Output a VRML format file called name 🌐
  • --help β€” Display this help and exit πŸ†˜
  • --version β€” Output version information and exit πŸ”–

The functions run in the same order as the options are listed here, so check this list if you want to know what happens when, say, --translate and --merge are used together πŸ‘€ The order you type options on the command line doesn't matter ✨

🧚 EXAMPLES 🧚

To do all the checks except nearby, you'd use this:

admesh --exact --remove-unconnected --fill-holes --normal-directions --normal-values sphere.stl

Actually, the exact check is required before remove-unconnected, and remove-unconnected is required before --fill-holes, so you can shorten it to the same result:

admesh --fill-holes --normal-directions --normal-values sphere.stl

You can get the same results with the short options too:

admesh -fudev sphere.stl

or

admesh -fdv sphere.stl

These all do the same thing:

admesh sphere.stl
admesh -fundev sphere.stl
admesh -f -u -n -d -e -v sphere.stl

The -fundev options are already implied by default, so you don't need to type them πŸ’– To drop one of the checks, just remove its letter from the "word" fundev 🫢

🌈 SEE ALSO 🌈

For more info about the options and output, read admesh-doc.txt. It's usually in the /usr/share/doc/admesh-x.xx dir πŸ“š

Copyright (C) 1995, 1996 Anthony D. Martin <amartin@engr.csulb.edu> πŸ‘‘

This program is free software πŸ¦‹ You can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License or (at your option) any later version πŸ’œ

This program is distributed in the hope that it'll be useful, but WITHOUT ANY WARRANTY. That means no implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE πŸ™ˆ Check the GNU General Public License for more details ✨

You should have received a copy of the GNU General Public License along with this program. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 🫢


Bye bestie πŸ’– This page is from the User Commands set, dated 21/10/2013, and it's ADMESH(1) forever 🌸✨