From f66e0e209ea9f84805cc5db74803a1704bc43e86 Mon Sep 17 00:00:00 2001 From: Benjamin Morgan Date: Mon, 1 Jun 2026 18:07:41 -0600 Subject: [PATCH] Show key labels for assembly --- .gitignore | 270 +++++------ LICENSE | 1348 ++++++++++++++++++++++++++-------------------------- main.py | 1114 ++++++++++++++++++++++--------------------- 3 files changed, 1370 insertions(+), 1362 deletions(-) diff --git a/.gitignore b/.gitignore index df1f9e2..b29a758 100644 --- a/.gitignore +++ b/.gitignore @@ -1,135 +1,135 @@ -# Byte-compiled / optimized / DLL files -__pycache__/ -*.py[cod] -*$py.class - -# C extensions -*.so - -# Distribution / packaging -.Python -build/ -develop-eggs/ -dist/ -downloads/ -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -wheels/ -pip-wheel-metadata/ -share/python-wheels/ -*.egg-info/ -.installed.cfg -*.egg -MANIFEST - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports -htmlcov/ -.tox/ -.nox/ -.coverage -.coverage.* -.cache -nosetests.xml -coverage.xml -*.cover -*.py,cover -.hypothesis/ -.pytest_cache/ - -# Translations -*.mo -*.pot - -# Django stuff: -*.log -local_settings.py -db.sqlite3 -db.sqlite3-journal - -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# Sphinx documentation -docs/_build/ - -# PyBuilder -target/ - -# Jupyter Notebook -.ipynb_checkpoints - -# IPython -profile_default/ -ipython_config.py - -# pyenv -.python-version - -# pipenv -# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. -# However, in case of collaboration, if having platform-specific dependencies or dependencies -# having no cross-platform support, pipenv may install dependencies that don't work, or not -# install all needed dependencies. -#Pipfile.lock - -# PEP 582; used by e.g. github.com/David-OConnor/pyflow -__pypackages__/ - -# Celery stuff -celerybeat-schedule -celerybeat.pid - -# SageMath parsed files -*.sage.py - -# Environments -.env -.venv -env/ -venv/ -ENV/ -env.bak/ -venv.bak/ - -# Spyder project settings -.spyderproject -.spyproject - -# Rope project settings -.ropeproject - -# mkdocs documentation -/site - -# mypy -.mypy_cache/ -.dmypy.json -dmypy.json - -# Pyre type checker -.pyre/ - -# Bundle Script -*.bat - -# Pycharm -.idea/ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +pip-wheel-metadata/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# Bundle Script +*.bat + +# Pycharm +.idea/ diff --git a/LICENSE b/LICENSE index f288702..3877ae0 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,674 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - 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 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See 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, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See 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, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/main.py b/main.py index 3f574bb..eeba431 100644 --- a/main.py +++ b/main.py @@ -1,553 +1,561 @@ -import os -import sys -from copy import copy, deepcopy -from math import sqrt, ceil, floor -import numpy as np -import tkinter as tk -from tkinter import filedialog, LEFT, X -from rectpack import newPacker, float2dec, PackingMode, PackingBin, SORT_NONE -from ctypes import windll - -GWL_EXSTYLE = -20 -WS_EX_APPWINDOW = 0x00040000 -WS_EX_TOOLWINDOW = 0x00000080 - -import trimesh -from trimesh.path.entities import Text -from trimesh.path.exchange.export import export_path -from trimesh.path.creation import rectangle -from trimesh.transformations import scale_matrix - -# declare "globals" for use across functions -mesh = None -unit = None -sections = None -pdfSections = None -combined = None -bins = None -blocked = False -saveBinsButton = None -showKeyButton = None -exportHeightEntry = None -exportWidthEntry = None -exportKerfEntry = None -lastW = None -lastH = None -lastK = None -resultWinHeight = None -resultWinWidth = None - - -# shows dimensions and layer count in main gui window -# updates live when model has been selected -def calcDim(args=None): - scale = 1 - - # if scale is number set scale, else reset text entry - try: - scale = float(scaleFactorEntry.get()) - except ValueError: - scaleFactorEntry.config(text="1") - - # get and display scaled bounds - dimensions = mesh.bounds - - dimensionsAfterLabel.config(text="Scaled Dimensions (" + unit + ")") - xAfterlabel.config(text="x: " + str(round((dimensions[1][0] - dimensions[0][0]) * scale, 2))) - yAfterlabel.config(text="y: " + str(round((dimensions[1][1] - dimensions[0][1]) * scale, 2))) - zAfterlabel.config(text="z: " + str(round((dimensions[1][2] - dimensions[0][2]) * scale, 2))) - - # get and display number of layers - try: - thickness = float(layerThicknessEntry.get()) - if thickness == 0: - numLayersLabel.config(text="Layers: N/A") - else: - numLayersLabel.config( - text="Layers: " + str(ceil(((dimensions[1][2] - dimensions[0][2]) * scale) / thickness))) - except ValueError: - numLayersLabel.config(text="Layers: N/A") - - -# opens 3D model and fills gui elements with appropriate info (base unit, model name, model dimensions, etc) -def getFile(): - # maps base unit result to abbreviation - unitDict = { - "millimeters": "mm", - "inches": "in" - } - - # ask for file - filename = tk.filedialog.askopenfilename(initialdir="/", - title="Select a File", - filetypes=((".stl files", "*.stl"), ("all files", ".*"))) - - # add model file path to gui - modelEntry.config(text=filename) - - # load the mesh from filename - global mesh, unit - mesh = trimesh.load_mesh(filename) - - # get base unit, add to gui - unit = trimesh.units.units_from_metadata(mesh, guess=True) - try: - unit = unitDict[unit] - except KeyError: - pass - - layerThicknessLabel.config(text="Layer Thickness (" + unit + "): ") - - # add model dimensions to gui - calcDim() - - # now that model is open, listen for changes in relevant text entries to update dimensions shown in gui - scaleFactorEntry.bind('', calcDim) - layerThicknessEntry.bind('', calcDim) - - -def focus_results(): - # bring results window forward - if results is not None and 'normal' == results.state(): - results.focus_set() - results.geometry("") - - return - - -# run slices, show export window -def go(): - global combined, sections, results, saveBinsButton, showKeyButton, showKey, exportHeightEntry, exportWidthEntry, exportKerfEntry, resultWinWidth, resultWinHeight - - focus_results() - - # scale model according to text entry in main window - mesh.apply_transform(scale_matrix(float(scaleFactorEntry.get()), [0, 0, 0])) - - # slice the mesh into evenly spaced chunks along z - # this takes the (2,3) bounding box and slices it into [minz, maxz] - z_extents = mesh.bounds[:, 2] - # slice every x (text entry) model units (eg, inches) - z_levels = np.arange(*z_extents, step=float(layerThicknessEntry.get())) - - # create cross section outlines - sections = mesh.section_multiplane(plane_origin=mesh.bounds[0], - plane_normal=[0, 0, 1], - heights=z_levels) - - # in the case that slice did not intersect with model, remove section - sections = list(filter(lambda element: element is not None, sections)) - - combined = np.sum(sections) - - # GUI stuff - results = tk.Toplevel(root) - results.title("Results") - results.protocol("WM_DELETE_WINDOW", clearResults) - results.resizable(0, 0) - - buttonFrame = tk.Frame(results) - viewFrame = tk.Frame(buttonFrame) - sectionsButton = tk.Button(viewFrame, text="View Layers", command=plot) - modelButton = tk.Button(viewFrame, text="View Model", command=model) - exportButton = tk.Button(buttonFrame, text="Export Layers to SVG", command=export) - - heightFrame = tk.Frame(results) - exportHeight = tk.Label(heightFrame, text="Height (" + unit + "): ") - exportHeightEntry = tk.Entry(heightFrame, width=10) - - widthFrame = tk.Frame(results) - exportWidth = tk.Label(widthFrame, text="Width (" + unit + "): ") - exportWidthEntry = tk.Entry(widthFrame, width=10) - - kerfFrame = tk.Frame(results) - exportKerf = tk.Label(kerfFrame, text="Kerf (" + unit + "): ") - exportKerfEntry = tk.Entry(kerfFrame, width=10) - - exportFileButton = tk.Button(results, text="Prepare Cuts", command=( - lambda *args: exportFile(float(exportHeightEntry.get()), float(exportWidthEntry.get()), - float(exportKerfEntry.get())))) - - exportFrame = tk.Frame(results) - saveBinsButton = tk.Button(exportFrame, text="Export Cut Files", command=saveFiles) - showKeyButton = tk.Checkbutton(exportFrame, text='Key?', variable=showKey, onvalue=True, offvalue=False) - - buttonFrame.pack(pady=10, padx=5) - viewFrame.pack(pady=5) - sectionsButton.pack(side=LEFT, padx=1) - modelButton.pack(side=LEFT, padx=1) - exportButton.pack() - - heightFrame.pack() - exportHeight.pack(side=LEFT) - exportHeightEntry.pack(side=LEFT) - widthFrame.pack() - exportWidth.pack(side=LEFT) - exportWidthEntry.pack(side=LEFT) - kerfFrame.pack() - exportKerf.pack(side=LEFT) - exportKerfEntry.pack(side=LEFT) - - exportFileButton.pack(padx=1) - exportFrame.pack(pady=5, padx=5) - - results.update() - results.geometry(f'+{root.winfo_rootx()+int((root.winfo_width()-results.winfo_width())/2)}+{root.winfo_rooty()+int((root.winfo_height()-results.winfo_height())/2)}') - - resultWinWidth = results.winfo_width() - resultWinHeight = results.winfo_height() - results.mainloop() - - -# empty results, hide window so process can be run again -def clearResults(): - global results - - results.destroy() - results = None - - -# show top-down view of stacked layers -def plot(): - global blocked - - if not blocked: - blocked = True - # summing the array of Path2D objects will put all of the curves - # into one Path2D object, which can be plotted easily - combined.show() - - blocked = False - - -# shows unsliced model -def model(): - global blocked - - if not blocked: - blocked = True - - scene = mesh.scene() - camera = scene.camera - camera.resolution = (640, 520) - scene.base_frame = "Model" - scene.camera = camera - scene.show() - - blocked = False - - -# save layer svg's to selected directory -def export(): - global blocked - - if not blocked: - blocked = True - - # ask for directory - directory = filedialog.askdirectory() - - for i in range(len(sections)): - export_path(sections[i], file_type="svg", file_obj=directory + "/layer" + str(i) + ".svg") - - focus_results() - - blocked = False - - -def checkPrepared(args=None): - shouldRemove = False - try: - shouldRemove = float(exportWidthEntry.get()) != lastW or float(exportHeightEntry.get()) != lastH or float(exportKerfEntry.get()) != lastK - except ValueError: - shouldRemove = True - finally: - if shouldRemove: - saveBinsButton.pack_forget() - showKeyButton.pack_forget() - - results.geometry(f"{resultWinHeight}x{resultWinHeight}") - else: - if not saveBinsButton.winfo_ismapped(): - results.geometry("") - saveBinsButton.pack(side=LEFT, padx=1) - showKeyButton.pack(side=LEFT) - -# prepares bins for export, performs bin packing -# arguments: bin height, bin width, kerf -def exportFile(h, w, k): - global blocked, bins, pdfSections, exportWidthEntry, exportHeightEntry, exportKerfEntry, lastW, lastH, lastK - - # if other window is not open - if not blocked: - blocked = True - - lastW = w - lastH = h - lastK = k - - # prepare packers, one with rotation enabled, one disabled, results will be compared later - packer = newPacker(mode=PackingMode.Offline, bin_algo=PackingBin.Global, sort_algo=SORT_NONE, rotation=False) - rotPacker = newPacker(mode=PackingMode.Offline, bin_algo=PackingBin.Global, sort_algo=SORT_NONE, rotation=True) - - # add rectangles to packers - for i in range(len(sections)): - dimensions = sections[i].bounds - - sect = deepcopy(sections[i]) - sect.apply_translation((-dimensions[0][0], -dimensions[0][1])) - - dimensions = sect.bounds - - # set dimensions to bounds plus kerf - r = (float2dec((dimensions[1][0]) + k, 5), float2dec((dimensions[1][1]) + k, 5)) - packer.add_rect(*r, i) - rotPacker.add_rect(*r, i) - - # add bins to packers - packer.add_bin(float2dec(w, 5), float2dec(h, 5), count=float("inf")) - rotPacker.add_bin(float2dec(w, 5), float2dec(h, 5), count=float("inf")) - - # run pack - packer.pack() - rotPacker.pack() - - # init var to largest bin area of packers, will be overridden to find minimum area used, minimizing material wastage - leastBinSum = w * h * max(len(packer), len(rotPacker)) - leastPacker = packer - # loop through packers - for pack in (packer, rotPacker): - binSum = 0 - # loop through packed bins - for i in range(len(pack)): - leastX = w - leastY = h - greatestX = 0 - greatestY = 0 - # loop through packed rectangles - for rect in pack.rect_list(): - # if rectangles is in bin - if rect[0] == i: - # check to see if rectangle is closer to the top corner than the previous closest - if rect[1] < leastX: - leastX = rect[1] - if rect[2] < leastY: - leastY = rect[2] - # check to see if rectangle is closer to the bottom corner than the previous closest - if rect[3] + rect[1] > greatestX: - greatestX = rect[3] + rect[1] - if rect[4] + rect[2] > greatestY: - greatestY = rect[4] + rect[2] - # add used area of bin to total - binSum += ((greatestX - leastX) * (greatestY - leastY)) - # override packer least used area if needed - if binSum < leastBinSum: - leastBinSum = binSum - leastPacker = pack - - # use algo that resulted in the least wastage - packer = leastPacker - bins = list() - displaySections = list() - pdfSections = list() - # create visual representation of bins for display - for i in range(len(packer)): - bins.append(list()) - - rowColLen = ceil(sqrt(len(packer))) - row = floor(i / rowColLen) - col = i % rowColLen - - displayBin = rectangle(((0, 0), (w, h))) - displayBin.apply_translation( - ((packer[i].width * 11 / 10) * col, -((packer[i].height * 11 / 10) * row + packer[i].height))) - - displaySections.append(displayBin) - pdfSections.append(displayBin) - - # add rectangles to their designated bins - for rect in packer.rect_list(): - section = deepcopy(sections[rect[5]]) - bin = rect[0] - - # find position of bin for display purposes (bins displayed in grid, find row & col) - rowColLen = ceil(sqrt(len(packer))) - row = floor((bin) / rowColLen) - col = bin % rowColLen - - # check if rectangle has rotated, if so, rotate - dimensions = section.bounds - if rect[3] != float2dec((dimensions[1][0]) + k, 5) and rect[4] != float2dec((dimensions[1][1]) + k, 5): - section.apply_transform(((0, -1, 0), (1, 0, 0), (0, 0, 1))) - dimensions = section.bounds - section.apply_translation((-dimensions[0][0], -dimensions[0][1])) - - # find x, y translation to move rectangle to designated spot in bin - section.apply_translation((rect[1] + float2dec(k / 2, 5), rect[2] + float2dec(k / 2, 5))) - bins[bin].append(section) - - # find x, y translation to offset display rectangle to the proper bin in the bin grid - displaySection = copy(section) - displaySection.apply_translation( - ((packer[bin].width * 11 / 10) * col, -((packer[bin].height * 11 / 10) * row + packer[bin].height))) - displaySections.append(displaySection) - - # for display only, add rectangle bounding box, for visualization of packing performance - displayRect = rectangle(((displaySection.bounds[0][0], displaySection.bounds[0][1]), - (displaySection.bounds[1][0], displaySection.bounds[1][1]))) - displaySections.append(displayRect) - - # also add bounding box to key display, real shape outline not added for readability - pdfRect = copy(displayRect) - pdfRect.entities = np.append(pdfRect.entities, Text(0, str(rect[5] + 1), align=('left', 'bottom'))) - pdfSections.append(pdfRect) - - # show packed rectangles and bins in human understandable format - displayCombine = np.sum(displaySections) - displayCombine.show() - - # now that export has been prepared, show save buttons - saveBinsButton.pack(side=LEFT, padx=1) - showKeyButton.pack(side=LEFT) - - exportWidthEntry.bind('', checkPrepared) - exportHeightEntry.bind('', checkPrepared) - exportKerfEntry.bind('', checkPrepared) - - focus_results() - - blocked = False - - -# save bins and show key -def saveFiles(): - global blocked - - if not blocked: - blocked = True - - # ask for directory selection - directory = filedialog.askdirectory() - - # export bins - for i in range(len(bins)): - exportCombine = np.sum(bins[i]) - export_path(exportCombine, file_type="svg", file_obj=directory + "/bin" + str(i) + ".svg") - - focus_results() - - # show key - if (showKey.get()): - pdfCombine = np.sum(pdfSections) - pdfCombine.show() - - blocked = False - - -# forces window to appear in taskbar, windows specific -def set_appwindow(root): - hwnd = windll.user32.GetParent(root.winfo_id()) - style = windll.user32.GetWindowLongW(hwnd, GWL_EXSTYLE) - style = style & ~WS_EX_TOOLWINDOW - style = style | WS_EX_APPWINDOW - res = windll.user32.SetWindowLongW(hwnd, GWL_EXSTYLE, style) - # re-assert the new window style - root.wm_withdraw() - root.after(10, lambda: root.wm_deiconify()) - - -# for newer versions of pyinstaller, needed to retrieve icon image -def resource_path(relative_path): - """ Get absolute path to resource, works for dev and for PyInstaller """ - try: - # PyInstaller creates a temp folder and stores path in _MEIPASS - base_path = sys._MEIPASS - except Exception: - base_path = os.path.abspath(".") - - return os.path.join(base_path, relative_path) - - -results = None - -# create base window -root = tk.Tk() -root.title("3DSlicer") -root.option_add('*Font', '19') -root.attributes("-toolwindow", 1) -p1 = tk.PhotoImage(file=resource_path('icon.png')) -# Icon set for program window -root.iconphoto(True, p1) -root.resizable(0, 0) - -# clear children of base window -clearList = root.winfo_children() - -for child in clearList: - child.destroy() - -# set default state of key checkbox -showKey = tk.BooleanVar() - -# generate window -menubar = tk.Menu(root) -filemenu = tk.Menu(menubar, tearoff=0) - -# TODO: filemenu.add_command(label="About", command=about) -filemenu.add_command(label="Exit", command=root.destroy) -menubar.add_cascade(label="File", menu=filemenu) - -modelFrame = tk.Frame(root) -topModelFrame = tk.Frame(modelFrame) -modelLabel = tk.Label(topModelFrame, text="Model: ") -modelEntry = tk.Label(topModelFrame, text="N/A") -modelBrowse = tk.Button(modelFrame, text="Browse", command=getFile) - -entriesFrame = tk.Frame(root) -layerEntryFrame = tk.Frame(entriesFrame) -layerThicknessLabel = tk.Label(layerEntryFrame, text="Layer Thickness (N/A): ") -layerThicknessEntry = tk.Entry(layerEntryFrame, width=5) - -scaleEntryFrame = tk.Frame(entriesFrame) -scaleFactorLabel = tk.Label(scaleEntryFrame, text="Model Scale Factor: ") -scaleFactorEntry = tk.Entry(scaleEntryFrame, width=5) -scaleFactorEntry.insert(0, "1") - -numbersFrame = tk.Frame(root) -dimensionsAfterLabel = tk.Label(numbersFrame, text="Scaled Dimensions (N/A)") -xAfterlabel = tk.Label(numbersFrame, text="x: N/A") -yAfterlabel = tk.Label(numbersFrame, text="y: N/A") -zAfterlabel = tk.Label(numbersFrame, text="z: N/A") - -numLayersLabel = tk.Label(root, text="Layers: N/A") - -goButton = tk.Button(root, text="Go", command=go) - -root.config(menu=menubar) - -modelFrame.pack(pady=10) -topModelFrame.pack() -modelLabel.pack(side=LEFT) -modelEntry.pack(side=LEFT) -modelBrowse.pack() - -entriesFrame.pack() -numbersFrame.pack(pady=10) -layerEntryFrame.pack() -scaleEntryFrame.pack(fill=X) -scaleFactorLabel.pack(side=LEFT) -scaleFactorEntry.pack(side=LEFT) -layerThicknessLabel.pack(side=LEFT) -layerThicknessEntry.pack(side=LEFT) - -dimensionsAfterLabel.pack() -xAfterlabel.pack() -yAfterlabel.pack() -zAfterlabel.pack() - -numLayersLabel.pack() - -goButton.pack(ipadx=10, pady=5) - -root.after(10, lambda: set_appwindow(root)) -root.mainloop() +import os +import sys +from copy import copy, deepcopy +from math import sqrt, ceil, floor +import numpy as np +import tkinter as tk +from tkinter import filedialog, LEFT, X +from rectpack import newPacker, float2dec, PackingMode, PackingBin, SORT_NONE +from ctypes import windll + +GWL_EXSTYLE = -20 +WS_EX_APPWINDOW = 0x00040000 +WS_EX_TOOLWINDOW = 0x00000080 + +import trimesh +from trimesh.path.entities import Text +from trimesh.path.exchange.export import export_path +from trimesh.path.creation import rectangle +from trimesh.transformations import scale_matrix + +# declare "globals" for use across functions +mesh = None +unit = None +sections = None +pdfSections = None +combined = None +bins = None +blocked = False +exportFrame = None +saveBinsButton = None +showKeyButton = None +exportHeightEntry = None +exportWidthEntry = None +exportKerfEntry = None +lastW = None +lastH = None +lastK = None +resultWinHeight = None +resultWinWidth = None + + +# shows dimensions and layer count in main gui window +# updates live when model has been selected +def calcDim(args=None): + scale = 1 + + # if scale is number set scale, else reset text entry + try: + scale = float(scaleFactorEntry.get()) + except ValueError: + scaleFactorEntry.config(text="1") + + # get and display scaled bounds + dimensions = mesh.bounds + + dimensionsAfterLabel.config(text="Scaled Dimensions (" + unit + ")") + xAfterlabel.config(text="x: " + str(round((dimensions[1][0] - dimensions[0][0]) * scale, 2))) + yAfterlabel.config(text="y: " + str(round((dimensions[1][1] - dimensions[0][1]) * scale, 2))) + zAfterlabel.config(text="z: " + str(round((dimensions[1][2] - dimensions[0][2]) * scale, 2))) + + # get and display number of layers + try: + thickness = float(layerThicknessEntry.get()) + if thickness == 0: + numLayersLabel.config(text="Layers: N/A") + else: + numLayersLabel.config( + text="Layers: " + str(ceil(((dimensions[1][2] - dimensions[0][2]) * scale) / thickness))) + except ValueError: + numLayersLabel.config(text="Layers: N/A") + + +# opens 3D model and fills gui elements with appropriate info (base unit, model name, model dimensions, etc) +def getFile(): + # maps base unit result to abbreviation + unitDict = { + "millimeters": "mm", + "inches": "in" + } + + # ask for file + filename = tk.filedialog.askopenfilename(initialdir="/", + title="Select a File", + filetypes=((".stl files", "*.stl"), ("all files", ".*"))) + + # add model file path to gui + modelEntry.config(text=filename) + + # load the mesh from filename + global mesh, unit + mesh = trimesh.load_mesh(filename) + + # get base unit, add to gui + unit = trimesh.units.units_from_metadata(mesh, guess=True) + try: + unit = unitDict[unit] + except KeyError: + pass + + layerThicknessLabel.config(text="Layer Thickness (" + unit + "): ") + + # add model dimensions to gui + calcDim() + + # now that model is open, listen for changes in relevant text entries to update dimensions shown in gui + scaleFactorEntry.bind('', calcDim) + layerThicknessEntry.bind('', calcDim) + + +def focus_results(): + # bring results window forward + if results is not None and 'normal' == results.state(): + results.focus_set() + + return + + +# run slices, show export window +def go(): + global combined, sections, results, exportFrame, showKeyButton, saveBinsButton, exportHeightEntry, exportWidthEntry, exportKerfEntry, resultWinWidth, resultWinHeight + + focus_results() + + # scale model according to text entry in main window + mesh.apply_transform(scale_matrix(float(scaleFactorEntry.get()), [0, 0, 0])) + + # slice the mesh into evenly spaced chunks along z + # this takes the (2,3) bounding box and slices it into [minz, maxz] + z_extents = mesh.bounds[:, 2] + # slice every x (text entry) model units (eg, inches) + z_levels = np.arange(*z_extents, step=float(layerThicknessEntry.get())) + + # create cross section outlines + sections = mesh.section_multiplane(plane_origin=mesh.bounds[0], + plane_normal=[0, 0, 1], + heights=z_levels) + + # in the case that slice did not intersect with model, remove section + sections = list(filter(lambda element: element is not None, sections)) + + combined = np.sum(sections) + + # GUI stuff + results = tk.Toplevel(root) + results.title("Results") + results.protocol("WM_DELETE_WINDOW", clearResults) + results.resizable(0, 0) + + buttonFrame = tk.Frame(results) + viewFrame = tk.Frame(buttonFrame) + sectionsButton = tk.Button(viewFrame, text="View Layers", command=plot) + modelButton = tk.Button(viewFrame, text="View Model", command=model) + exportButton = tk.Button(buttonFrame, text="Export Layers to SVG", command=export) + + heightFrame = tk.Frame(results) + exportHeight = tk.Label(heightFrame, text="Height (" + unit + "): ") + exportHeightEntry = tk.Entry(heightFrame, width=10) + + widthFrame = tk.Frame(results) + exportWidth = tk.Label(widthFrame, text="Width (" + unit + "): ") + exportWidthEntry = tk.Entry(widthFrame, width=10) + + kerfFrame = tk.Frame(results) + exportKerf = tk.Label(kerfFrame, text="Kerf (" + unit + "): ") + exportKerfEntry = tk.Entry(kerfFrame, width=10) + + exportFileButton = tk.Button(results, text="Prepare Cuts", command=( + lambda *args: exportFile(float(exportHeightEntry.get()), float(exportWidthEntry.get()), + float(exportKerfEntry.get())))) + + exportFrame = tk.Frame(results) + saveBinsButton = tk.Button(exportFrame, text="Export Cut Files", command=saveFiles) + showKeyButton = tk.Button(exportFrame, text='View Key', command=showKey) + + buttonFrame.pack(pady=10, padx=5) + viewFrame.pack(pady=5) + sectionsButton.pack(side=LEFT, padx=1) + modelButton.pack(side=LEFT, padx=1) + exportButton.pack() + + heightFrame.pack() + exportHeight.pack(side=LEFT) + exportHeightEntry.pack(side=LEFT) + widthFrame.pack() + exportWidth.pack(side=LEFT) + exportWidthEntry.pack(side=LEFT) + kerfFrame.pack() + exportKerf.pack(side=LEFT) + exportKerfEntry.pack(side=LEFT) + + exportFileButton.pack(pady=(0, 5), padx=1) + + saveBinsButton.pack(side=LEFT, padx=1) + showKeyButton.pack(side=LEFT, padx=1) + + results.update() + results.geometry( + f'+{root.winfo_rootx() + int((root.winfo_width() - results.winfo_width()) / 2)}+{root.winfo_rooty() + int((root.winfo_height() - results.winfo_height()) / 2)}') + + resultWinWidth = results.winfo_width() + resultWinHeight = results.winfo_height() + results.mainloop() + + +# empty results, hide window so process can be run again +def clearResults(): + global results + + results.destroy() + results = None + + +# show top-down view of stacked layers +def plot(): + global blocked + + if not blocked: + blocked = True + # summing the array of Path2D objects will put all of the curves + # into one Path2D object, which can be plotted easily + combined.show() + + blocked = False + + +# shows unsliced model +def model(): + global blocked + + if not blocked: + blocked = True + + scene = mesh.scene() + camera = scene.camera + camera.resolution = (640, 520) + scene.base_frame = "Model" + scene.camera = camera + scene.show() + + blocked = False + + +# save layer svg's to selected directory +def export(): + global blocked + + if not blocked: + blocked = True + + # ask for directory + directory = filedialog.askdirectory() + + for i in range(len(sections)): + export_path(sections[i], file_type="svg", file_obj=directory + "/layer" + str(i) + ".svg") + + focus_results() + + blocked = False + + +def checkPrepared(args=None): + shouldRemove = False + try: + shouldRemove = float(exportWidthEntry.get()) != lastW or float(exportHeightEntry.get()) != lastH or float( + exportKerfEntry.get()) != lastK + except ValueError: + shouldRemove = True + finally: + if shouldRemove: + exportFrame.pack_forget() + else: + if not exportFrame.winfo_ismapped(): + exportFrame.pack(pady=(0, 5), padx=5) + + +# prepares bins for export, performs bin packing +# arguments: bin height, bin width, kerf +def exportFile(h, w, k): + global blocked, bins, pdfSections, exportWidthEntry, exportHeightEntry, exportKerfEntry, lastW, lastH, lastK + + # if other window is not open + if not blocked: + blocked = True + + lastW = w + lastH = h + lastK = k + + # prepare packers, one with rotation enabled, one disabled, results will be compared later + packer = newPacker(mode=PackingMode.Offline, bin_algo=PackingBin.Global, sort_algo=SORT_NONE, rotation=False) + rotPacker = newPacker(mode=PackingMode.Offline, bin_algo=PackingBin.Global, sort_algo=SORT_NONE, rotation=True) + + # add rectangles to packers + for i in range(len(sections)): + dimensions = sections[i].bounds + + sect = deepcopy(sections[i]) + sect.apply_translation((-dimensions[0][0], -dimensions[0][1])) + + dimensions = sect.bounds + + # set dimensions to bounds plus kerf + r = (float2dec((dimensions[1][0]) + k, 5), float2dec((dimensions[1][1]) + k, 5)) + packer.add_rect(*r, i) + rotPacker.add_rect(*r, i) + + # add bins to packers + packer.add_bin(float2dec(w, 5), float2dec(h, 5), count=float("inf")) + rotPacker.add_bin(float2dec(w, 5), float2dec(h, 5), count=float("inf")) + + # run pack + packer.pack() + rotPacker.pack() + + # init var to largest bin area of packers, will be overridden to find minimum area used, minimizing material wastage + leastBinSum = w * h * max(len(packer), len(rotPacker)) + leastPacker = packer + # loop through packers + for pack in (packer, rotPacker): + binSum = 0 + # loop through packed bins + for i in range(len(pack)): + leastX = w + leastY = h + greatestX = 0 + greatestY = 0 + # loop through packed rectangles + for rect in pack.rect_list(): + # if rectangles is in bin + if rect[0] == i: + # check to see if rectangle is closer to the top corner than the previous closest + if rect[1] < leastX: + leastX = rect[1] + if rect[2] < leastY: + leastY = rect[2] + # check to see if rectangle is closer to the bottom corner than the previous closest + if rect[3] + rect[1] > greatestX: + greatestX = rect[3] + rect[1] + if rect[4] + rect[2] > greatestY: + greatestY = rect[4] + rect[2] + # add used area of bin to total + binSum += ((greatestX - leastX) * (greatestY - leastY)) + # override packer least used area if needed + if binSum < leastBinSum: + leastBinSum = binSum + leastPacker = pack + + # use algo that resulted in the least wastage + packer = leastPacker + bins = list() + displaySections = list() + pdfSections = list() + # create visual representation of bins for display + for i in range(len(packer)): + bins.append(list()) + + rowColLen = ceil(sqrt(len(packer))) + row = floor(i / rowColLen) + col = i % rowColLen + + displayBin = rectangle(((0, 0), (w, h))) + displayBin.apply_translation( + ((packer[i].width * 11 / 10) * col, -((packer[i].height * 11 / 10) * row + packer[i].height))) + + displaySections.append(displayBin) + pdfSections.append(displayBin) + + # add rectangles to their designated bins + for rect in packer.rect_list(): + section = deepcopy(sections[rect[5]]) + bin = rect[0] + + # find position of bin for display purposes (bins displayed in grid, find row & col) + rowColLen = ceil(sqrt(len(packer))) + row = floor((bin) / rowColLen) + col = bin % rowColLen + + # check if rectangle has rotated, if so, rotate + dimensions = section.bounds + if rect[3] != float2dec((dimensions[1][0]) + k, 5) and rect[4] != float2dec((dimensions[1][1]) + k, 5): + section.apply_transform(((0, -1, 0), (1, 0, 0), (0, 0, 1))) + dimensions = section.bounds + section.apply_translation((-dimensions[0][0], -dimensions[0][1])) + + # find x, y translation to move rectangle to designated spot in bin + section.apply_translation((rect[1] + float2dec(k / 2, 5), rect[2] + float2dec(k / 2, 5))) + bins[bin].append(section) + + # find x, y translation to offset display rectangle to the proper bin in the bin grid + displaySection = copy(section) + displaySection.apply_translation( + ((packer[bin].width * 11 / 10) * col, -((packer[bin].height * 11 / 10) * row + packer[bin].height))) + displaySections.append(displaySection) + + # for display only, add rectangle bounding box, for visualization of packing performance + displayRect = rectangle(((displaySection.bounds[0][0], displaySection.bounds[0][1]), + (displaySection.bounds[1][0], displaySection.bounds[1][1]))) + displaySections.append(displayRect) + + # also add bounding box to key display, real shape outline not added for readability + pdfRect = copy(displayRect) + pdfRect.entities = np.append(pdfRect.entities, Text(0, str(rect[5] + 1), align=('left', 'bottom'))) + pdfSections.append(pdfRect) + + # show packed rectangles and bins in human understandable format + displayCombine = np.sum(displaySections) + displayCombine.show() + + # now that export has been prepared, show save buttons + exportFrame.pack(pady=(0, 5), padx=5) + + exportWidthEntry.bind('', checkPrepared) + exportHeightEntry.bind('', checkPrepared) + exportKerfEntry.bind('', checkPrepared) + + focus_results() + + blocked = False + + +# show puzzle key +def showKey(): + print("hi") + global blocked + + if not blocked: + blocked = True + + pdfCombine = np.sum(pdfSections) + pdfCombine.show() + + blocked = False + + +# save bins +def saveFiles(): + global blocked + + if not blocked: + blocked = True + + # ask for directory selection + directory = filedialog.askdirectory() + + # export bins + for i in range(len(bins)): + exportCombine = np.sum(bins[i]) + export_path(exportCombine, file_type="svg", file_obj=directory + "/bin" + str(i) + ".svg") + + focus_results() + + blocked = False + + +# forces window to appear in taskbar, windows specific +def set_appwindow(root): + hwnd = windll.user32.GetParent(root.winfo_id()) + style = windll.user32.GetWindowLongW(hwnd, GWL_EXSTYLE) + style = style & ~WS_EX_TOOLWINDOW + style = style | WS_EX_APPWINDOW + res = windll.user32.SetWindowLongW(hwnd, GWL_EXSTYLE, style) + # re-assert the new window style + root.wm_withdraw() + root.after(10, lambda: root.wm_deiconify()) + + +# for newer versions of pyinstaller, needed to retrieve icon image +def resource_path(relative_path): + """ Get absolute path to resource, works for dev and for PyInstaller """ + try: + # PyInstaller creates a temp folder and stores path in _MEIPASS + base_path = sys._MEIPASS + except Exception: + base_path = os.path.abspath(".") + + return os.path.join(base_path, relative_path) + + +results = None + +# create base window +root = tk.Tk() +root.title("Strato") +root.option_add('*Font', '19') +root.attributes("-toolwindow", 1) +p1 = tk.PhotoImage(file=resource_path('icon.png')) +# Icon set for program window +root.iconphoto(True, p1) +root.resizable(0, 0) + +# clear children of base window +clearList = root.winfo_children() + +for child in clearList: + child.destroy() + +# set default state of key checkbox +showKey = tk.BooleanVar() + +# generate window +menubar = tk.Menu(root) +filemenu = tk.Menu(menubar, tearoff=0) + +# TODO: filemenu.add_command(label="About", command=about) +filemenu.add_command(label="Exit", command=root.destroy) +menubar.add_cascade(label="File", menu=filemenu) + +modelFrame = tk.Frame(root) +topModelFrame = tk.Frame(modelFrame) +modelLabel = tk.Label(topModelFrame, text="Model: ") +modelEntry = tk.Label(topModelFrame, text="N/A") +modelBrowse = tk.Button(modelFrame, text="Browse", command=getFile) + +entriesFrame = tk.Frame(root) +layerEntryFrame = tk.Frame(entriesFrame) +layerThicknessLabel = tk.Label(layerEntryFrame, text="Layer Thickness (N/A): ") +layerThicknessEntry = tk.Entry(layerEntryFrame, width=5) + +scaleEntryFrame = tk.Frame(entriesFrame) +scaleFactorLabel = tk.Label(scaleEntryFrame, text="Model Scale Factor: ") +scaleFactorEntry = tk.Entry(scaleEntryFrame, width=5) +scaleFactorEntry.insert(0, "1") + +numbersFrame = tk.Frame(root) +dimensionsAfterLabel = tk.Label(numbersFrame, text="Scaled Dimensions (N/A)") +xAfterlabel = tk.Label(numbersFrame, text="x: N/A") +yAfterlabel = tk.Label(numbersFrame, text="y: N/A") +zAfterlabel = tk.Label(numbersFrame, text="z: N/A") + +numLayersLabel = tk.Label(root, text="Layers: N/A") + +goButton = tk.Button(root, text="Go", command=go) + +root.config(menu=menubar) + +modelFrame.pack(pady=10) +topModelFrame.pack() +modelLabel.pack(side=LEFT) +modelEntry.pack(side=LEFT) +modelBrowse.pack() + +entriesFrame.pack() +numbersFrame.pack(pady=10) +layerEntryFrame.pack() +scaleEntryFrame.pack(fill=X) +scaleFactorLabel.pack(side=LEFT) +scaleFactorEntry.pack(side=LEFT) +layerThicknessLabel.pack(side=LEFT) +layerThicknessEntry.pack(side=LEFT) + +dimensionsAfterLabel.pack() +xAfterlabel.pack() +yAfterlabel.pack() +zAfterlabel.pack() + +numLayersLabel.pack() + +goButton.pack(ipadx=10, pady=5) + +root.after(10, lambda: set_appwindow(root)) +root.mainloop()