commit 66146c46ba7d8ab5661fa1b46e1a0c4da80da6f1 Author: Simon Brooke Date: Sat May 23 16:20:23 2020 +0100 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d18f225 --- /dev/null +++ b/.gitignore @@ -0,0 +1,12 @@ +/target +/classes +/checkouts +profiles.clj +pom.xml +pom.xml.asc +*.jar +*.class +/.lein-* +/.nrepl-port +.hgignore +.hg/ diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..930da15 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,24 @@ +# Change Log +All notable changes to this project will be documented in this file. This change log follows the conventions of [keepachangelog.com](http://keepachangelog.com/). + +## [Unreleased] +### Changed +- Add a new arity to `make-widget-async` to provide a different widget shape. + +## [0.1.1] - 2020-05-23 +### Changed +- Documentation on how to make the widgets. + +### Removed +- `make-widget-sync` - we're all async, all the time. + +### Fixed +- Fixed widget maker to keep working when daylight savings switches over. + +## 0.1.0 - 2020-05-23 +### Added +- Files from the new template. +- Widget maker public API - `make-widget-sync`. + +[Unreleased]: https://github.com/your-name/walkmap/compare/0.1.1...HEAD +[0.1.1]: https://github.com/your-name/walkmap/compare/0.1.0...0.1.1 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d3087e4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,277 @@ +Eclipse Public License - v 2.0 + + THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE + PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION + OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. + +1. DEFINITIONS + +"Contribution" means: + + a) in the case of the initial Contributor, the initial content + Distributed under this Agreement, and + + b) in the case of each subsequent Contributor: + i) changes to the Program, and + ii) additions to the Program; + where such changes and/or additions to the Program originate from + and are Distributed by that particular Contributor. A Contribution + "originates" from a Contributor if it was added to the Program by + such Contributor itself or anyone acting on such Contributor's behalf. + Contributions do not include changes or additions to the Program that + are not Modified Works. + +"Contributor" means any person or entity that Distributes the Program. + +"Licensed Patents" mean patent claims licensable by a Contributor which +are necessarily infringed by the use or sale of its Contribution alone +or when combined with the Program. + +"Program" means the Contributions Distributed in accordance with this +Agreement. + +"Recipient" means anyone who receives the Program under this Agreement +or any Secondary License (as applicable), including Contributors. + +"Derivative Works" shall mean any work, whether in Source Code or other +form, that is based on (or derived from) the Program and for which the +editorial revisions, annotations, elaborations, or other modifications +represent, as a whole, an original work of authorship. + +"Modified Works" shall mean any work in Source Code or other form that +results from an addition to, deletion from, or modification of the +contents of the Program, including, for purposes of clarity any new file +in Source Code form that contains any contents of the Program. Modified +Works shall not include works that contain only declarations, +interfaces, types, classes, structures, or files of the Program solely +in each case in order to link to, bind by name, or subclass the Program +or Modified Works thereof. + +"Distribute" means the acts of a) distributing or b) making available +in any manner that enables the transfer of a copy. + +"Source Code" means the form of a Program preferred for making +modifications, including but not limited to software source code, +documentation source, and configuration files. + +"Secondary License" means either the GNU General Public License, +Version 2.0, or any later versions of that license, including any +exceptions or additional permissions as identified by the initial +Contributor. + +2. GRANT OF RIGHTS + + a) Subject to the terms of this Agreement, each Contributor hereby + grants Recipient a non-exclusive, worldwide, royalty-free copyright + license to reproduce, prepare Derivative Works of, publicly display, + publicly perform, Distribute and sublicense the Contribution of such + Contributor, if any, and such Derivative Works. + + b) Subject to the terms of this Agreement, each Contributor hereby + grants Recipient a non-exclusive, worldwide, royalty-free patent + license under Licensed Patents to make, use, sell, offer to sell, + import and otherwise transfer the Contribution of such Contributor, + if any, in Source Code or other form. This patent license shall + apply to the combination of the Contribution and the Program if, at + the time the Contribution is added by the Contributor, such addition + of the Contribution causes such combination to be covered by the + Licensed Patents. The patent license shall not apply to any other + combinations which include the Contribution. No hardware per se is + licensed hereunder. + + c) Recipient understands that although each Contributor grants the + licenses to its Contributions set forth herein, no assurances are + provided by any Contributor that the Program does not infringe the + patent or other intellectual property rights of any other entity. + Each Contributor disclaims any liability to Recipient for claims + brought by any other entity based on infringement of intellectual + property rights or otherwise. As a condition to exercising the + rights and licenses granted hereunder, each Recipient hereby + assumes sole responsibility to secure any other intellectual + property rights needed, if any. For example, if a third party + patent license is required to allow Recipient to Distribute the + Program, it is Recipient's responsibility to acquire that license + before distributing the Program. + + d) Each Contributor represents that to its knowledge it has + sufficient copyright rights in its Contribution, if any, to grant + the copyright license set forth in this Agreement. + + e) Notwithstanding the terms of any Secondary License, no + Contributor makes additional grants to any Recipient (other than + those set forth in this Agreement) as a result of such Recipient's + receipt of the Program under the terms of a Secondary License + (if permitted under the terms of Section 3). + +3. REQUIREMENTS + +3.1 If a Contributor Distributes the Program in any form, then: + + a) the Program must also be made available as Source Code, in + accordance with section 3.2, and the Contributor must accompany + the Program with a statement that the Source Code for the Program + is available under this Agreement, and informs Recipients how to + obtain it in a reasonable manner on or through a medium customarily + used for software exchange; and + + b) the Contributor may Distribute the Program under a license + different than this Agreement, provided that such license: + i) effectively disclaims on behalf of all other Contributors all + warranties and conditions, express and implied, including + warranties or conditions of title and non-infringement, and + implied warranties or conditions of merchantability and fitness + for a particular purpose; + + ii) effectively excludes on behalf of all other Contributors all + liability for damages, including direct, indirect, special, + incidental and consequential damages, such as lost profits; + + iii) does not attempt to limit or alter the recipients' rights + in the Source Code under section 3.2; and + + iv) requires any subsequent distribution of the Program by any + party to be under a license that satisfies the requirements + of this section 3. + +3.2 When the Program is Distributed as Source Code: + + a) it must be made available under this Agreement, or if the + Program (i) is combined with other material in a separate file or + files made available under a Secondary License, and (ii) the initial + Contributor attached to the Source Code the notice described in + Exhibit A of this Agreement, then the Program may be made available + under the terms of such Secondary Licenses, and + + b) a copy of this Agreement must be included with each copy of + the Program. + +3.3 Contributors may not remove or alter any copyright, patent, +trademark, attribution notices, disclaimers of warranty, or limitations +of liability ("notices") contained within the Program from any copy of +the Program which they Distribute, provided that Contributors may add +their own appropriate notices. + +4. COMMERCIAL DISTRIBUTION + +Commercial distributors of software may accept certain responsibilities +with respect to end users, business partners and the like. While this +license is intended to facilitate the commercial use of the Program, +the Contributor who includes the Program in a commercial product +offering should do so in a manner which does not create potential +liability for other Contributors. Therefore, if a Contributor includes +the Program in a commercial product offering, such Contributor +("Commercial Contributor") hereby agrees to defend and indemnify every +other Contributor ("Indemnified Contributor") against any losses, +damages and costs (collectively "Losses") arising from claims, lawsuits +and other legal actions brought by a third party against the Indemnified +Contributor to the extent caused by the acts or omissions of such +Commercial Contributor in connection with its distribution of the Program +in a commercial product offering. The obligations in this section do not +apply to any claims or Losses relating to any actual or alleged +intellectual property infringement. In order to qualify, an Indemnified +Contributor must: a) promptly notify the Commercial Contributor in +writing of such claim, and b) allow the Commercial Contributor to control, +and cooperate with the Commercial Contributor in, the defense and any +related settlement negotiations. The Indemnified Contributor may +participate in any such claim at its own expense. + +For example, a Contributor might include the Program in a commercial +product offering, Product X. That Contributor is then a Commercial +Contributor. If that Commercial Contributor then makes performance +claims, or offers warranties related to Product X, those performance +claims and warranties are such Commercial Contributor's responsibility +alone. Under this section, the Commercial Contributor would have to +defend claims against the other Contributors related to those performance +claims and warranties, and if a court requires any other Contributor to +pay any damages as a result, the Commercial Contributor must pay +those damages. + +5. NO WARRANTY + +EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT +PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS" +BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR +IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF +TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR +PURPOSE. Each Recipient is solely responsible for determining the +appropriateness of using and distributing the Program and assumes all +risks associated with its exercise of rights under this Agreement, +including but not limited to the risks and costs of program errors, +compliance with applicable laws, damage to or loss of data, programs +or equipment, and unavailability or interruption of operations. + +6. DISCLAIMER OF LIABILITY + +EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT +PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS +SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, +EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST +PROFITS), 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 OR DISTRIBUTION OF THE PROGRAM OR THE +EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + +7. GENERAL + +If any provision of this Agreement is invalid or unenforceable under +applicable law, it shall not affect the validity or enforceability of +the remainder of the terms of this Agreement, and without further +action by the parties hereto, such provision shall be reformed to the +minimum extent necessary to make such provision valid and enforceable. + +If Recipient institutes patent litigation against any entity +(including a cross-claim or counterclaim in a lawsuit) alleging that the +Program itself (excluding combinations of the Program with other software +or hardware) infringes such Recipient's patent(s), then such Recipient's +rights granted under Section 2(b) shall terminate as of the date such +litigation is filed. + +All Recipient's rights under this Agreement shall terminate if it +fails to comply with any of the material terms or conditions of this +Agreement and does not cure such failure in a reasonable period of +time after becoming aware of such noncompliance. If all Recipient's +rights under this Agreement terminate, Recipient agrees to cease use +and distribution of the Program as soon as reasonably practicable. +However, Recipient's obligations under this Agreement and any licenses +granted by Recipient relating to the Program shall continue and survive. + +Everyone is permitted to copy and distribute copies of this Agreement, +but in order to avoid inconsistency the Agreement is copyrighted and +may only be modified in the following manner. The Agreement Steward +reserves the right to publish new versions (including revisions) of +this Agreement from time to time. No one other than the Agreement +Steward has the right to modify this Agreement. The Eclipse Foundation +is the initial Agreement Steward. The Eclipse Foundation may assign the +responsibility to serve as the Agreement Steward to a suitable separate +entity. Each new version of the Agreement will be given a distinguishing +version number. The Program (including Contributions) may always be +Distributed subject to the version of the Agreement under which it was +received. In addition, after a new version of the Agreement is published, +Contributor may elect to Distribute the Program (including its +Contributions) under the new version. + +Except as expressly stated in Sections 2(a) and 2(b) above, Recipient +receives no rights or licenses to the intellectual property of any +Contributor under this Agreement, whether expressly, by implication, +estoppel or otherwise. All rights in the Program not expressly granted +under this Agreement are reserved. Nothing in this Agreement is intended +to be enforceable by any entity that is not a Contributor or Recipient. +No third-party beneficiary rights are created under this Agreement. + +Exhibit A - Form of Secondary Licenses Notice + +"This Source Code may also be made available under the following +Secondary Licenses when the conditions for such availability set forth +in the Eclipse Public License, v. 2.0 are satisfied: {name license(s), +version(s), and exceptions or additional permissions here}." + + Simply including a copy of this Agreement, including this Exhibit A + is not sufficient to license the Source Code under Secondary Licenses. + + If it is not possible or desirable to put the notice in a particular + file, then You may include the notice in a location (such as a LICENSE + file in a relevant directory) where a recipient would be likely to + look for such a notice. + + You may add additional accurate notices of copyright ownership. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ac7eab7 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# walkmap + +A Clojure library designed to assist in computing walkmaps for games. + +## Introduction + +This library is written in support of work on [The Great Game](), but is separate because it may be of some use in other settings. + +## Usage + +Doesn't work yet + +## License + +Copyright © 2020 FIXME + +This program and the accompanying materials are made available under the +terms of the Eclipse Public License 2.0 which is available at +http://www.eclipse.org/legal/epl-2.0. + +This Source Code may also be made available under the following Secondary +Licenses when the conditions for such availability set forth in the Eclipse +Public License, v. 2.0 are satisfied: GNU General Public License as published by +the Free Software Foundation, either version 2 of the License, or (at your +option) any later version, with the GNU Classpath Exception which is available +at https://www.gnu.org/software/classpath/license.html. diff --git a/doc/intro.md b/doc/intro.md new file mode 100644 index 0000000..cb18f08 --- /dev/null +++ b/doc/intro.md @@ -0,0 +1,3 @@ +# Introduction to walkmap + +TODO: write [great documentation](http://jacobian.org/writing/what-to-write/) diff --git a/project.clj b/project.clj new file mode 100644 index 0000000..0c89cae --- /dev/null +++ b/project.clj @@ -0,0 +1,19 @@ +(defproject walkmap "0.1.0-SNAPSHOT" + :cloverage {:output "docs/cloverage"} + :codox {:metadata {:doc "**TODO**: write docs" + :doc/format :markdown} + :output-path "docs/codox" + :source-uri "https://github.com/simon-brooke/walkmap/blob/master/{filepath}#L{line}"} + :dependencies [[org.clojure/clojure "1.8.0"] + [org.clojure/math.numeric-tower "0.0.4"] + [com.taoensso/timbre "4.10.0"] + [dali "0.7.4"] + [me.raynes/fs "1.4.6"] + [smee/binary "0.5.5"]] + :description "A Clojure library designed to assist in computing walkmaps for games." + :license {:name "EPL-2.0 OR GPL-2.0-or-later WITH Classpath-exception-2.0" + :url "https://www.eclipse.org/legal/epl-2.0/"} + :plugins [[lein-cloverage "1.1.1"] + [lein-codox "0.10.7"]] + :repl-options {:init-ns walkmap.core} + :url "http://example.com/FIXME") diff --git a/resources/isle_of_man.png b/resources/isle_of_man.png new file mode 100644 index 0000000..7de05e9 Binary files /dev/null and b/resources/isle_of_man.png differ diff --git a/resources/isle_of_man.stl b/resources/isle_of_man.stl new file mode 100644 index 0000000..791f4ac Binary files /dev/null and b/resources/isle_of_man.stl differ diff --git a/resources/small_hill.png b/resources/small_hill.png new file mode 100644 index 0000000..8be86e4 Binary files /dev/null and b/resources/small_hill.png differ diff --git a/resources/small_hill.stl b/resources/small_hill.stl new file mode 100644 index 0000000..5594a81 Binary files /dev/null and b/resources/small_hill.stl differ diff --git a/resources/test.heightmap.png b/resources/test.heightmap.png new file mode 100644 index 0000000..0065257 Binary files /dev/null and b/resources/test.heightmap.png differ diff --git a/resources/test.heightmap.stl b/resources/test.heightmap.stl new file mode 100644 index 0000000..031021d Binary files /dev/null and b/resources/test.heightmap.stl differ diff --git a/src/walkmap/BinaryToASCII.py b/src/walkmap/BinaryToASCII.py new file mode 100644 index 0000000..a30ed3a --- /dev/null +++ b/src/walkmap/BinaryToASCII.py @@ -0,0 +1,52 @@ +# -*- encoding: utf-8 -*- +# From https://github.com/IsseiMori/binary-stl-toASCII/blob/master/BinaryToASCII.py +# Included here to sanity check. +import struct + +infile = open('../the-great-game/resources/maps/heightmap.stl') #import file +out = open('ASCII.stl', 'w') #export file + +data = infile.read() + + +out.write("solid ") + +for x in xrange(0,80): + if not ord(data[x]) == 0: + out.write(struct.unpack('c', data[x])[0]) + else: + pass +out.write("\n") + +number = data[80] + data[81] + data[82] + data[83] +faces = struct.unpack('I',number)[0] + +for x in range(0,faces): + out.write("facet normal ") + + xc = data[84+x*50] + data[85+x*50] + data[86+x*50] + data[87+x*50] + yc = data[88+x*50] + data[89+x*50] + data[90+x*50] + data[91+x*50] + zc = data[92+x*50] + data[93+x*50] + data[94+x*50] + data[95+x*50] + + out.write(str(struct.unpack('f',xc)[0]) + " ") + out.write(str(struct.unpack('f',yc)[0]) + " ") + out.write(str(struct.unpack('f',zc)[0]) + "\n") + + out.write("outer loop\n") + + for y in range(1,4): + out.write("vertex ") + + xc = data[84+y*12+x*50] + data[85+y*12+x*50] + data[86+y*12+x*50] + data[87+y*12+x*50] + yc = data[88+y*12+x*50] + data[89+y*12+x*50] + data[90+y*12+x*50] + data[91+y*12+x*50] + zc = data[92+y*12+x*50] + data[93+y*12+x*50] + data[94+y*12+x*50] + data[95+y*12+x*50] + + out.write(str(struct.unpack('f',xc)[0]) + " ") + out.write(str(struct.unpack('f',yc)[0]) + " ") + out.write(str(struct.unpack('f',zc)[0]) + "\n") + + out.write("endloop\n") + out.write("endfacet\n") + +out.close() +print "end" diff --git a/src/walkmap/core.clj b/src/walkmap/core.clj new file mode 100644 index 0000000..b694136 --- /dev/null +++ b/src/walkmap/core.clj @@ -0,0 +1,151 @@ +(ns walkmap.core + (:require [clojure.java.io :as io :refer [file output-stream input-stream]] + [clojure.string :as s] + [dali.io :as svg] + [me.raynes.fs :as fs] + [org.clojars.smee.binary.core :as b] + [taoensso.timbre :as l :refer [info error spy]]) + (:import org.clojars.smee.binary.core.BinaryIO + java.io.DataInput)) + +(def vect + (b/ordered-map + :x :float-le + :y :float-le + :z :float-le)) + +(def facet + (b/ordered-map + :normal vect + :vertices [vect vect vect] + :abc :ushort-le)) + +(def binary-stl + (b/ordered-map + :header (b/string "ISO-8859-1" :length 80) ;; for the time being we neither know nor care what's in this. + :count :uint-le + :facets (b/repeated facet))) + +(defn decode-binary-stl + "Parse a binary STL file from this `filename`." + [filename] + (let [in (io/input-stream filename)] + (b/decode binary-stl in))) + +(defn- vect2str [prefix v] + (str prefix " " (:x v) " " (:y v) " " (:z v) "\n")) + +(defn- facet2str [tri] + (str + (vect2str "facet normal" (:normal tri)) + "outer loop\n" + (apply str + (map + #(vect2str "vertex" %) + (:vertices tri))) + "endloop\nendfacet\n")) + +(defn write-ascii-stl + "Write an `stl` structure as read by `decode-binary-stl` to this + `filename` as ASCII encoded STL." + ([filename stl] + (let [b (fs/base-name filename true)] + (write-ascii-stl + filename stl + (subs b 0 (or (s/index-of b ".") (count b)))))) + ([filename stl solidname] + (l/debug "Solid name is " solidname) + (spit + filename + (str + "solid " + solidname + (s/trim (:header stl)) + "\n" + (apply + str + (map + facet2str + (:facets stl))) + "endsolid " + solidname + "\n")))) + +(defn binary-stl-to-ascii + ([in-filename] + (let [[_ ext] (fs/split-ext in-filename)] + (binary-stl-to-ascii + in-filename + (str + (subs + in-filename + 0 + (or + (s/last-index-of in-filename ".") + (count in-filename))) + ".ascii" + ext)))) + ([in-filename out-filename] + (write-ascii-stl out-filename (decode-binary-stl in-filename)))) + +(def stl (decode-binary-stl "resources/small_hill.stl")) + +(defn facet-to-svg-poly + [facet] + (vec + (cons + :polygon + (map #(vec (list (:x %) (:y %))) (:vertices facet))))) + +(facet-to-svg-poly (first (:facets stl))) + +(defn stl-to-svg + "Convert this in-memory `stl` structure, as read by `decode-binary-stl`, into + an in-memory (Dali) SVG structure, and return it." + [stl] + (let [minx (reduce + min + (map + #(reduce min (map :x (:vertices %))) + (:facets stl))) + maxx (reduce + max + (map + #(reduce max (map :x (:vertices %))) + (:facets stl))) + miny (reduce + min + (map + #(reduce min (map :y (:vertices %))) + (:facets stl))) + maxy (reduce + max + (map + #(reduce max (map :y (:vertices %))) + (:facets stl)))] + [:dali/page + {:width (- maxx minx) + :height (- maxy miny) + :viewBox (s/join " " (map str [minx miny maxx maxy]))} + (vec + (cons + :g + (map + facet-to-svg-poly + (:facets stl))))])) + +(defn binary-stl-file-to-svg + "Given only an `in-filename`, parse the indicated file, expected to be + binary STL, and return an equivalent SVG structure. Given both `in-filename` + and `out-filename`, as side-effect write the SVG to the indicated output file." + ([in-filename] + (stl-to-svg (decode-binary-stl in-filename))) + ([in-filename out-filename] + (let [s (binary-stl-file-to-svg in-filename)] + (svg/render-svg + s + out-filename) + s))) + +(map facet-to-svg-poly (:facets stl)) +(svg/render-svg (stl-to-svg stl) "frobox.svg") diff --git a/test/walkmap/core_test.clj b/test/walkmap/core_test.clj new file mode 100644 index 0000000..2f97186 --- /dev/null +++ b/test/walkmap/core_test.clj @@ -0,0 +1,7 @@ +(ns walkmap.core-test + (:require [clojure.test :refer :all] + [walkmap.core :refer :all])) + +(deftest a-test + (testing "FIXME, I fail." + (is (= 0 1))))