diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -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/README b/README new file mode 100644 index 0000000..768e940 --- /dev/null +++ b/README @@ -0,0 +1,8 @@ +README +====== + +The Gridify plugin. + +This plugin allows you to generate a grid of ways (as blocks or as lines) from any four nodes, or way of four nodes. + +Author: Jeroen Hoek (mail@jeroenhoek.nl) diff --git a/build.xml b/build.xml new file mode 100644 index 0000000..5adccfa --- /dev/null +++ b/build.xml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/en.pot b/en.pot new file mode 100644 index 0000000..043aa0e --- /dev/null +++ b/en.pot @@ -0,0 +1,72 @@ +# Gridify translations. +# Copyright (C) 2018 Jeroen Hoek +# This file is distributed under the same license as the Gridify plugin. +# Jeroen Hoek , 2018. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: 1\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2018-05-13 12:34+0200\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: Jeroen Hoek \n" +"Language-Team: LANGUAGE \n" +"Language: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#: src/nl/jeroenhoek/josm/gridify/GridifyAction.java:28 +msgid "Generate a grid of ways from four nodes." +msgstr "" + +#: src/nl/jeroenhoek/josm/gridify/GridifyAction.java:32 +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:29 +msgid "Gridify" +msgstr "" + +#: src/nl/jeroenhoek/josm/gridify/GridifyAction.java:37 +#, java-format +msgid "Tool: {0}" +msgstr "" + +#: src/nl/jeroenhoek/josm/gridify/GridifyAction.java:87 +msgid "Select four nodes, or a way consisting of four nodes." +msgstr "" + +#: src/nl/jeroenhoek/josm/gridify/Operation.java:47 +msgid "Lines" +msgstr "" + +#: src/nl/jeroenhoek/josm/gridify/Operation.java:84 +msgid "Blocks" +msgstr "" + +#: src/nl/jeroenhoek/josm/gridify/ui/SourceWayPanel.java:19 +msgid "Copy tags from source way" +msgstr "" + +#: src/nl/jeroenhoek/josm/gridify/ui/SourceWayPanel.java:24 +msgid "Delete source way" +msgstr "" + +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:29 +msgid "Gridify preview" +msgstr "" + +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:29 +msgid "Cancel" +msgstr "" + +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:51 +msgid "Output shape" +msgstr "" + +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:60 +msgid "Grid size" +msgstr "" + +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:76 +msgid "Source way" +msgstr "" diff --git a/images/gridify.png b/images/gridify.png new file mode 100644 index 0000000..18c5054 Binary files /dev/null and b/images/gridify.png differ diff --git a/po/de.po b/po/de.po new file mode 100644 index 0000000..75410fe --- /dev/null +++ b/po/de.po @@ -0,0 +1,72 @@ +# Gridify translations. +# Copyright (C) 2018 Jeroen Hoek +# This file is distributed under the same license as the Gridify plugin. +# Jeroen Hoek , 2018. +# +msgid "" +msgstr "" +"Project-Id-Version: 1\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2018-05-13 12:34+0200\n" +"PO-Revision-Date: 2018-05-15 20:20+0200\n" +"Last-Translator: Jeroen Hoek \n" +"Language: de\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Language-Team: \n" +"X-Generator: Poedit 1.8.7.1\n" + +#: src/nl/jeroenhoek/josm/gridify/GridifyAction.java:28 +msgid "Generate a grid of ways from four nodes." +msgstr "Erzeuge ein Gitter von Linien aus vier Punkte." + +#: src/nl/jeroenhoek/josm/gridify/GridifyAction.java:32 +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:29 +msgid "Gridify" +msgstr "Gitterfizieren" + +#: src/nl/jeroenhoek/josm/gridify/GridifyAction.java:37 +#, java-format +msgid "Tool: {0}" +msgstr "Werkzeuge: {0}" + +#: src/nl/jeroenhoek/josm/gridify/GridifyAction.java:87 +msgid "Select four nodes, or a way consisting of four nodes." +msgstr "Wähle vier Punkte, oder ein Linien die aus vier Punkte besteht, aus." + +#: src/nl/jeroenhoek/josm/gridify/Operation.java:47 +msgid "Lines" +msgstr "Linien" + +#: src/nl/jeroenhoek/josm/gridify/Operation.java:84 +msgid "Blocks" +msgstr "Blöcke" + +#: src/nl/jeroenhoek/josm/gridify/ui/SourceWayPanel.java:19 +msgid "Copy tags from source way" +msgstr "Merkmale von Quelllinie kopieren" + +#: src/nl/jeroenhoek/josm/gridify/ui/SourceWayPanel.java:24 +msgid "Delete source way" +msgstr "Quelllinie entfernen" + +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:29 +msgid "Gridify preview" +msgstr "Vorschau Gitterfizieren" + +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:29 +msgid "Cancel" +msgstr "Abbrechen" + +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:51 +msgid "Output shape" +msgstr "Ausgabeform" + +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:60 +msgid "Grid size" +msgstr "Gittermaß" + +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:76 +msgid "Source way" +msgstr "Quelllinie" diff --git a/po/ja.po b/po/ja.po new file mode 100644 index 0000000..9b44e5e --- /dev/null +++ b/po/ja.po @@ -0,0 +1,72 @@ +# Gridify translations. +# Copyright (C) 2018 Jeroen Hoek +# This file is distributed under the same license as the Gridify plugin. +# Jeroen Hoek , 2018. +# +msgid "" +msgstr "" +"Project-Id-Version: 1\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2018-05-13 12:34+0200\n" +"PO-Revision-Date: 2018-05-15 20:48+0200\n" +"Last-Translator: Jeroen Hoek \n" +"Language: ja\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Language-Team: \n" +"X-Generator: Poedit 1.8.7.1\n" + +#: src/nl/jeroenhoek/josm/gridify/GridifyAction.java:28 +msgid "Generate a grid of ways from four nodes." +msgstr "4つのノードでウェイのグリッドを作成する。" + +#: src/nl/jeroenhoek/josm/gridify/GridifyAction.java:32 +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:29 +msgid "Gridify" +msgstr "グリッド化" + +#: src/nl/jeroenhoek/josm/gridify/GridifyAction.java:37 +#, java-format +msgid "Tool: {0}" +msgstr "ツール:{0}" + +#: src/nl/jeroenhoek/josm/gridify/GridifyAction.java:87 +msgid "Select four nodes, or a way consisting of four nodes." +msgstr "4つのノード、又は4つのノードからならウェイを選択してください。" + +#: src/nl/jeroenhoek/josm/gridify/Operation.java:47 +msgid "Lines" +msgstr "線" + +#: src/nl/jeroenhoek/josm/gridify/Operation.java:84 +msgid "Blocks" +msgstr "ブロック" + +#: src/nl/jeroenhoek/josm/gridify/ui/SourceWayPanel.java:19 +msgid "Copy tags from source way" +msgstr "タグを元のウェイからコピー" + +#: src/nl/jeroenhoek/josm/gridify/ui/SourceWayPanel.java:24 +msgid "Delete source way" +msgstr "元のウェイを削除" + +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:29 +msgid "Gridify preview" +msgstr "グリッド化プレビュー" + +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:29 +msgid "Cancel" +msgstr "キャンセル" + +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:51 +msgid "Output shape" +msgstr "出力形" + +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:60 +msgid "Grid size" +msgstr "グリッドサイズ" + +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:76 +msgid "Source way" +msgstr "元のウェイ" diff --git a/po/nl.po b/po/nl.po new file mode 100644 index 0000000..4b9d845 --- /dev/null +++ b/po/nl.po @@ -0,0 +1,72 @@ +# Gridify translations. +# Copyright (C) 2018 Jeroen Hoek +# This file is distributed under the same license as the Gridify plugin. +# Jeroen Hoek , 2018. +# +msgid "" +msgstr "" +"Project-Id-Version: 1\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2018-05-13 12:34+0200\n" +"PO-Revision-Date: 2018-05-13 15:50+0200\n" +"Last-Translator: Jeroen Hoek \n" +"Language: nl\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Language-Team: \n" +"X-Generator: Poedit 1.8.7.1\n" + +#: src/nl/jeroenhoek/josm/gridify/GridifyAction.java:28 +msgid "Generate a grid of ways from four nodes." +msgstr "Genereer een raster van wegen op basis van vier knopen." + +#: src/nl/jeroenhoek/josm/gridify/GridifyAction.java:32 +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:29 +msgid "Gridify" +msgstr "Rasterficeer" + +#: src/nl/jeroenhoek/josm/gridify/GridifyAction.java:37 +#, java-format +msgid "Tool: {0}" +msgstr "Gereedschap: {0}" + +#: src/nl/jeroenhoek/josm/gridify/GridifyAction.java:87 +msgid "Select four nodes, or a way consisting of four nodes." +msgstr "Selecteer vier knopen, of een weg bestaande uit vier knopen." + +#: src/nl/jeroenhoek/josm/gridify/Operation.java:47 +msgid "Lines" +msgstr "Lijnen" + +#: src/nl/jeroenhoek/josm/gridify/Operation.java:84 +msgid "Blocks" +msgstr "Blokken" + +#: src/nl/jeroenhoek/josm/gridify/ui/SourceWayPanel.java:19 +msgid "Copy tags from source way" +msgstr "Kopieer tags van de bronweg" + +#: src/nl/jeroenhoek/josm/gridify/ui/SourceWayPanel.java:24 +msgid "Delete source way" +msgstr "Verwijder bronweg" + +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:29 +msgid "Gridify preview" +msgstr "Voorbeschouwing rasterficeer" + +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:29 +msgid "Cancel" +msgstr "Annuleren" + +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:51 +msgid "Output shape" +msgstr "Uitvoervorm" + +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:60 +msgid "Grid size" +msgstr "Rastermaat" + +#: src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java:76 +msgid "Source way" +msgstr "Bronweg" diff --git a/src/nl/jeroenhoek/josm/gridify/GridExtrema.java b/src/nl/jeroenhoek/josm/gridify/GridExtrema.java new file mode 100644 index 0000000..8207420 --- /dev/null +++ b/src/nl/jeroenhoek/josm/gridify/GridExtrema.java @@ -0,0 +1,163 @@ +// License: GPL. For details, see LICENSE file. +package nl.jeroenhoek.josm.gridify; + +import org.openstreetmap.josm.data.coor.EastNorth; +import org.openstreetmap.josm.data.osm.Node; +import org.openstreetmap.josm.tools.Geometry; + +/** + * Four nodes representing the area selected by the user. The order of the nodes describes the resulting polygon in a + * clockwise manner. + */ +public final class GridExtrema { + Node one; + Node two; + Node three; + Node four; + + private GridExtrema(Node one, Node two, Node three, Node four) { + this.one = one; + this.two = two; + this.three = three; + this.four = four; + } + + /** + * Static constructor for {@link GridExtrema}. This method figures out the correct order of the four nodes to + * form a clockwise way starting at node {@code a}. + * + * @param a A node. + * @param b Another node. + * @param c Yet another node. + * @param d Again, another node. + * @return A {@link GridExtrema} instance. + */ + public static GridExtrema from(Node a, Node b, Node c, Node d) { + EastNorth enForA = a.getEastNorth(); + EastNorth enForB = b.getEastNorth(); + EastNorth enForC = c.getEastNorth(); + EastNorth enForD = d.getEastNorth(); + + double a1 = Geometry.getCornerAngle(enForB, enForA, enForC); + double a2 = Geometry.getCornerAngle(enForB, enForA, enForD); + double a3 = Geometry.getCornerAngle(enForC, enForA, enForD); + + // Figure out the correct order of the four nodes to form a clockwise way starting at + // node 'a'. The two nodes that form the biggest angle when connected with starting node + // 'a' (1) in the middle are by necessity nodes 2 and 4. The direction of the angle tells + // us which is which. + if (Math.abs(a1) > Math.abs(a2) && Math.abs(a1) > Math.abs(a3)) { + if (a1 >= 0) { + return new GridExtrema(a, b, d, c); + } else { + return new GridExtrema(a, c, d, b); + } + } else if (Math.abs(a2) > Math.abs(a1) && Math.abs(a2) > Math.abs(a3)) { + if (a2 >= 0) { + return new GridExtrema(a, b, c, d); + } else { + return new GridExtrema(a, d, c, b); + } + } else { + if (a3 >= 0) { + return new GridExtrema(a, c, b, d); + } else { + return new GridExtrema(a, d, b, c); + } + } + } + + public Node getNodeOne() { + return one; + } + + public Node getNodeTwo() { + return two; + } + + public Node getNodeThree() { + return three; + } + + public Node getNodeFour() { + return four; + } + + public Dimensions getDimensions() { + Dimensions dimensions = new Dimensions(this.one.getEastNorth()); + + dimensions.recomputeBounds(this.two.getEastNorth()); + dimensions.recomputeBounds(this.three.getEastNorth()); + dimensions.recomputeBounds(this.four.getEastNorth()); + + return dimensions; + } + + /** + * Value class containing the minimum and maximum {@link EastNorth} coordinates of the nodes passed to it. This + * effectively gives us a bounding box for a set of nodes. + */ + public static class Dimensions { + double minY; + double maxY; + double minX; + double maxX; + + /** + * Create a new {@link Dimensions} instance. + * + * @param eastNorth Use this coordinate pair as the base value. + */ + public Dimensions(EastNorth eastNorth) { + minY = eastNorth.getY(); + maxY = minY; + minX = eastNorth.getX(); + maxX = minX; + } + + /** + * Add a coordinate pair to this class and recompute the bounds. + * + * @param eastNorth Coordinate pair to add. + */ + public void recomputeBounds(EastNorth eastNorth) { + minY = Math.min(minY, eastNorth.getY()); + maxY = Math.max(maxY, eastNorth.getY()); + minX = Math.min(minX, eastNorth.getX()); + maxX = Math.max(maxX, eastNorth.getX()); + } + + /** + * Compute which is greater; the width or the height of the bounding box represented by this class, and + * return it. + * + * @return The greater value of the width and height. + */ + public double longestOfWidthAndHeight() { + return maxX - minX > maxY - minY + ? maxX - minX + : maxY - minY; + } + + public double getMinY() { + return minY; + } + + public double getMaxY() { + return maxY; + } + + public double getMinX() { + return minX; + } + + public double getMaxX() { + return maxX; + } + + @Override + public String toString() { + return "(x: " + minX + "/" + maxX + ", y: " + minY + "/" + maxY + ")"; + } + } +} diff --git a/src/nl/jeroenhoek/josm/gridify/GridifyAction.java b/src/nl/jeroenhoek/josm/gridify/GridifyAction.java new file mode 100644 index 0000000..ac20e05 --- /dev/null +++ b/src/nl/jeroenhoek/josm/gridify/GridifyAction.java @@ -0,0 +1,211 @@ +// License: GPL. For details, see LICENSE file. +package nl.jeroenhoek.josm.gridify; + +import nl.jeroenhoek.josm.gridify.exception.GridifyException; +import nl.jeroenhoek.josm.gridify.exception.UserInputException; +import nl.jeroenhoek.josm.gridify.exception.UserCancelledException; +import nl.jeroenhoek.josm.gridify.ui.GridifySettingsDialog; +import org.openstreetmap.josm.Main; +import org.openstreetmap.josm.actions.JosmAction; +import org.openstreetmap.josm.command.AddCommand; +import org.openstreetmap.josm.command.ChangePropertyCommand; +import org.openstreetmap.josm.command.Command; +import org.openstreetmap.josm.command.DeleteCommand; +import org.openstreetmap.josm.command.SequenceCommand; +import org.openstreetmap.josm.data.coor.EastNorth; +import org.openstreetmap.josm.data.osm.DataSet; +import org.openstreetmap.josm.data.osm.Node; +import org.openstreetmap.josm.data.osm.OsmPrimitive; +import org.openstreetmap.josm.data.osm.TagMap; +import org.openstreetmap.josm.data.osm.Way; +import org.openstreetmap.josm.gui.MainApplication; +import org.openstreetmap.josm.tools.Logging; +import org.openstreetmap.josm.tools.Shortcut; + +import javax.swing.JOptionPane; +import java.awt.event.ActionEvent; +import java.awt.event.KeyEvent; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.Optional; + +import static nl.jeroenhoek.josm.gridify.exception.UserInputException.error; +import static org.openstreetmap.josm.tools.I18n.tr; + +/** + * The Gridify action opens a modal dialog where the user can configure the operation of this plugin, and execute it. + */ +public class GridifyAction extends JosmAction { + static final String DESCRIPTION = tr("Generate a grid of ways from four nodes."); + + public GridifyAction() { + super( + tr("Gridify"), + "gridify", + DESCRIPTION, + Shortcut.registerShortcut( + "tools:gridify", + tr("Tool: {0}", DESCRIPTION), + KeyEvent.VK_Y, + Shortcut.ALT_SHIFT + ), + true + ); + } + + @Override + public void actionPerformed(ActionEvent actionEvent) { + DataSet dataSet = getLayerManager().getEditDataSet(); + + Collection commands; + try { + commands = performGridifyAction(dataSet); + } catch (UserInputException e) { + // Tell the user what was wrong with their input. + JOptionPane.showMessageDialog(Main.parent, e.getMessage()); + return; + } catch (UserCancelledException e) { + // That's fine. + return; + } catch (GridifyException e) { + Logging.warn(e.getMessage()); + return; + } + + Main.main.undoRedo.add(new SequenceCommand(DESCRIPTION, commands)); + MainApplication.getMap().repaint(); + } + + @Override + protected void updateEnabledState() { + // Keep this action disabled when there is no data set to work with. + DataSet dataSet = getLayerManager().getEditDataSet(); + setEnabled(dataSet != null && !dataSet.selectionEmpty()); + } + + @Override + protected void updateEnabledState(Collection selection) { + // Only enable this action when there is a selection to work with. + updateEnabledStateOnModifiableSelection(selection); + } + + Collection performGridifyAction(DataSet dataSet) throws GridifyException { + if (dataSet == null) throw new GridifyException("Called with null data-set."); + + Collection selection = dataSet.getSelected(); + + InputData inputData = inputDataFromSelection(selection) + .orElseThrow(error(tr("Select four nodes, or a way consisting of four nodes."))); + + GridifySettingsDialog dialog = new GridifySettingsDialog(inputData); + dialog.showDialog(); + + // Only the OK button returns 1, the rest means 'Cancel' or a closed dialog window. + if (dialog.getValue() != 1) { + throw new UserCancelledException(); + } + + GridExtrema extrema = inputData.getGridExtrema(); + Collection commands = new ArrayList<>(); + + int numRows = dialog.getRowCount(); + int numColumns = dialog.getColumnCount(); + Operation operation = dialog.getOperation(); + boolean deleteSourceWay = dialog.deleteSourceWay(); + boolean copyTags = dialog.copyTags(); + + + List nodesTopBetween = nodesBetween(extrema.one, extrema.two, numColumns - 1); + addToDataSet(commands, dataSet, nodesTopBetween); + List nodesTop = combine(extrema.one, nodesTopBetween, extrema.two); + + List nodesBottomBetween = nodesBetween(extrema.four, extrema.three, numColumns - 1); + addToDataSet(commands, dataSet, nodesBottomBetween); + List nodesBottom = combine(extrema.four, nodesBottomBetween, extrema.three); + + List> columns = new ArrayList<>(numColumns + 1); + + for (int i = 0; i < numColumns + 1; i++) { + Node start = nodesTop.get(i); + Node stop = nodesBottom.get(i); + List nodesBetween = nodesBetween(start, stop, numRows - 1); + addToDataSet(commands, dataSet, nodesBetween); + List column = combine(start, nodesBetween, stop); + columns.add(column); + } + + List ways = operation.perform(columns); + addToDataSet(commands, dataSet, ways); + if (!inputData.getTags().isEmpty() && copyTags) { + commands.add(new ChangePropertyCommand(dataSet, ways, inputData.getTags())); + } + + if (deleteSourceWay) { + inputData.getSourceWay().ifPresent(way -> commands.add(new DeleteCommand(dataSet, way))); + } + + return commands; + } + + Optional inputDataFromSelection(Collection selection) { + // Four nodes? + if (selection.size() == 4) { + List nodes = OsmPrimitive.getFilteredList(selection, Node.class); + if (nodes.size() == 4) { + GridExtrema extrema = GridExtrema.from(nodes.get(0), nodes.get(1), nodes.get(2), nodes.get(3)); + return Optional.of(new InputData(extrema)); + } + } + + // One way consisting of four nodes? + if (selection.size() == 1) { + List ways = OsmPrimitive.getFilteredList(selection, Way.class); + if (ways.size() == 1) { + Way way = ways.get(0); + List nodes = way.getNodes(); + // In closed ways consisting of four nodes the first node is repeated as the last node, + // so #getNodes returns 5 nodes for such closed ways. + if (nodes.size() == (way.isClosed() ? 5 : 4)) { + GridExtrema extrema = GridExtrema.from(nodes.get(0), nodes.get(1), nodes.get(2), nodes.get(3)); + TagMap tags = way.getKeys(); + return Optional.of(new InputData(extrema, way, tags)); + } + } + } + + return Optional.empty(); + } + + List nodesBetween(Node start, Node stop, int n) { + if (n < 1) return Collections.emptyList(); + + EastNorth startCoords = start.getEastNorth(); + EastNorth stopCoords = stop.getEastNorth(); + + List nodes = new ArrayList<>(); + for (int i = 0; i < n; i++) { + double fraction = (i + 1.0) / (n + 1.0); + EastNorth intCoords = startCoords.interpolate(stopCoords, fraction); + nodes.add(new Node(intCoords)); + } + + return nodes; + } + + void addToDataSet(Collection commands, DataSet dataSet, List primitives) { + for (OsmPrimitive primitive : primitives) { + commands.add(new AddCommand(dataSet, primitive)); + } + } + + List combine(Node start, List between, Node stop) { + List nodes = new ArrayList<>(); + nodes.add(start); + nodes.addAll(between); + nodes.add(stop); + return nodes; + } + +} diff --git a/src/nl/jeroenhoek/josm/gridify/GridifyPlugin.java b/src/nl/jeroenhoek/josm/gridify/GridifyPlugin.java new file mode 100644 index 0000000..80cab33 --- /dev/null +++ b/src/nl/jeroenhoek/josm/gridify/GridifyPlugin.java @@ -0,0 +1,18 @@ +// License: GPL. For details, see LICENSE file. +package nl.jeroenhoek.josm.gridify; + +import org.openstreetmap.josm.gui.MainApplication; +import org.openstreetmap.josm.gui.MainMenu; +import org.openstreetmap.josm.plugins.Plugin; +import org.openstreetmap.josm.plugins.PluginInformation; + +/** + * The Gridify plugin turns four nodes into a user configured grid of shapes. Useful for splitting up areas into + * {@code amenity=parking_space} etc. + */ +public class GridifyPlugin extends Plugin { + public GridifyPlugin(PluginInformation info) { + super(info); + MainMenu.add(MainApplication.getMenu().moreToolsMenu, new GridifyAction()); + } +} diff --git a/src/nl/jeroenhoek/josm/gridify/InputData.java b/src/nl/jeroenhoek/josm/gridify/InputData.java new file mode 100644 index 0000000..679dae6 --- /dev/null +++ b/src/nl/jeroenhoek/josm/gridify/InputData.java @@ -0,0 +1,57 @@ +// License: GPL. For details, see LICENSE file. +package nl.jeroenhoek.josm.gridify; + +import org.openstreetmap.josm.data.osm.Way; + +import java.util.HashMap; +import java.util.Map; +import java.util.Optional; + +/** + * Sanitized representation of the primitives selected by the user. + */ +public class InputData { + private final GridExtrema extrema; + private final Way sourceWay; + private final Map tags; + + public InputData(GridExtrema extrema) { + this.extrema = extrema; + this.tags = new HashMap<>(); + this.sourceWay = null; + } + + public InputData(GridExtrema extrema, Way sourceWay, Map tags) { + this.extrema = extrema; + this.sourceWay = sourceWay; + this.tags = tags; + } + + /** + * Get the computed {@link GridExtrema} for this user input. + * + * @return A {@link GridExtrema} instance. @{code null} is never returned. + */ + public GridExtrema getGridExtrema() { + return extrema; + } + + /** + * The tags present on the way the user selected. If that has no tags, or no way was selected, this method + * returns an empty {@link Map}. + * + * @return A map of tags. @{code null} is never returned, but the {@link Map} may be empty. + */ + public Map getTags() { + return tags; + } + + /** + * The source way the user selected, if present. + * + * @return An optional containing the source {@link Way} if the user selected one. + */ + public Optional getSourceWay() { + return Optional.ofNullable(sourceWay); + } +} diff --git a/src/nl/jeroenhoek/josm/gridify/Operation.java b/src/nl/jeroenhoek/josm/gridify/Operation.java new file mode 100644 index 0000000..1cae700 --- /dev/null +++ b/src/nl/jeroenhoek/josm/gridify/Operation.java @@ -0,0 +1,97 @@ +// License: GPL. For details, see LICENSE file. +package nl.jeroenhoek.josm.gridify; + +import nl.jeroenhoek.josm.gridify.exception.GridifyException; +import org.openstreetmap.josm.data.osm.Node; +import org.openstreetmap.josm.data.osm.Way; + +import java.util.ArrayList; +import java.util.List; + +import static org.openstreetmap.josm.tools.I18n.tr; + +/** + * Operation to perform. + */ +public enum Operation { + /** + * Generate a grid of connected straight lines. + */ + LINES { + @Override + public List perform(List> columns) { + List lines = new ArrayList<>(); + + int rows = 0; + for (List column : columns) { + rows = column.size(); + Way line = new Way(); + for (Node node : column) { + line.addNode(node); + } + lines.add(line); + } + + for (int i = 0; i < rows; i++) { + Way line = new Way(); + for (List column : columns) { + line.addNode(column.get(i)); + } + lines.add(line); + } + + return lines; + } + + @Override + public String toString() { + return tr("Lines"); + } + }, + /** + * Generate a grid of connected blocks. + */ + BLOCKS { + @Override + public List perform(List> columns) throws GridifyException { + List blocks = new ArrayList<>(); + if (columns.size() <= 1) return blocks; + + for (int col = 0; col < columns.size() - 1; col++) { + List left = columns.get(col); + List right = columns.get(col + 1); + + if (left.size() <= 1 || right.size() <= 1) continue; + if (left.size() != right.size()) { + throw new GridifyException("Nodes per column varies. This should not be possible."); + } + + for (int row = 0; row < left.size() - 1; row++) { + Way block = new Way(); + block.addNode(left.get(row)); + block.addNode(right.get(row)); + block.addNode(right.get(row + 1)); + block.addNode(left.get(row + 1)); + block.addNode(left.get(row)); + blocks.add(block); + } + } + + return blocks; + } + + @Override + public String toString() { + return tr("Blocks"); + } + }; + + /** + * Perform the operation. + * + * @param columns All the nodes of the grid, as a list of columns each containing an equal number of nodes. + * @return A list of newly generated {@link Way} instances. + * @throws GridifyException Thrown when an error occurs. + */ + public abstract List perform(List> columns) throws GridifyException; +} diff --git a/src/nl/jeroenhoek/josm/gridify/exception/GridifyException.java b/src/nl/jeroenhoek/josm/gridify/exception/GridifyException.java new file mode 100644 index 0000000..3e160ac --- /dev/null +++ b/src/nl/jeroenhoek/josm/gridify/exception/GridifyException.java @@ -0,0 +1,15 @@ +// License: GPL. For details, see LICENSE file. +package nl.jeroenhoek.josm.gridify.exception; + +/** + * Base class for exceptions thrown within the Gridify plugin. + */ +public class GridifyException extends Exception { + public GridifyException() { + super(); + } + + public GridifyException(String message) { + super(message); + } +} diff --git a/src/nl/jeroenhoek/josm/gridify/exception/UserCancelledException.java b/src/nl/jeroenhoek/josm/gridify/exception/UserCancelledException.java new file mode 100644 index 0000000..78fad83 --- /dev/null +++ b/src/nl/jeroenhoek/josm/gridify/exception/UserCancelledException.java @@ -0,0 +1,11 @@ +// License: GPL. For details, see LICENSE file. +package nl.jeroenhoek.josm.gridify.exception; + +/** + * Thrown when the user aborts the operation. + */ +public class UserCancelledException extends GridifyException { + public UserCancelledException() { + super(); + } +} diff --git a/src/nl/jeroenhoek/josm/gridify/exception/UserInputException.java b/src/nl/jeroenhoek/josm/gridify/exception/UserInputException.java new file mode 100644 index 0000000..29da3b5 --- /dev/null +++ b/src/nl/jeroenhoek/josm/gridify/exception/UserInputException.java @@ -0,0 +1,18 @@ +// License: GPL. For details, see LICENSE file. +package nl.jeroenhoek.josm.gridify.exception; + +import java.util.function.Supplier; + +/** + * Thrown when there is a problem with the user input. {@link #getMessage()} returns a human-readable error message + * intended for the user. + */ +public class UserInputException extends GridifyException { + public UserInputException(String message) { + super(message); + } + + public static Supplier error(String message) { + return () -> new UserInputException(message); + } +} diff --git a/src/nl/jeroenhoek/josm/gridify/ui/GridSizePanel.java b/src/nl/jeroenhoek/josm/gridify/ui/GridSizePanel.java new file mode 100644 index 0000000..7e4772d --- /dev/null +++ b/src/nl/jeroenhoek/josm/gridify/ui/GridSizePanel.java @@ -0,0 +1,90 @@ +// License: GPL. For details, see LICENSE file. +package nl.jeroenhoek.josm.gridify.ui; + +import javax.swing.Box; +import javax.swing.BoxLayout; +import javax.swing.JLabel; +import javax.swing.JPanel; +import javax.swing.JSpinner; +import java.awt.Font; + +/** + * UI widget that allows the user to set the grid division; i.e., how many rows and columns. + */ +public class GridSizePanel extends JPanel { + private final JSpinner spinnerRows; + private final JSpinner spinnerColumns; + + private final ChangeCallback changeCallback; + + private int rows; + private int columns; + + public GridSizePanel(ChangeCallback changeCallback, int rows, int columns) { + this.changeCallback = changeCallback; + this.rows = rows; + this.columns = columns; + setLayout(new BoxLayout(this, BoxLayout.X_AXIS)); + + spinnerRows = new PositiveSpinner(rows); + spinnerColumns = new PositiveSpinner(columns); + JLabel xLabel = new JLabel("×"); + xLabel.setFont(new Font("Monospaced", Font.PLAIN, 18)); + + + add(spinnerRows); + add(Box.createHorizontalStrut(10)); + add(xLabel); + add(Box.createHorizontalStrut(10)); + add(spinnerColumns); + + spinnerRows.addChangeListener(e -> setRowCount((int) spinnerRows.getValue())); + spinnerColumns.addChangeListener(e -> setColumnCount((int) spinnerColumns.getValue())); + } + + void setRowCount(int rows) { + this.rows = rows; + this.spinnerRows.setValue(rows); + changeCallback.changed(getRowCount(), getColumnCount()); + } + + void setColumnCount(int columns) { + this.columns = columns; + this.spinnerColumns.setValue(columns); + changeCallback.changed(getRowCount(), getColumnCount()); + } + + void nudgeRowCount(Nudge direction) { + if (direction == Nudge.INCREMENT || this.rows > 1) { + this.rows += direction == Nudge.INCREMENT ? 1 : -1; + this.spinnerRows.setValue(rows); + changeCallback.changed(getRowCount(), getColumnCount()); + } + } + + void nudgeColumnCount(Nudge direction) { + if (direction == Nudge.INCREMENT || this.columns > 1) { + this.columns += direction == Nudge.INCREMENT ? 1 : -1; + this.spinnerColumns.setValue(columns); + changeCallback.changed(getRowCount(), getColumnCount()); + } + } + + public int getRowCount() { + return this.rows; + } + + public int getColumnCount() { + return this.columns; + } + + @FunctionalInterface + interface ChangeCallback { + void changed(int rows, int columns); + } + + public enum Nudge { + INCREMENT, + DECREMENT + } +} diff --git a/src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java b/src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java new file mode 100644 index 0000000..9f15007 --- /dev/null +++ b/src/nl/jeroenhoek/josm/gridify/ui/GridifySettingsDialog.java @@ -0,0 +1,151 @@ +// License: GPL. For details, see LICENSE file. +package nl.jeroenhoek.josm.gridify.ui; + +import nl.jeroenhoek.josm.gridify.InputData; +import nl.jeroenhoek.josm.gridify.Operation; +import nl.jeroenhoek.josm.gridify.ui.GridSizePanel.Nudge; +import org.openstreetmap.josm.Main; +import org.openstreetmap.josm.gui.ExtendedDialog; + +import javax.swing.BorderFactory; +import javax.swing.Box; +import javax.swing.BoxLayout; +import javax.swing.JLabel; +import javax.swing.JPanel; +import javax.swing.border.Border; +import java.awt.Color; +import java.awt.Dimension; +import java.awt.GridBagConstraints; +import java.awt.GridBagLayout; +import java.awt.Insets; + +import static org.openstreetmap.josm.tools.I18n.tr; + +/** + * The modal dialog presented to the user when executing the Gridify action. + */ +public class GridifySettingsDialog extends ExtendedDialog { + private final InputData inputData; + + private GridSizePanel gridSizePanel; + private OperationChooser operationChooser; + private SourceWayPanel sourceWayPanel; + + private final int ROWS_DEFAULT = 2; + private final int COLUMNS_DEFAULT = 3; + + public GridifySettingsDialog(InputData inputData) { + super(Main.parent, tr("Gridify preview"), tr("Gridify"), tr("Cancel")); + this.inputData = inputData; + } + + @Override + public void setupDialog() { + final Insets insetsDefault = new Insets(0, 0, 10, 0); + final Insets insetsIndent = new Insets(0, 30, 10, 0); + final Border underline = BorderFactory.createMatteBorder(0, 0, 1, 0, Color.black); + + + Preview preview = new Preview(inputData.getGridExtrema(), this); + + JPanel rootPanel = new JPanel(); + setMinimumSize(new Dimension(550, 360)); + rootPanel.setLayout(new BoxLayout(rootPanel, BoxLayout.X_AXIS)); + + JPanel controlPanel = new JPanel(); + controlPanel.setLayout(new GridBagLayout()); + GridBagConstraints constraints = new GridBagConstraints(); + constraints.fill = GridBagConstraints.HORIZONTAL; + + JLabel operationChooserLabel = new JLabel(tr("Output shape")); + operationChooserLabel.setBorder(underline); + controlPanel.add(operationChooserLabel, constraints); + + operationChooser = new OperationChooser(Operation.BLOCKS); + constraints.gridy = 1; + constraints.insets = insetsIndent; + controlPanel.add(operationChooser, constraints); + + JLabel gridSizePanelLabel = new JLabel(tr("Grid size")); + gridSizePanelLabel.setBorder(underline); + constraints.gridy = 2; + constraints.insets = insetsDefault; + controlPanel.add(gridSizePanelLabel, constraints); + + gridSizePanel = new GridSizePanel( + preview::updateRowsColumns, + ROWS_DEFAULT, + COLUMNS_DEFAULT + ); + constraints.gridy = 3; + constraints.insets = insetsIndent; + controlPanel.add(gridSizePanel, constraints); + + if (inputData.getSourceWay().isPresent()) { + JLabel wayLabel = new JLabel(tr("Source way")); + wayLabel.setBorder(underline); + constraints.gridy = 4; + constraints.insets = insetsDefault; + controlPanel.add(wayLabel, constraints); + + boolean deleteSourceWay = inputData.getSourceWay().get().isNew(); + + sourceWayPanel = new SourceWayPanel(true, deleteSourceWay); + constraints.gridy = 5; + constraints.insets = insetsIndent; + controlPanel.add(sourceWayPanel, constraints); + } + + rootPanel.add(controlPanel); + rootPanel.add(Box.createHorizontalGlue()); + + rootPanel.add(preview); + + setContent(rootPanel, false); + setButtonIcons("ok.png", "cancel.png"); + setDefaultButton(1); + + super.setupDialog(); + } + + @Override + public Dimension getMinimumSize() { + return getPreferredSize(); + } + + public int getRowCount() { + return gridSizePanel == null + ? ROWS_DEFAULT + : gridSizePanel.getRowCount(); + } + + public int getColumnCount() { + return gridSizePanel == null + ? COLUMNS_DEFAULT + : gridSizePanel.getColumnCount(); + } + + public void nudgeRowCount(Nudge direction) { + if (gridSizePanel != null) { + gridSizePanel.nudgeRowCount(direction); + } + } + + public void nudgeColumnCount(Nudge direction) { + if (gridSizePanel != null) { + gridSizePanel.nudgeColumnCount(direction); + } + } + + public Operation getOperation() { + return operationChooser.getSelected(); + } + + public boolean copyTags() { + return inputData.getSourceWay().isPresent() && sourceWayPanel.copyTags(); + } + + public boolean deleteSourceWay() { + return inputData.getSourceWay().isPresent() && sourceWayPanel.deleteSourceWay(); + } +} diff --git a/src/nl/jeroenhoek/josm/gridify/ui/OperationChooser.java b/src/nl/jeroenhoek/josm/gridify/ui/OperationChooser.java new file mode 100644 index 0000000..c1e179c --- /dev/null +++ b/src/nl/jeroenhoek/josm/gridify/ui/OperationChooser.java @@ -0,0 +1,41 @@ +// License: GPL. For details, see LICENSE file. +package nl.jeroenhoek.josm.gridify.ui; + +import nl.jeroenhoek.josm.gridify.Operation; + +import javax.swing.BoxLayout; +import javax.swing.ButtonGroup; +import javax.swing.JPanel; +import javax.swing.JRadioButton; + +/** + * UI widget for choosing the {@link Operation} to perform. + */ +public class OperationChooser extends JPanel { + private Operation selected; + + public OperationChooser(Operation defaultOperation) { + setLayout(new BoxLayout(this, BoxLayout.Y_AXIS)); + + ButtonGroup group = new ButtonGroup(); + selected = defaultOperation; + + for (Operation operation : Operation.values()) { + JRadioButton button = new JRadioButton(operation.toString()); + button.addActionListener(e -> { + if (button.isSelected()) { + selected = operation; + } + }); + if (operation == defaultOperation) { + button.setSelected(true); + } + group.add(button); + add(button); + } + } + + public Operation getSelected() { + return selected; + } +} diff --git a/src/nl/jeroenhoek/josm/gridify/ui/PositiveSpinner.java b/src/nl/jeroenhoek/josm/gridify/ui/PositiveSpinner.java new file mode 100644 index 0000000..a189f74 --- /dev/null +++ b/src/nl/jeroenhoek/josm/gridify/ui/PositiveSpinner.java @@ -0,0 +1,49 @@ +// License: GPL. For details, see LICENSE file. +package nl.jeroenhoek.josm.gridify.ui; + +import javax.swing.JFormattedTextField; +import javax.swing.JSpinner; +import javax.swing.SpinnerNumberModel; +import java.awt.Dimension; +import java.awt.Font; + +/** + * A {@link JSpinner} limited to a range of 1 to 1000. This class also adds a mouse wheel listener allowing users to + * scroll the value up or down. + */ +public class PositiveSpinner extends JSpinner { + public PositiveSpinner(int defaultValue) { + super(new SpinnerNumberModel(defaultValue, 1, 1000, 1)); + JFormattedTextField field = ((DefaultEditor) getEditor()).getTextField(); + field.setColumns(3); + field.setFont(new Font("Monospaced", Font.PLAIN, 18)); + + // Kind of weird that the default JSpinner doesn't do this. + addMouseWheelListener(e -> { + int ticks = e.getWheelRotation(); + Object newValue = null; + if (ticks > 0) { + for (int tick = 0; tick < ticks; tick++) { + Object previous = getPreviousValue(); + if (previous == null) break; + newValue = previous; + } + } else if (ticks < 0) { + for (int tick = 0; tick > ticks; tick--) { + Object next = getNextValue(); + if (next == null) break; + newValue = next; + } + } + + if (newValue != null) { + setValue(newValue); + } + }); + } + + @Override + public Dimension getMaximumSize() { + return getPreferredSize(); + } +} diff --git a/src/nl/jeroenhoek/josm/gridify/ui/Preview.java b/src/nl/jeroenhoek/josm/gridify/ui/Preview.java new file mode 100644 index 0000000..974a8a4 --- /dev/null +++ b/src/nl/jeroenhoek/josm/gridify/ui/Preview.java @@ -0,0 +1,266 @@ +// License: GPL. For details, see LICENSE file. +package nl.jeroenhoek.josm.gridify.ui; + +import nl.jeroenhoek.josm.gridify.GridExtrema; +import nl.jeroenhoek.josm.gridify.GridExtrema.Dimensions; +import nl.jeroenhoek.josm.gridify.ui.GridSizePanel.Nudge; +import org.openstreetmap.josm.data.coor.EastNorth; +import org.openstreetmap.josm.data.osm.Node; + +import javax.swing.JPanel; +import java.awt.Color; +import java.awt.Dimension; +import java.awt.Graphics; +import java.awt.Graphics2D; +import java.awt.RenderingHints; +import java.awt.image.BufferedImage; +import java.util.ArrayList; +import java.util.List; +import java.util.function.BiConsumer; + +import static java.awt.event.InputEvent.CTRL_DOWN_MASK; +import static java.awt.event.InputEvent.SHIFT_DOWN_MASK; + +/** + * UI widget that shows an abstracted live preview of the operation to be performed. Because shapes are rarely neatly + * aligned to the cardinal directions of the compass, terms like 'rows' and 'columns' become rather abstract. So to + * prevent confusion, we simply show the user how his grid will be divided. + *

+ * The preview panel is updated whenever the values held by the {@link GridSizePanel} are changed. + */ +public class Preview extends JPanel { + final int CANVAS_SIZE = 280; + final int PADDING = 10; + + final Dimension size = new Dimension(CANVAS_SIZE + 2 * PADDING, CANVAS_SIZE + 2 * PADDING); + + Grid grid; + + public Preview(GridExtrema gridExtrema, GridifySettingsDialog settingsDialog) { + Dimensions dimensions = gridExtrema.getDimensions(); + + // Compute the multiplication factor and offsets that convert between EastNorth and local preview canvas + // coordinates. + double longestDistance = dimensions.longestOfWidthAndHeight(); + double fraction = CANVAS_SIZE / longestDistance; + + double offsetX = (longestDistance - (dimensions.getMaxX() - dimensions.getMinX())) / 2.0; + double offsetY = (longestDistance - (dimensions.getMaxY() - dimensions.getMinY())) / 2.0; + + grid = new Grid( + toCanvasCoordinates(dimensions, fraction, offsetX, offsetY, gridExtrema.getNodeOne()), + toCanvasCoordinates(dimensions, fraction, offsetX, offsetY, gridExtrema.getNodeTwo()), + toCanvasCoordinates(dimensions, fraction, offsetX, offsetY, gridExtrema.getNodeThree()), + toCanvasCoordinates(dimensions, fraction, offsetX, offsetY, gridExtrema.getNodeFour()) + ); + grid.setRows(settingsDialog.getRowCount()); + grid.setColumns(settingsDialog.getColumnCount()); + + // Allow users to adjust the row/column count by using the mouse wheel on top of the preview. + // This is just an extra; the two spinners are the more visible way of adjusting the row and + // column count. + addMouseWheelListener(e -> { + int ticks = e.getWheelRotation(); + int modifiers = e.getModifiersEx(); + // Only if shift is down (but not ctrl). + boolean doOnlyRows = (modifiers & (SHIFT_DOWN_MASK | CTRL_DOWN_MASK)) == SHIFT_DOWN_MASK; + // Only if ctrl is down (but not shift). + boolean doOnlyColumns = (modifiers & (SHIFT_DOWN_MASK | CTRL_DOWN_MASK)) == CTRL_DOWN_MASK; + if (ticks > 0) { + for (int tick = 0; tick < ticks; tick++) { + if (doOnlyRows) { + settingsDialog.nudgeRowCount(Nudge.DECREMENT); + } else if (doOnlyColumns) { + settingsDialog.nudgeColumnCount(Nudge.DECREMENT); + } else { + settingsDialog.nudgeRowCount(Nudge.DECREMENT); + settingsDialog.nudgeColumnCount(Nudge.DECREMENT); + } + } + } else if (ticks < 0) { + for (int tick = 0; tick > ticks; tick--) { + if (doOnlyRows) { + settingsDialog.nudgeRowCount(Nudge.INCREMENT); + } else if (doOnlyColumns) { + settingsDialog.nudgeColumnCount(Nudge.INCREMENT); + } else { + settingsDialog.nudgeRowCount(Nudge.INCREMENT); + settingsDialog.nudgeColumnCount(Nudge.INCREMENT); + } + } + } + }); + } + + @Override + public Dimension getMinimumSize() { + return size; + } + + @Override + public Dimension getPreferredSize() { + return size; + } + + @Override + public void paintComponent(Graphics g) { + super.paintComponent(g); + + // Use a BufferedImage to enable drawing anti-aliased lines. + BufferedImage image = new BufferedImage( + CANVAS_SIZE + 2 * PADDING, + CANVAS_SIZE + 2 * PADDING, + BufferedImage.TYPE_INT_RGB); + Graphics2D ig = image.createGraphics(); + + ig.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON); + + // Background. + ig.setColor(Color.BLACK); + ig.fillRect(0, 0, 300, 300); + + // Draw the grid. + ig.setColor(Color.RED); + grid.withLines((start, stop) -> ig.drawLine(start.x, start.y, stop.x, stop.y)); + + g.drawImage(image, 0, 0, this); + } + + public void updateRowsColumns(int rows, int columns) { + this.grid.setRows(rows); + this.grid.setColumns(columns); + repaint(); + } + + /** + * Turn {@link EastNorth} coordinates into our local integer coordinates for the preview canvas. + * + * @param dimensions Bounding box used to determine the scaling factor. + * @param fraction Scaling factor. + * @param offsetX X offset (to centre the grid in the preview canvas). + * @param offsetY Y offset (to centre the grid in the preview canvas). + * @param node Node to convert. + * @return Local preview canvas coordinates. + */ + Coordinates toCanvasCoordinates(Dimensions dimensions, + double fraction, + double offsetX, + double offsetY, + Node node) { + EastNorth eastNorth = node.getEastNorth(); + double x = eastNorth.getX(); + double y = eastNorth.getY(); + + Coordinates coordinates = new Coordinates(); + + x -= dimensions.getMinX(); + y -= dimensions.getMinY(); + + x += offsetX; + y += offsetY; + + x *= fraction; + y *= fraction; + + coordinates.x = PADDING + (int) Math.round(x); + // The y coordinates are 'upside down'. + coordinates.y = (CANVAS_SIZE - (int) Math.round(y)) + PADDING; + + return coordinates; + } + + /** + * Simple integer coordinate pair. + */ + public static class Coordinates { + int x; + int y; + + @Override + public String toString() { + return "x=" + x + ", y=" + y; + } + } + + /** + * Representation of the grid the user wants to generate. The four coordinates specified in a clockwise order. + */ + public static class Grid { + Coordinates one; + Coordinates two; + Coordinates three; + Coordinates four; + + int rows; + int columns; + + public Grid(Coordinates one, Coordinates two, Coordinates three, Coordinates four) { + this.one = one; + this.two = two; + this.three = three; + this.four = four; + } + + /** + * Perform an operation on each line of the grid. + * + * @param consumer Consumer that receives two coordinate pairs for each line of the grid, both rows and columns. + */ + void withLines(BiConsumer consumer) { + List top = range(one, two, columns); + List bottom = range(four, three, columns); + List left = range(one, four, rows); + List right = range(two, three, rows); + + // All columns. + for (int i = 0; i < top.size(); i++) { + consumer.accept(top.get(i), bottom.get(i)); + } + // All rows. + for (int i = 0; i < left.size(); i++) { + consumer.accept(left.get(i), right.get(i)); + } + } + + /** + * Generate a list of coordinates representing a number of points evenly distributed along a line. + * + * @param a Start of the line. + * @param b End of the line. + * @param n Number of point to add to the line. + * @return A list of coordinates, including the start and end of the line. + */ + private List range(Coordinates a, Coordinates b, int n) { + List points = new ArrayList<>(); + points.add(a); + + if (n > 1) { + float dx = (b.x - a.x) / (float) n; + float dy = (b.y - a.y) / (float) n; + + for (int i = 1; i < n; i++) { + Coordinates between = new Coordinates(); + between.x = a.x + (Math.round(dx * i)); + between.y = a.y + (Math.round(dy * i)); + points.add(between); + } + } + + points.add(b); + return points; + } + + public void setRows(int rows) { + this.rows = rows; + } + + public void setColumns(int columns) { + this.columns = columns; + } + + @Override + public String toString() { + return one + "|" + two + "|" + three + "|" + four; + } + } +} diff --git a/src/nl/jeroenhoek/josm/gridify/ui/SourceWayPanel.java b/src/nl/jeroenhoek/josm/gridify/ui/SourceWayPanel.java new file mode 100644 index 0000000..f5503b6 --- /dev/null +++ b/src/nl/jeroenhoek/josm/gridify/ui/SourceWayPanel.java @@ -0,0 +1,50 @@ +// License: GPL. For details, see LICENSE file. +package nl.jeroenhoek.josm.gridify.ui; + +import org.openstreetmap.josm.data.osm.Way; + +import javax.swing.BoxLayout; +import javax.swing.JCheckBox; +import javax.swing.JPanel; + +import static org.openstreetmap.josm.tools.I18n.tr; + +/** + * UI widget that shows options relating to the {@link Way} the user selected. + */ +public class SourceWayPanel extends JPanel { + private final JCheckBox copyTagsButton; + private final JCheckBox deleteSourceWayButton; + + public SourceWayPanel(boolean copyTags, boolean deleteSourceWay) { + setLayout(new BoxLayout(this, BoxLayout.Y_AXIS)); + + copyTagsButton = new JCheckBox(tr("Copy tags from source way")); + copyTagsButton.setSelected(copyTags); + + add(copyTagsButton); + + deleteSourceWayButton = new JCheckBox(tr("Delete source way")); + deleteSourceWayButton.setSelected(deleteSourceWay); + + add(deleteSourceWayButton); + } + + /** + * Should the tags from the source way be reused? + * + * @return True, if the tags should be copied to the newly generated ways. + */ + public boolean copyTags() { + return copyTagsButton.isSelected(); + } + + /** + * Should the source way be deleted? + * + * @return True if the user wants the source to be deleted. + */ + public boolean deleteSourceWay() { + return deleteSourceWayButton.isSelected(); + } +}