commit 7e5cc958f287ed1c88e32122c4a2f1d48abe0d07 Author: Jacob Hrbek Date: Thu Nov 3 20:47:08 2022 +0100 Initial commit of the recovered source code diff --git a/CONTRIBUTORS b/CONTRIBUTORS new file mode 100644 index 0000000..254222d --- /dev/null +++ b/CONTRIBUTORS @@ -0,0 +1,5 @@ +Thanks to the following people for contributing to Inspekt3d: + +rekado +---- +Patch to improve the build system. diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -0,0 +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 +. diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..5906f44 --- /dev/null +++ b/INSTALL @@ -0,0 +1,43 @@ +(Only tested on Ubuntu 18.04 so far.) + +Required software/libraries: + +o Guile 2.2.1 or later + Site: https://www.gnu.org/software/guile/ + License: LGPL 3+ + +o Guile-OpenGL 0.1.0 + Site: https://www.gnu.org/software/guile-opengl/ + License: LGPL 3+ + + * Inspekt3d requires Freeglut 3. + +o Libfive + Site: www.libfive.com + License: LGPL 2.1+, GPL 2+ + + * For the best compatibility with Libfive, make sure to install it + from the latest commit in the Libfive master branch. + +Optional software/libraries: + +o Emacs (recent version) + Site: https://www.gnu.org/software/emacs/ + License: GPL 3+ + +o Geiser + Site: http://www.nongnu.org/geiser/ + License: BSD 3-clause + +Installation: + +Inspekt3d uses the standard Autotools build system, so: + + ./bootstrap + ./configure --prefix=/usr + sudo make install + +will install Inspekt3d to the '/usr' prefix. + +You can test the installation with: + guile -l ./examples/sphere.scm diff --git a/Makefile.am b/Makefile.am new file mode 100644 index 0000000..df18dfb --- /dev/null +++ b/Makefile.am @@ -0,0 +1,56 @@ +# Makefile.am +# +# Copyright 2018 Kavalogic, Inc. +# +# This file is part of Inspekt3d. +# +# Inspekt3d 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. +# +# Inspekt3d 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 +# Lesser 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 +# . + +# specify not GNU +AUTOMAKE_OPTIONS = foreign + +moddir=$(prefix)/share/guile/site/@GUILE_EFFECTIVE_VERSION@ +godir=$(libdir)/guile/@GUILE_EFFECTIVE_VERSION@/ccache + +GOBJECTS = $(SOURCES:%.scm=%.go) + +nobase_mod_DATA = $(SOURCES) $(NOCOMP_SOURCES) +nobase_go_DATA = $(GOBJECTS) + +# Make sure source files are installed first, so that the mtime of +# installed compiled files is greater than that of installed source +# files. See +# +# for details. +guile_install_go_files = install-nobase_goDATA +$(guile_install_go_files): install-nobase_modDATA + +GUILE_WARNINGS = -Wunbound-variable -Warity-mismatch -Wformat +SUFFIXES = .scm .go +.scm.go: + ./compile-env $(GUILD) compile $(GUILE_WARNINGS) -o "$@" "$<" + +SOURCES = \ + inspekt3d/camera.scm \ + inspekt3d/gl-missing.scm \ + inspekt3d/library.scm \ + inspekt3d/shader.scm \ + inspekt3d/viewer.scm \ +${NULL} + +CLEANFILES = $(GOBJECTS) + +EXTRA_DIST = $(SOURCES) $(NOCOMP_SOURCES) +EXTRA_DIST += COPYING INSTALL README.md examples compile-env.in diff --git a/README.md b/README.md new file mode 100644 index 0000000..61be27c --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# Inspekt3d + +Lightweight 3D viewer for +[Libfive](https://www.github.com/libfive/libfive) written in Guile +Scheme + +The Inspekt3d viewer can be used interactively with a REPL (for example Geiser in Emacs). + +## Usage + +Code to display a sphere: + + (use-modules (inspekt3d viewer) + (libfive shapes) (libfive kernel) (libfive vec) + (libfive transforms) (libfive csg)) + + (make-viewer) + ;;; shape bounds resolution + (set-shape (sphere 0.5) '((-1 . 1) (-1 . 1) (-1 . 1)) 10) + +The ```make-viewer``` function creates a (singleton, for now) display +window for the libfive shape in its own thread. The ```set-shape +shape bounds resolution``` function can be used multiple times from +the REPL to change the shape to be viewed. + +This is a more complicated model: + +![Turtle Model](./turtle.png) + +[Turtle Model Source](./examples/turtle.scm) diff --git a/bootstrap b/bootstrap new file mode 100755 index 0000000..9daaca6 --- /dev/null +++ b/bootstrap @@ -0,0 +1,38 @@ +#!/bin/sh -x + +# bootstrap - create files in the "auto" tool-chain +# +# Copyright 2018 Kavalogic, Inc. +# +# This file is part of Inspekt3d. +# +# Inspekt3d 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. +# +# Inspekt3d 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 +# Lesser 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 +# . + +# create makefile.in for top level and subdirectories +aclocal +# (-Woverride flag is to catch user redefinitions of automake rules/variables) +automake --add-missing -Woverride -Werror +# creates configure script +autoconf + +# Notes: +# ----- +# Other "auto" tools: +# +# autoreconf - remake build system files +# autoscan - used to create a starter configure.ac or validates existing one +# ----- +# autoconf --trace - scans configure.ac +# ----- diff --git a/compile-env.in b/compile-env.in new file mode 100644 index 0000000..b9bf0df --- /dev/null +++ b/compile-env.in @@ -0,0 +1,37 @@ +#!/bin/sh + +# Makefile.am +# +# Copyright 2018 Kavalogic, Inc. +# +# This file is part of Inspekt3d. +# +# Inspekt3d 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. +# +# Inspekt3d 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 +# Lesser 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 +# . +# +# From the Guile-OpenGL 0.1.0 source file: +# ./env.in + +GUILE_LOAD_PATH=@abs_top_srcdir@:$GUILE_LOAD_PATH +if test "@abs_top_srcdir@" != "@abs_top_builddir@"; then + GUILE_LOAD_PATH=@abs_top_builddir@:$GUILE_LOAD_PATH +fi +GUILE_LOAD_COMPILED_PATH=@abs_top_builddir@:$GUILE_LOAD_PATH +PATH=@abs_top_builddir@/bin:$PATH + +export GUILE_LOAD_PATH +export GUILE_LOAD_COMPILED_PATH +export PATH + +exec "$@" diff --git a/configure.ac b/configure.ac new file mode 100644 index 0000000..48bbf67 --- /dev/null +++ b/configure.ac @@ -0,0 +1,56 @@ +dnl -*- Autoconf -*- + +dnl configure.ac +dnl +dnl Copyright 2018 Kavalogic, Inc. +dnl +dnl This file is part of Inspekt3d. +dnl +dnl Inspekt3d is free software: you can redistribute it and/or modify +dnl it under the terms of the GNU General Public License as +dnl published by the Free Software Foundation, either version 3 of the +dnl License, or (at your option) any later version. +dnl +dnl Inspekt3d is distributed in the hope that it will be useful, but +dnl WITHOUT ANY WARRANTY; without even the implied warranty of +dnl MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +dnl Lesser General Public License for more details. +dnl +dnl You should have received a copy of the GNU General Public +dnl License along with this program. If not, see +dnl . + +dnl *** Process this file with autoconf to produce a configure script. *** + +AC_INIT([Inspekt3d], [0.0.0],, [Inspekt3d], [https://www.github.com/sjm-tl-gh/inspekt3d]) +dnl AC_CONFIG_SRCDIR is a file found in the source tree as a check +AC_CONFIG_SRCDIR([inspekt3d]) +AM_INIT_AUTOMAKE + +AC_COPYRIGHT([Copyright 2018 Kavalogic, Inc. See the file COPYING for licensing and distribution terms.]) +AH_TOP([/* Copyright 2018 Kavalogic, Inc. See the file COPYING for licensing and distribution terms. */]) + +GUILE_PKG([3.0 2.2]) +GUILE_PROGS +if test "x$GUILD" = "x"; then + dnl Do an alternate check for 'guild' + AC_CHECK_PROG([GUILD], guild, guild) + if test "x$GUILD" = "x"; then + AC_MSG_ERROR(['guild' binary not found; please check your guile-3.0 2.2 installation.]) + fi +fi + +PKG_CHECK_MODULES([LIBFIVE], [libfive], + [PKG_CHECK_VAR([LIBFIVE_GUILE_LIBDIR], [libfive], [libdir], + [], + [AC_MSG_ERROR([Could not determine libdir for libfive.])])], + [AC_MSG_ERROR([Guile bindings for libfive are missing; please install them.])]) + +GUILE_MODULE_AVAILABLE([have_guile_opengl], [(gl)]) +if test "x$have_guile_opengl" != "xyes"; then + AC_MSG_ERROR([Guile OpenGL is missing; please install it.]) +fi + +AC_CONFIG_FILES([Makefile]) +AC_CONFIG_FILES([compile-env], [chmod +x compile-env]) +AC_OUTPUT diff --git a/examples/rocking-horse.scm b/examples/rocking-horse.scm new file mode 100644 index 0000000..4fe9e33 --- /dev/null +++ b/examples/rocking-horse.scm @@ -0,0 +1,317 @@ +#| rocking-horse.scm + +Copyright 2018 Kavalogic, Inc. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + (1) Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + (2) Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + + (3) The name of the author may not be used to + endorse or promote products derived from this software without + specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, +INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING +IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. + +|# + +(use-modules (inspekt3d viewer) + (libfive shapes) (libfive kernel) (libfive vec) + (libfive transforms) (libfive csg)) + +(define (make-horse-shape) + (let* (;; + ;; Body + ;; + (body-length 1) + (body-width (* 1/2 body-length)) + (body-thickness (* 1/12 body-length)) + (body-cutout-circle-radius (/ body-length 2)) + (body-cutout-circle (circle body-cutout-circle-radius + #[(/ body-length 2) 0])) + (body-cutout-circle-offset (+ body-cutout-circle-radius + (/ body-width 4))) + (body-rounding-factor 1/8) + (body (rotate-x + (extrude-z + (difference + (rounded-rectangle #[0 (- (/ body-width 2))] + #[body-length (/ body-width 2)] + body-rounding-factor) + (move body-cutout-circle + #[0 body-cutout-circle-offset 0]) + (move body-cutout-circle + #[0 (- body-cutout-circle-offset)])) + (- (/ body-thickness 2)) + (/ body-thickness 2)) + (/ pi 2))) + ;; + ;; Legs + ;; + (leg-length (* 2/3 body-length)) + (leg-radius (* 3/100 body-length)) + (leg-angle (/ pi 8)) + (leg (cylinder-z leg-radius leg-length)) + (leg-offset-x (+ leg-radius 1/10)) + (leg-offset-y (- (/ body-width 2) leg-radius 1/10)) + ;; + (legs (rotate-x + (union + (move (rotate-x leg leg-angle) + #[leg-offset-x (- leg-offset-y) 0]) + (move (rotate-x leg (- leg-angle)) + #[leg-offset-x leg-offset-y 0]) + (move (rotate-x leg leg-angle) + #[(- body-length leg-offset-x) (- leg-offset-y) 0]) + (move (rotate-x leg (- leg-angle)) + #[(- body-length leg-offset-x) leg-offset-y 0])) + (/ pi 2))) + ;; + ;; Rockers + ;; + (rocker-radius (* 5/2 body-length)) + (rocker-length (* body-length 8/5)) + (rocker-width (* 3 leg-radius)) + (rocker-thickness (* 3 leg-radius)) + (rocker-half-angle + (asin (/ (/ rocker-length 2) rocker-radius))) + (outer-rocker-circle (circle rocker-radius)) + (inner-rocker-circle (circle (- rocker-radius rocker-width))) + (rocker-intersection-triangle + (let* ((iso-side-length (* 2 rocker-radius)) + (offset-x (* iso-side-length (sin rocker-half-angle))) + (offset-y (- (* iso-side-length (cos rocker-half-angle))))) + (triangle #[0 0] #[(- offset-x) offset-y] #[offset-x offset-y]))) + (rocker-end-radius (* (/ rocker-width 2) 5/4)) + (rocker-end-offset-y (+ (- rocker-radius) + (- rocker-width rocker-end-radius))) + (rocker-end (circle rocker-end-radius #[0 rocker-end-offset-y])) + (right-rocker-end (rotate-z rocker-end rocker-half-angle)) + (left-rocker-end (rotate-z rocker-end (- rocker-half-angle))) + (rocker-profile (union (intersection + (difference outer-rocker-circle + inner-rocker-circle) + rocker-intersection-triangle) + left-rocker-end + right-rocker-end)) + (rocker-offset-x (/ body-length 2)) + (rocker-offset-y (+ (* leg-length + (cos leg-angle)) ; adjust for leg angle + (/ (- rocker-radius ; adjust for rocker "curl" + (* rocker-radius + (cos rocker-half-angle))) 2) + (/ rocker-width 2))) ;adjust for rocker width + (rocker-offset-z (+ (* leg-length (sin leg-angle)) + leg-offset-y)) ; legs rotated, use y offset + ;; + (rocker (move (extrude-z rocker-profile + (- (/ rocker-thickness 2)) + (/ rocker-thickness 2)) + #[rocker-offset-x + (- rocker-radius rocker-offset-y) + 0])) + (left-rocker (move rocker #[0 0 (- rocker-offset-z)])) + (right-rocker (move rocker #[0 0 rocker-offset-z])) + + (rocker-rod-radius (/ leg-radius 3/2)) + (rocker-rod-offset-z (+ rocker-offset-z (/ rocker-thickness 4))) + (rocker-rod (cylinder-z rocker-rod-radius + (* 2 rocker-rod-offset-z) + #[0 + rocker-end-offset-y + (- rocker-rod-offset-z)])) + (front-rocker-rod (move (rotate-z rocker-rod rocker-half-angle) + #[rocker-offset-x + (- rocker-radius rocker-offset-y) + 0])) + (back-rocker-rod (move (rotate-z rocker-rod (- rocker-half-angle)) + #[rocker-offset-x + (- rocker-radius rocker-offset-y) + 0])) + ;; + (rocker-support-length (* 3 leg-radius)) + (rocker-support-width (* (/ rocker-width 2) 11/10)) + (rocker-support (box #[(- (/ rocker-support-length 2)) + (- (/ rocker-support-width 2)) + (- (+ rocker-offset-z (/ rocker-thickness 2)))] + #[(/ rocker-support-length 2) + (/ rocker-support-width 2) + (+ rocker-offset-z (/ rocker-thickness 2))])) + ;; + (rocker-support-offset-y (+ (- rocker-offset-y) + rocker-thickness + 1/50)) + ;; + (front-rocker-support (move rocker-support + #[(- body-length leg-offset-x) + rocker-support-offset-y + 0])) + (back-rocker-support (move rocker-support + #[leg-offset-x + rocker-support-offset-y + 0])) + ;; + (rocker-assembly (union right-rocker + left-rocker + front-rocker-support + back-rocker-support + front-rocker-rod + back-rocker-rod)) + ;; + ;; Neck + ;; + (neck-length (* 7/24 body-length)) + (neck-width (* 1/2 body-length)) + (neck-angle (/ pi 10)) + (neck-thickness (* 2/3 body-thickness)) + ;; shear-x-y shape #[x0 y0] height offset [base-offset] + (neck-profile (shear-x-y + ;; taper-x-y shape #[x0 y0] height scale [base-scale] + (taper-x-y + (rectangle #[(- (/ neck-length 2)) + (- (/ neck-width 2))] + #[(/ neck-length 2) + (/ neck-width 2)]) + #[0 (- (/ neck-width 2))] neck-width 1/2 1) + #[0 (- (/ neck-width 2))] neck-width + (* neck-length (/ neck-angle (/ pi 4))) 0)) + (neck (move + (extrude-z neck-profile + (- (/ neck-thickness 2)) + (/ neck-thickness 2)) + #[(- body-length (/ neck-length 2)) + (+ (/ neck-width 2) (/ body-thickness 4)) + 0])) + ;; + ;; Head + ;; + (head-circle-radius (* 1/8 body-length)) + (nose-circle-radius (/ head-circle-radius 2)) + (muzzle-length (* 6/5 neck-length)) + (head-thickness (* 1 body-thickness)) + (head-angle (- (/ pi 8))) + (bridle-hole-radius (/ leg-radius 2)) + ;; + (head-circle (circle head-circle-radius)) + (nose-circle (circle nose-circle-radius #[0 muzzle-length])) + (bridle-hole-circle (circle bridle-hole-radius #[0 muzzle-length])) + ;; taper-x-y shape #[x0 y0] height scale [base-scale] + (muzzle (taper-x-y + (rectangle #[(- head-circle-radius) 0] + #[head-circle-radius muzzle-length]) + #[0 0] muzzle-length + (/ nose-circle-radius head-circle-radius) 1)) + ;; + (head-profile (difference (union head-circle + muzzle + nose-circle) + bridle-hole-circle)) + ;; + (head-offset-x (- body-length 1/100)) + (head-main (move + (rotate-z + (extrude-z head-profile + (- (/ head-thickness 2)) + (/ head-thickness 2)) + (+ (- (/ pi 2)) head-angle)) + #[head-offset-x neck-width 0])) + ;; + (head-bar-height (* 7/8 body-width)) + (head-bar-radius (/ leg-radius 3/2)) + ;; + (head-bar (cylinder-z head-bar-radius + head-bar-height + #[head-offset-x + neck-width + (- (/ head-bar-height 2))])) + ;; + (ear-length (* 1/4 head-circle-radius)) + (ear-thickness (* 3/8 head-thickness)) + (ear-cylinder-radius (* 7/8 head-circle-radius)) + (ear-cylinder (cylinder-z ear-cylinder-radius + ear-thickness + #[0 0 (- (/ ear-thickness 2))])) + (ear (intersection + (move ear-cylinder + #[(- ear-length ear-cylinder-radius) 0 0]) + (move ear-cylinder + #[(- ear-cylinder-radius ear-length) 0 0]))) + (ear-offset-x (+ head-offset-x (- (/ head-circle-radius 8)))) + (ear-offset-y (+ neck-width head-circle-radius)) + (ear-offset-z (/ head-thickness 2)) + (right-ear (move ear #[ear-offset-x ear-offset-y ear-offset-z])) + (left-ear (move ear #[ear-offset-x ear-offset-y (- ear-offset-z)])) + ;; + (head-assembly (union head-main + left-ear + right-ear + head-bar)) + ;; + ;; Tail + ;; + (tail-radius (* body-length 5/16)) + (tail-width (* tail-radius 5/12)) + (tail-thickness neck-thickness) + ;; + (tail-cylinder (cylinder-z tail-radius + tail-thickness + #[0 0 (- (/ tail-thickness 2))])) + ;; + (tail-box-square-dimension (* tail-radius 11/10)) + (tail-box-thickness (* tail-thickness 11/10)) + ;; + (tail-box (box #[(- tail-box-square-dimension) + (- tail-box-square-dimension) + (- (/ tail-box-thickness 2))] + #[(- tail-radius tail-width) + tail-box-square-dimension + (/ tail-box-thickness 2)])) + ;; + (tail-base-x (- tail-radius tail-width)) + (tail-base-y (* tail-radius (sin + (acos (/ tail-base-x tail-radius))))) + (tail-upright (move (difference tail-cylinder tail-box) + #[(- tail-base-x) + (- tail-base-y) + 0])) + ;; + (tail-angle (/ pi 4)) + (tail (move + (rotate-z tail-upright (- tail-angle)) + #[2/100 (/ body-thickness 2) 0])) + ;;-;; ;;-;; + ;; ;; + ;; Complete horse ;; + ;; ;; + ;;-;; ;;-;; + (rocking-horse + (let* ((model + (union body + legs + rocker-assembly + neck + head-assembly + tail)) + (delta #[(- (/ body-length 2)) (/ rocker-offset-y 2) 0])) + (move model delta)))) + rocking-horse)) + +(make-viewer) +(set-shape (make-horse-shape) '((-2 . 2) (-2 . 2) (-2 . 2)) 100) diff --git a/examples/sphere.scm b/examples/sphere.scm new file mode 100644 index 0000000..f2f731a --- /dev/null +++ b/examples/sphere.scm @@ -0,0 +1,40 @@ +#| sphere.scm + +Copyright 2018 Kavalogic, Inc. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + (1) Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + (2) Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + + (3) The name of the author may not be used to + endorse or promote products derived from this software without + specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, +INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING +IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. + +|# + +(use-modules (inspekt3d viewer) + (libfive shapes) (libfive kernel) (libfive vec) + (libfive transforms) (libfive csg)) + +(make-viewer) +(set-shape (sphere 0.5) '((-1 . 1) (-1 . 1) (-1 . 1)) 10) diff --git a/examples/turtle.scm b/examples/turtle.scm new file mode 100644 index 0000000..ae42008 --- /dev/null +++ b/examples/turtle.scm @@ -0,0 +1,267 @@ +#| turtle.scm + +Copyright 2018 Kavalogic, Inc. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + (1) Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + (2) Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + + (3) The name of the author may not be used to + endorse or promote products derived from this software without + specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, +INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING +IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. + +|# + +(use-modules (inspekt3d viewer) + (libfive shapes) (libfive kernel) (libfive vec) + (libfive transforms) (libfive csg)) + +(define +P+ 1.6180339889) + +(define (half-space-pts point1 point2 point3) + "half-space-pts point1 point2 point3 + (specify points in CW order for RH outward facing normal)" + (let* ((V1 (- point1 point2)) + (V2 (- point3 point2)) + (X (cross V1 V2)) + (l (norm X)) + (N (/ X l)) + (pos (/ (+ point1 point2 point3) 3))) + (half-space N pos))) + +(define* (icosohedron #:optional (P +P+)) + (let* ((-P (- P)) + (2P (* 2 P)) + (-2P (- 2P)) + (-1-2P (- -1 2P)) + (1+2P (+ 1 2P)) + (2+P (+ 2 P)) + (-2-P (- -2 P)) + (3P (* 3 P)) + (-3P (- 3P)) + (vertices + (list->vector + ;; TODO: use permutations to generate these + (list + #[ -P 2 -1-2P ] + #[ -1 -3P 0 ] + #[ 2+P -2P 1 ] + #[ 0 1 3P ] + #[ -1 -2-P 2P ] + #[ -3P 0 1 ] + #[ 1 -2-P 2P ] + #[ -2P 1 -2-P ] + #[ 1 2+P -2P ] + #[ 2 1+2P -P ] + #[ -2-P -2P 1 ] + #[ -2-P 2P -1 ] + #[ -1 -2-P -2P ] + #[ -P -2 -1-2P ] + #[ -1-2P -P 2 ] + #[ 1+2P P 2 ] + #[ -1 3P 0 ] + #[ 1+2P P -2 ] + #[ -2 1+2P P ] + #[ -1-2P -P -2 ] + #[ 3P 0 1 ] + #[ P -2 1+2P ] + #[ 1+2P -P -2 ] + #[ 0 -1 -3P ] + #[ 0 -1 3P ] + #[ 1 2+P 2P ] + #[ -1-2P P -2 ] + #[ -2 1+2P -P ] + #[ 1 -3P 0 ] + #[ 1+2P -P 2 ] + #[ -2P -1 -2-P ] + #[ 2P 1 2+P ] + #[ P 2 1+2P ] + #[ 2+P 2P -1 ] + #[ -2-P -2P -1 ] + #[ P -2 -1-2P ] + #[ 2 -1-2P P ] + #[ 3P 0 -1 ] + #[ -2P 1 2+P ] + #[ -1-2P P 2 ] + #[ -P -2 1+2P ] + #[ 2+P -2P -1 ] + #[ -1 2+P 2P ] + #[ -P 2 1+2P ] + #[ 1 3P 0 ] + #[ -2P -1 2+P ] + #[ P 2 -1-2P ] + #[ 1 -2-P -2P ] + #[ 2P 1 -2-P ] + #[ 2P -1 2+P ] + #[ -1 2+P -2P ] + #[ 2 1+2P P ] + #[ 2+P 2P 1 ] + #[ -2 -1-2P -P ] + #[ 0 1 -3P ] + #[ -3P 0 -1 ] + #[ 2P -1 -2-P ] + #[ 2 -1-2P -P ] + #[ -2 -1-2P P ] + #[ -2-P 2P 1 ]))) + (pentagons + '(#(12 47 35 23 13) ; flipped + #(18 59 11 27 16) + #(19 30 7 26 55) + #(6 4 40 24 21) ; flipped + #(42 25 32 3 43) ; flipped + #(44 9 33 52 51) + #(8 50 0 54 46) ; flipped + #(56 22 37 17 48) ; flipped + #(49 31 15 20 29) + #(5 39 38 45 14) + #(34 10 58 1 53) ; flipped + #(57 28 36 2 41))) + (hexagons + '(#(10 14 45 40 4 58) + #(11 26 7 0 50 27) + #(42 43 38 39 59 18) ; flipped + #(2 36 6 21 49 29) + #(20 37 22 41 2 29) + #(25 51 52 15 31 32) + #(26 11 59 39 5 55) + #(57 47 12 53 1 28) ; flipped + #(28 1 58 4 6 36) + #(49 21 24 3 32 31) ; flipped + #(53 12 13 30 19 34) ; flipped + #(20 15 52 33 17 37) ; flipped + #(41 22 56 35 47 57) + #(16 27 50 8 9 44) ; flipped + #(45 38 43 3 24 40) + #(48 46 54 23 35 56) + #(14 10 34 19 55 5) ; flipped + #(51 25 42 18 16 44) + #(30 13 23 54 0 7) ; flipped + #(9 8 46 48 17 33)))) + + ;; intersect all half-spaces from a triangle of each of the pentagons + ;; and hexagons + (apply intersection + (append + (map + (lambda (pentagon) + (half-space-pts (vector-ref vertices (vector-ref pentagon 0)) + (vector-ref vertices (vector-ref pentagon 1)) + (vector-ref vertices (vector-ref pentagon 2)))) + pentagons) + (map + (lambda (hexagon) + (half-space-pts (vector-ref vertices (vector-ref hexagon 0)) + (vector-ref vertices (vector-ref hexagon 1)) + (vector-ref vertices (vector-ref hexagon 2)))) + hexagons))))) + +(define (my-rounded-cube len r) + ;; cube in #[-len/2 -len/2 0] to #[len/2 len/2 len] + ;; with all edges and corners rounded at radius r + (let* ((offset (/ len 2)) + (base (extrude-z + (rounded-rectangle #[(- offset) (- offset)] #[offset offset] r) + 0 + len)) + (faceted (intersection + base + (move (rotate-x base (/ pi 2)) #[0 offset offset]) + (move (rotate-y base (/ pi 2)) #[offset 0 offset]))) + (sph (difference + (sphere r) + (box #[(- r) 0 (- r)] #[r r r]) + (box #[(- r) (- r) 0] #[r r r]) + (box #[0 (- r) (- r)] #[r r r]))) + (corner (difference (box #[(- r) (- r) (- r)] #[ 0 0 0]) sph)) + (half-corners + (union + (move corner #[(- r offset) (- r offset) r]) + (move (rotate-y corner (/ pi 2)) #[(- offset r) (- r offset) r]) + (move (rotate-x corner (/ pi 2)) #[(- r offset) (- offset r) r]) + (move + (rotate-y (rotate-x corner (/ pi 2)) (/ pi 2)) + #[(- offset r) (- offset r) r]))) + (corners + (union + half-corners + (move (rotate-x half-corners pi) #[0 0 len])))) + (difference faceted corners))) + +(define (make-turtle-shape) + (let* ((bball-radius (sqrt (+ (* 9 (* +P+ +P+)) 1))) + (base-sphere (sphere (* bball-radius 0.925))) + ;; bottom + (bottom (scale-xyz base-sphere #[1 0.225 1])) + ;; head + (head-cutout-sphere (scale-xyz (move (sphere 2) + #[(+ bball-radius 0) 1.5 0]) + #[1 .5 1])) + ;; shell + (shell-sphere (sphere bball-radius)) + (bball (icosohedron)) + (shell (morph bball shell-sphere .3)) + (half-shell (difference shell (half-space #[0 1 0]))) + (base-shell-unscaled (union half-shell + bottom)) + (base-shell (scale-xyz base-shell-unscaled #[1.25 1 1])) + (shell-cutout (scale-xyz (sphere bball-radius) #[1 0.15 1.1])) + ;; body + (body (intersection + (move (scale-xyz base-sphere #[1.1 0.5 1]) + #[0 0.5 0]) + base-shell)) + ;; shell assembly + (turtle-shell + (difference base-shell + ;; head area + (move shell-cutout #[(+ bball-radius 0.75) 0.4 0]) + head-cutout-sphere + ;; tail area + (move shell-cutout #[(- (+ bball-radius 0.75)) 0.4 0]))) + ;; head/neck + (neck (cylinder-z 0.8 3.0 #[0 0.1 0])) + (eye (sphere 0.35)) + ;;(mouth (ang-wedge (/ pi 50) 2 2)) + (head (union + (move (scale-xyz + (my-rounded-cube 2.2 0.8) #[1 1 1.1]) #[0 0.4 -1.3]) + (move eye #[0.77 0.6 -0.7]) + (move eye #[-0.77 0.6 -0.7]))) + (head/neck (scale-xyz (move + (rotate-z (rotate-y (union neck head) (/ pi 2)) + (/ pi 12)) + #[6.75 1.05 0]) + #[1 1 0.95])) + (leg (rotate-z (scale-xyz (sphere 1.0) #[2.2 0.4 0.7]) (/ pi 9))) + (legs (union + (move (rotate-y leg (/ pi 5)) #[-3.5 0.5 -3.3]) + (move (rotate-y leg (- (/ pi 5))) #[-3.5 0.5 3.3]) + (move (rotate-y leg (* pi (/ 4 5))) #[3.5 0.5 -3.3]) + (move (rotate-y leg (- (* pi (/ 4 5)))) #[3.5 0.5 3.3]))) + (tail (move (scale-xyz (sphere 1.0) #[2.0 0.3 0.35]) #[-5 0.5 0])) + ;; turtle assembly + (turtle (union turtle-shell body head/neck legs tail))) + turtle)) + +(make-viewer) +(set-shape (make-turtle-shape) '((-20 . 20) (-20 . 20) (-20 . 20)) 10) diff --git a/git_clean_all b/git_clean_all new file mode 100755 index 0000000..9f48d24 --- /dev/null +++ b/git_clean_all @@ -0,0 +1,22 @@ +# git_clean_all +# +# Copyright 2018 Kavalogic, Inc. +# +# This file is part of Inspekt3d. +# +# Inspekt3d is free software; you can redistribute it and/or modify it +# under the terms of the GNU Lesser General Public License +# version 2.1 as published by the Free Software Foundation. +# +# Inspekt3d 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 +# Lesser General Public License for more details. You should have +# received a copy of the GNU Lesser General Public License along with +# Inspekt3d. If not, see . +# +# git_clean_all - clean the source + +git clean . -f +rm -rf autom4te.cache/ `find . -name .libs` `find . -name .deps` + diff --git a/inspekt3d/camera.scm b/inspekt3d/camera.scm new file mode 100644 index 0000000..5431130 --- /dev/null +++ b/inspekt3d/camera.scm @@ -0,0 +1,193 @@ +;;; camera.scm +;;; +;;; Copyright 2018 Kavalogic, Inc. +;;; +;;; This file is part of Inspekt3d. +;;; +;;; Inspekt3d 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. +;;; +;;; Inspekt3d 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 +;;; Lesser 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 +;;; . + +(define-module (inspekt3d camera) + #:use-module (inspekt3d gl-missing) + #:use-module (oop goops) + #:use-module (gl)) + +;;; class +(define-class () + (rotating? #:getter is-rotating? #:init-value #f) + (screen-rot-x #:getter get-screen-rot-x #:init-value 0) + (screen-rot-y #:getter get-screen-rot-y #:init-value 0) + (screen-base-x) + (screen-base-y) + (last-screen-offset-x #:init-value 0) + (last-screen-offset-y #:init-value 0)) +(export ) +(export is-rotating? get-screen-rot-x get-screen-rot-y) + +(define-method (rotation-start (self ) + (x ) + (y )) + (slot-set! self 'screen-base-x x) + (slot-set! self 'screen-base-y y) + (slot-set! self 'rotating? #t)) +(export rotation-start) + +(define *rotation-scale* 360/500) + +(define-method (rotation-rotate (self ) + (x ) + (y )) + (let ((x' (+ (- x (slot-ref self 'screen-base-x)) + (slot-ref self 'last-screen-offset-x))) + (y' (+ (- y (slot-ref self 'screen-base-y)) + (slot-ref self 'last-screen-offset-y)))) + (slot-set! self 'screen-rot-y (* *rotation-scale* x')) + (slot-set! self 'screen-rot-x (* *rotation-scale* y')))) +(export rotation-rotate) + +(define-method (rotation-end (self ) + (x ) + (y )) + (slot-set! self 'rotating? #f) + (slot-set! self 'last-screen-offset-x + (+ (slot-ref self 'last-screen-offset-x) + (- x (slot-ref self 'screen-base-x)))) + (slot-set! self 'last-screen-offset-y + (+ (slot-ref self 'last-screen-offset-y) + (- y (slot-ref self 'screen-base-y))))) +(export rotation-end) + +;; class +(define-class () + ;; current zoom + (zoom-value #:getter get-zoom #:init-value 1 #:init-keyword #:zoom-value) + ;; how fast we zoom + (factor #:init-keyword #:factor)) +(export ) +(export get-zoom) +(define-method (zoom-in (self )) + (let* ((factor (slot-ref self 'factor)) + (zoom-value (+ (slot-ref self 'zoom-value) factor))) + (slot-set! self 'zoom-value zoom-value))) +(export zoom-in) +(define-method (zoom-out (self )) + (let* ((factor (slot-ref self 'factor)) + (zoom-value (- (slot-ref self 'zoom-value) factor))) + (slot-set! self 'zoom-value zoom-value))) +(export zoom-out) + +;;; class +(define-class () + (width #:getter get-width #:setter set-width #:init-value 0) + (height #:getter get-height #:setter set-height #:init-value 0) + (eye #:getter get-eye #:setter set-eye #:init-value #(0 0 1)) + (center #:getter get-center #:setter set-center #:init-value #(0 0 0)) + (up #:getter get-up #:setter set-up #:init-value #(0 1 0)) + (rotator #:getter get-rotator #:init-form (make )) + (zoomer #:getter get-zoomer + #:init-form (make #:factor 0.05 #:zoom-value 1))) +(export ) +(export get-width set-width get-height set-height get-eye set-eye) +(export get-center set-center get-up set-up) +(export get-rotator get-zoomer) + +(define (vec3-length v) + (define (square e) (* e e)) + (sqrt (+ (square (vector-ref v 0)) + (square (vector-ref v 1)) + (square (vector-ref v 2))))) +(define (vec3-sub v1 v2) + (vector (- (vector-ref v1 0) + (vector-ref v2 0)) + (- (vector-ref v1 1) + (vector-ref v2 1)) + (- (vector-ref v1 2) + (vector-ref v2 2)))) + +(define-method (establish-modelview-matrix (self )) + (let ((eye (slot-ref self 'eye)) + (center (slot-ref self 'center)) + (up (slot-ref self 'up))) + (set-gl-matrix-mode (matrix-mode modelview)) + (gl-load-identity) + (let ((distance (vec3-length (vec3-sub eye center))) + (rotator (slot-ref self 'rotator))) + (gl-translate 0 0 (- distance)) + (gl-rotate (slot-ref rotator 'screen-rot-x) 1 0 0) + (gl-rotate (slot-ref rotator 'screen-rot-y) 0 1 0) + (gl-translate 0 0 distance) + (glu-look-at (vector-ref eye 0) + (vector-ref eye 1) + (vector-ref eye 2) + (vector-ref center 0) + (vector-ref center 1) + (vector-ref center 2) + (vector-ref up 0) + (vector-ref up 1) + (vector-ref up 2))))) +(export establish-modelview-matrix) + +(define (bounds-length l) + (let* ((x (car l)) + (x-min (car x)) + (x-max (cdr x)) + (y (cadr l)) + (y-min (car y)) + (y-max (cdr y)) + (z (caddr l)) + (z-min (car z)) + (z-max (cdr z))) + (vec3-length (vector (- x-max x-min) + (- y-max y-min) + (- z-max z-min))))) + +(define-method (establish-projection-matrix (self ) + (bounds )) + (let* ((r (bounds-length bounds)) + (dist-2-eye (vec3-length (vec3-sub (slot-ref self 'eye) + (slot-ref self 'center)))) + (viewport-aspect (/ (slot-ref self 'height) + (slot-ref self 'width))) + (zoom (slot-ref (slot-ref self 'zoomer) 'zoom-value)) + (min (vector (- r) (- r) (- r))) + (min-x (vector-ref min 0)) + (min-y (vector-ref min 1)) + (max (vector r r r)) + (max-x (vector-ref max 0)) + (max-y (vector-ref max 1)) + (window-aspect (/ (- max-y min-y) (- max-x min-x)))) + ;; calculate viewport parameters + (if (> viewport-aspect window-aspect) + ;; viewport taller than it needs to be + (let ((new-height (* viewport-aspect (- max-x min-x))) + (y-mid (/ (+ min-y max-y) 2))) + (vector-set! max 1 (+ y-mid (* 1/2 new-height))) + (vector-set! min 1 (- y-mid (* 1/2 new-height)))) + ;; viewport wider than it needs to be + (let ((new-width (/ (- max-y min-y) viewport-aspect)) + (x-mid (/ (+ min-x max-x) 2))) + (vector-set! max 0 (+ x-mid (* 1/2 new-width))) + (vector-set! min 0 (- x-mid (* 1/2 new-width))))) + ;; do the projection + (let ((new-min (vector (/ (vector-ref min 0) zoom) + (/ (vector-ref min 1) zoom) + (vector-ref min 2))) + (new-max (vector (/ (vector-ref max 0) zoom) + (/ (vector-ref max 1) zoom) + (vector-ref max 2)))) + ;; use an orthographic projection using adjusted model boundaries + (gl-ortho (vector-ref new-min 0) (vector-ref new-max 0) + (vector-ref new-min 1) (vector-ref new-max 1) + (vector-ref new-min 2) (vector-ref new-max 2))))) +(export establish-projection-matrix) diff --git a/inspekt3d/gl-missing.scm b/inspekt3d/gl-missing.scm new file mode 100644 index 0000000..ce1d992 --- /dev/null +++ b/inspekt3d/gl-missing.scm @@ -0,0 +1,105 @@ +;;; gl-missing.scm +;;; +;;; Copyright 2018 Kavalogic, Inc. +;;; +;;; This file is part of Inspekt3d. +;;; +;;; Inspekt3d 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. +;;; +;;; Inspekt3d 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 +;;; Lesser 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 +;;; . + +(define-module (inspekt3d gl-missing) + #:use-module ((system foreign) #:renamer (symbol-prefix-proc 'ffi:)) + #:use-module (gl types) + #:use-module (gl enums) + #:use-module (gl runtime) + #:use-module ((gl low-level) #:renamer (symbol-prefix-proc '%)) + #:use-module ((glu low-level) #:renamer (symbol-prefix-proc '%)) + #:use-module (glut) + #:use-module (glut types) + #:use-module (glut runtime) + #:use-module ((glut low-level) #:renamer (symbol-prefix-proc '%))) + + +;;; missing GL functions +(re-export (%glDrawElements . gl-draw-elements)) +;;; lighting +(re-export (%glLightfv . gl-light)) +(re-export (%glLightModelfv . gl-light-model)) +(re-export (%glMaterialfv . gl-material)) +;;; shader +(re-export (%glCreateShader . gl-create-shader)) +(re-export (%glShaderSource . gl-shader-source)) +(re-export (%glCompileShader . gl-compile-shader)) +(define (gl-get-shader shader pname) + (let ((params (u32vector 0))) + (%glGetShaderiv shader pname params) + (u32vector-ref params 0))) +(export gl-get-shader) +;;; shader program +(re-export (%glCreateProgram . gl-create-program)) +(re-export (%glAttachShader . gl-attach-shader)) +(re-export (%glLinkProgram . gl-link-program)) +(define (gl-get-program program pname) + (let ((params (u32vector 0))) + (%glGetProgramiv program pname params) + (u32vector-ref params 0))) +(export gl-get-program) +(re-export (%glUseProgram . gl-use-program)) +(re-export (%glGetUniformLocation . gl-get-uniform-location)) +(define (gl-uniform-float loc x . rest) + (case (length rest) + ((0) (%glUniform1f loc x)) + ((1) (apply %glUniform2f loc x rest)) + ((2) (apply %glUniform3f loc x rest)) + ((3) (apply %glUniform4f loc x rest)))) +(export gl-uniform-float) +(define (gl-get-shader-info-log shader) + (let* ((log-length-c (u32vector 0)) + (log-length (gl-get-shader shader (version-2-0 info-log-length)))) + (if (<= log-length 1) + #f + (let* ((log-string (make-string (1- log-length) #\space)) + (log-string-c (ffi:string->pointer log-string))) + (%glGetShaderInfoLog shader log-length log-length-c log-string-c) + (ffi:pointer->string log-string-c))))) +(export gl-get-shader-info-log) +(define (gl-get-program-info-log program) + (let* ((log-length-c (u32vector 0)) + (log-length (gl-get-program program (version-2-0 info-log-length)))) + (if (<= log-length 1) + #f + (let* ((log-string (make-string (1- log-length) #\space)) + (log-string-c (ffi:string->pointer log-string))) + (%glGetProgramInfoLog program log-length log-length-c log-string-c) + (ffi:pointer->string log-string-c))))) +(export gl-get-program-info-log) +(re-export (%glDeleteShader . gl-delete-shader)) +(re-export (%glDeleteProgram . gl-delete-program)) + +;;; missing GLU functions +(re-export (%gluLookAt . glu-look-at)) + +;;; missing GLUT functions (need Freeglut) +(define-enumeration glut-option + (glut-action-on-window-close #x01F9)) +(export glut-option) +(define glut-close-action-mainloop-returns 1) +(export glut-close-action-mainloop-returns) +(define-glut-procedure (glutSetOption (e-what GLenum) + (value int) + -> void) #f) +(export (glutSetOption . glut-set-option)) +(define (glut-destroy-window window) + (%glutDestroyWindow (window-id window))) +(export glut-destroy-window) diff --git a/inspekt3d/library.scm b/inspekt3d/library.scm new file mode 100644 index 0000000..dd5f935 --- /dev/null +++ b/inspekt3d/library.scm @@ -0,0 +1,88 @@ +;;; library.scm +;;; +;;; Copyright 2018 Kavalogic, Inc. +;;; +;;; This file is part of Inspekt3d. +;;; +;;; Inspekt3d 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. +;;; +;;; Inspekt3d 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 +;;; Lesser 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 +;;; . + +(eval-when (expand load eval) + (load-extension "libfive-guile" "scm_init_libfive_modules")) + +(define-module (inspekt3d library) + #:use-module (oop goops) + #:use-module (system foreign) + #:use-module (libfive kernel)) + +(define libfive-lib (dynamic-link "libfive")) +(define libfive-guile-lib (dynamic-link "libfive-guile")) + +;;; low level FFI definitions +(define libfive-region3-struct-type (list float float float float float float)) +(define (make-region3-struct r) + (let* ((x-bounds (car r)) + (y-bounds (cadr r)) + (z-bounds (caddr r)) + (x-min (car x-bounds)) (x-max (cdr x-bounds)) + (y-min (car y-bounds)) (y-max (cdr y-bounds)) + (z-min (car z-bounds)) (z-max (cdr z-bounds))) + (make-c-struct libfive-region3-struct-type + (list x-min x-max y-min y-max z-min z-max)))) +(define libfive-mesh-struct (list '* '* uint32 uint32)) +(define libfive-vec3-struct (list float float float)) +(define libfive-tri-struct (list uint32 uint32 uint32)) +(define %libfive-tree-render-mesh + (pointer->procedure '* + (dynamic-func "libfive_tree_render_mesh" libfive-lib) + (list '* libfive-region3-struct-type float))) +(define %libfive-delete-mesh + (pointer->procedure void + (dynamic-func "libfive_mesh_delete" libfive-lib) + (list '*))) + +;;; foreign mesh class +(define-class () + (mesh-ptr #:getter get-mesh-ptr #:init-keyword #:mesh-ptr #:init-value #nil) + (region #:getter get-region #:init-keyword #:region)) +(export ) +(define (make-mesh m r) (make #:mesh-ptr m #:region r)) +(define-method (get-mesh-members (self )) + (let ((mesh-struct-list (parse-c-struct (get-mesh-ptr self) libfive-mesh-struct))) + (values (car mesh-struct-list) ; verts + (cadr mesh-struct-list) ; tris + (caddr mesh-struct-list) ; tri_count + (cadddr mesh-struct-list)))) ; vert_count +(export get-mesh-members) +;;; delete low level structure +(define-method (delete-mesh (self )) + (let ((mesh-ptr (get-mesh-ptr self))) + (unless (null? mesh-ptr) + (%libfive-delete-mesh mesh-ptr) + (slot-set! self 'mesh-ptr #nil)))) +(export delete-mesh) +;;; +(define-method (shape->in-memory-mesh (s ) + (r ) + (res )) + "shape->mesh-in-memory-mesh shape region resolution + Convert a libfive shape into an in-memory object suitable for + displaying." + (make-mesh (%libfive-tree-render-mesh + ;; hack, depends on layout of shape struct!: + (dereference-pointer (unwrap-shape s)) + (make-region3-struct r) + res) + r)) +(export shape->in-memory-mesh) diff --git a/inspekt3d/shader.scm b/inspekt3d/shader.scm new file mode 100644 index 0000000..144c549 --- /dev/null +++ b/inspekt3d/shader.scm @@ -0,0 +1,134 @@ +;;; shader.scm +;;; +;;; Copyright 2018 Kavalogic, Inc. +;;; Copyright (C) 2014 Free Software Foundation, Inc. +;;; +;;; This file is part of Inspekt3d. +;;; +;;; Inspekt3d 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. +;;; +;;; Inspekt3d 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 +;;; Lesser 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 +;;; . + +(define-module (inspekt3d shader) + #:use-module (gl) + #:use-module (inspekt3d gl-missing) + #:use-module (system foreign) + #:use-module (ice-9 format) + #:use-module (oop goops)) + +;;; shader +(define-class () + (vertex-shader #:init-value #nil) + (fragment-shader #:init-value #nil) + (shader-program #:init-value #nil)) +(export ) + +;;; shader source +;;; vertex +(define *vertex-shader-source* +"#version 120 +varying vec3 ec_pos; + +void main() { + gl_Position = gl_ModelViewProjectionMatrix * gl_Vertex; + + ec_pos = gl_Position.xyz; +} +") + +;;; fragment +(define *fragment-shader-source* +"#version 120 + +varying vec3 ec_pos; + +void main() { + vec3 base3 = vec3(0.99, 0.96, 0.89); + vec3 base2 = vec3(0.92, 0.91, 0.83); + vec3 base00 = vec3(0.40, 0.48, 0.51); + + vec3 ec_normal = normalize(cross(dFdx(ec_pos), dFdy(ec_pos))); + + float a = dot(ec_normal, vec3(0.0, 0.0, 1.0)); + float b = dot(ec_normal, vec3(-0.57, -0.57, 0.57)); + + gl_FragColor = vec4((a*base2 + (1-a)*base00)*0.5 + + (b*base3 + (1-b)*base00)*0.5, 1.0); +} +") + +(define (print-shader-log shader shader-type) + (format #t "~%*** ~a shader compile failed!~%" shader-type) + (format #t "*** Log:~%") + (format #t "~a~%" (gl-get-shader-info-log shader)) + (format #t "***~%")) + +(define (print-program-log program) + (format #t "~%*** Program link failed!~%") + (format #t "*** Log:~%") + (format #t "~a~%" (gl-get-program-info-log program)) + (format #t "***~%")) + +(define string-array-type (list '*)) + +(define-method (setup (self )) + (let ((vert-shader (gl-create-shader (version-2-0 vertex-shader))) + (frag-shader (gl-create-shader (version-2-0 fragment-shader)))) + ;; compile the vertex and fragment shaders + ;; vertex shader + (let* ((vert-shader-src-str (string->pointer *vertex-shader-source*)) + (vert-shader-src-array (make-c-struct + string-array-type + (list vert-shader-src-str)))) + (gl-shader-source vert-shader 1 vert-shader-src-array %null-pointer) + (gl-compile-shader vert-shader) + (if (eq? (gl-get-shader vert-shader (version-2-0 compile-status)) + (boolean true)) + (slot-set! self 'vertex-shader vert-shader) + (print-shader-log vert-shader "Vertex"))) + ;; fragment shader + (let* ((frag-shader-src-str (string->pointer *fragment-shader-source*)) + (frag-shader-src-array (make-c-struct + string-array-type + (list frag-shader-src-str)))) + (gl-shader-source frag-shader 1 frag-shader-src-array %null-pointer) + (gl-compile-shader frag-shader) + (if (eq? (gl-get-shader frag-shader (version-2-0 compile-status)) + (boolean true)) + (slot-set! self 'fragment-shader frag-shader) + (print-shader-log frag-shader "Fragment")))) + ;; attach the shaders to the program and link + (let ((vertex-shader (slot-ref self 'vertex-shader)) + (fragment-shader (slot-ref self 'fragment-shader))) + (unless (or (null? vertex-shader) (null? fragment-shader)) + ;; attach shaders and link shader program + (let ((program (gl-create-program))) + (gl-attach-shader program vertex-shader) + (gl-attach-shader program fragment-shader) + (gl-link-program program) + (if (eq? (gl-get-program program (version-2-0 link-status)) + (boolean true)) + (begin + (gl-use-program program) + (slot-set! self 'shader-program program)) + (print-program-log program)))))) +(export setup) + +(define-method (cleanup (shader )) + (let ((vertex-shader (slot-ref shader 'vertex-shader))) + (unless (null? vertex-shader) (gl-delete-shader vertex-shader))) + (let ((fragment-shader (slot-ref shader 'fragment-shader))) + (unless (null? fragment-shader) (gl-delete-shader fragment-shader))) + (let ((shader-program (slot-ref shader 'shader-program))) + (unless (null? shader-program) (gl-delete-program shader-program)))) +(export cleanup) diff --git a/inspekt3d/viewer.scm b/inspekt3d/viewer.scm new file mode 100644 index 0000000..8ed8cc0 --- /dev/null +++ b/inspekt3d/viewer.scm @@ -0,0 +1,289 @@ +;;; viewer.scm +;;; +;;; Copyright 2018 Kavalogic, Inc. +;;; Copyright (C) 2014 Free Software Foundation, Inc. +;;; +;;; This file is part of Inspekt3d. +;;; +;;; Inspekt3d 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. +;;; +;;; Inspekt3d 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 +;;; Lesser 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 +;;; . + +;;; Derived from Guile-OpenGL 0.1.0 +;;; File: ./examples/particle-system/vbo.scm +;;; Original License: LGPL 3+ + +(define-module (inspekt3d viewer) + #:use-module (inspekt3d library) + #:use-module (inspekt3d camera) + #:use-module (inspekt3d shader) + #:use-module (inspekt3d gl-missing) + #:use-module (glut) + #:use-module (gl) + #:use-module (glu) + #:use-module (ice-9 threads) + #:use-module (ice-9 receive) + #:use-module (system foreign) + #:use-module (oop goops)) + +;;; Globals +(define *full-screen?* #f) +;;; object buffers +(define *vertex-buffer* 0) +(define *index-buffer* 0) +;;; main window +(define *main-window* #nil) +;;; shape +(define *shape-changed?* #f) +;;; set by external thread, used when shape is changed +(define *new-mesh* #nil) +(define *new-bounds* #nil) +;;; set by viewer thread, used to display +(define *mesh* #nil) +(define *bounds* #nil) +;;; mutexes +(define *run-mutex* (make-mutex)) +(define *shape-mutex* (make-mutex)) +;;; camera +(define *camera* #nil) +;;; shader +(define *shader* #nil) + +(define (draw-shape) + (unless (null? *mesh*) + (gl-enable-client-state (enable-cap vertex-array)) + (gl-bind-buffer (version-1-5 array-buffer) *vertex-buffer*) + (set-gl-vertex-array (vertex-pointer-type float) #f) + (gl-bind-buffer (version-1-5 element-array-buffer) *index-buffer*) + (gl-draw-elements (begin-mode triangles) + (* 3 (call-with-values + (lambda () (get-mesh-members *mesh*)) + (lambda (v t triangle-count vc) triangle-count))) + (data-type unsigned-int) + #f) + (gl-disable-client-state (enable-cap vertex-array)) + (gl-disable-client-state (enable-cap index-array)))) + +(define (exit-viewer) + (unless (null? *main-window*) (glut-destroy-window *main-window*))) + +(define (cleanup-for-exit) + ;; clean up the shaders + (cleanup *shader*) + ;; cleanup up the mesh + (unless (null? *mesh*) (delete-mesh *mesh*)) + (set! *main-window* #nil) + (set-shape #nil #nil #nil)) + +(define (on-display) + (gl-clear (clear-buffer-mask color-buffer depth-buffer)) + + (establish-modelview-matrix *camera*) + + (draw-shape) + + ;; With double-buffering, swap-buffers will wait for the frame to be shown, + ;; which limits this program to the frame rate. + (swap-buffers)) + +(define (reshape) + ;; use the whole window + (let ((width (get-width *camera*)) + (height (get-height *camera*))) + (gl-viewport 0 0 width height)) + + ;; update the projection matrix + (set-gl-matrix-mode (matrix-mode projection)) + (gl-load-identity) + (unless (null? *bounds*) + (establish-projection-matrix *camera* *bounds*)) + + (set-gl-matrix-mode (matrix-mode modelview))) + +(define (on-reshape width height) + ;; update the camera + (set-width *camera* width) + (set-height *camera* height) + + (reshape)) + +(define (on-special keycode x y) + #f) + +(define (on-mouse button state x y) + (cond (;; left button rotates + (eq? button (button-name left-button)) + (let ((rotator (get-rotator *camera*))) + (if (eq? state (button-state down)) + (rotation-start rotator x y) + (rotation-end rotator x y)))) + (;; mouse wheel button rotate upwards + (eq? button 3) + (let ((zoomer (get-zoomer *camera*))) + (zoom-in zoomer) + (reshape) + (post-redisplay *main-window*))) + (;; mouse wheel button rotate downwards + (eq? button 4) + (let ((zoomer (get-zoomer *camera*))) + (zoom-out zoomer) + (reshape) + (post-redisplay *main-window*))))) + +(define (on-motion x y) + (let ((rotator (get-rotator *camera*))) + (if (is-rotating? rotator) + (begin + ;; update rotation + (rotation-rotate rotator x y) + (post-redisplay *main-window*))))) + +(define (on-visibility visible?) + #f) + +(define (setup-for-display) + (let ((need-redisplay? #f)) + (when (try-mutex *shape-mutex*) + (with-throw-handler #t + (lambda () + (when *shape-changed?* + (unless (null? *mesh*) + (delete-mesh *mesh*)) + (set! *mesh* *new-mesh*) + (set! *bounds* *new-bounds*) + (set! *new-mesh* #nil) + (set! *new-bounds* #nil) + (set! *shape-changed?* #f) + (set! need-redisplay? #t))) + #f) + (unlock-mutex *shape-mutex*)) + (when need-redisplay? + (receive (vertices triangles triangle-count vertex-count) + (get-mesh-members *mesh*) + ;; set vertex buffer + (gl-delete-buffer *vertex-buffer*) ; no-op if 0 + (set! *vertex-buffer* (gl-generate-buffer)) + (gl-bind-buffer (version-1-5 array-buffer) *vertex-buffer*) + (set-gl-buffer-data (version-1-5 array-buffer) + vertices + (version-1-5 static-draw) + (* 3 (sizeof float) vertex-count)) + ;; set index buffer + (gl-delete-buffer *index-buffer*) ; no-op if 0 + (set! *index-buffer* (gl-generate-buffer)) + (gl-bind-buffer (version-1-5 element-array-buffer) *index-buffer*) + (set-gl-buffer-data (version-1-5 element-array-buffer) + triangles + (version-1-5 static-draw) + (* 3 (sizeof uint32) triangle-count)) + ;;; unbind buffers + (gl-bind-buffer (version-1-5 array-buffer) 0) + (gl-bind-buffer (version-1-5 element-array-buffer) 0))) + need-redisplay?)) + +(define (on-idle) + (when (setup-for-display) + (reshape) + (post-redisplay *main-window*))) + +(define (on-keyboard keycode x y) + (let ((c (integer->char keycode))) + (case c + ((#\f) + (set! *full-screen?* (not *full-screen?*)) + (full-screen *main-window* *full-screen?*)) + ((#\esc #\etx #\q) + (exit-viewer)) + ((#\]) + (let ((zoomer (get-zoomer *camera*))) + (zoom-in zoomer) + (reshape) + (post-redisplay *main-window*))) + ((#\[) + (let ((zoomer (get-zoomer *camera*))) + (zoom-out zoomer) + (reshape) + (post-redisplay *main-window*)))))) + +(define (register-glut-callbacks) + ;; The trampolines allow the handlers to be overridden at runtime by + ;; an attached Guile REPL client. + (set-display-callback (lambda () (on-display))) + (set-reshape-callback (lambda (w h) (on-reshape w h))) + (set-keyboard-callback (lambda (k x y) (on-keyboard k x y))) + (set-special-callback (lambda (k x y) (on-special k x y))) + (set-mouse-callback (lambda (b s x y) (on-mouse b s x y))) + (set-motion-callback (lambda (x y) (on-motion x y))) + (set-visibility-callback (lambda (visible?) (on-visibility visible?))) + (set-idle-callback (lambda () (on-idle)))) + +(define* (run-main #:key + (position #f) + (size #f) + (title "Inspekt3d")) + (initialize-glut #:window-position position + #:window-size size + #:display-mode (display-mode rgba alpha double depth)) + (set! *main-window* (make-window title)) + (set! *camera* (make )) + (set! *shader* (make )) + (setup *shader*) + + (register-glut-callbacks) + (glut-set-option (glut-option glut-action-on-window-close) + glut-close-action-mainloop-returns) + (set-gl-clear-color 0 0 0 1) + (set-gl-clear-depth 1) + + (gl-enable (enable-cap depth-test)) + (setup-for-display) + + (glut-main-loop) + + (cleanup-for-exit) + (unlock-mutex *run-mutex*)) + +(define (viewer-main args) + (if (not (try-mutex *run-mutex*)) + (error "Viewer already running.") + (apply run-main args))) + +(define (set-shape new-shape new-bounds new-resolution) + "set-shape shape bounds resolution + Sets the shape to display. When the shape parameter is #nil, this + function deallocates the current mesh." + (lock-mutex *shape-mutex*) + (with-throw-handler #t + (lambda () + (unless (null? *new-mesh*) + (delete-mesh *new-mesh*)) + (if (null? new-shape) + (begin + (set! *new-mesh* #nil) + (set! *new-bounds* #nil)) + (begin + (set! *new-mesh* + (shape->in-memory-mesh new-shape new-bounds new-resolution)) + (set! *new-bounds* new-bounds))) + (set! *shape-changed?* #t)) + #f) + (unlock-mutex *shape-mutex*)) +(export set-shape) + +;;; TODO: make multiple viewers possible (using a class) +;;; TODO: for now, only one viewer allowed +(define (make-viewer . args) + (call-with-new-thread + (lambda () + (viewer-main args)))) +(export make-viewer) diff --git a/turtle.png b/turtle.png new file mode 100644 index 0000000..b3cca94 Binary files /dev/null and b/turtle.png differ