diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,11 @@ +# Changelog for `waterfall-cad-svg` + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to the +[Haskell Package Versioning Policy](https://pvp.haskell.org/). + +## Unreleased + +## 0.1.0.0 - YYYY-MM-DD diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,502 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +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 this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser 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 Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "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 +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY 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 +LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey 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 library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Waterfall CAD SVG + +![Waterfall CAD](https://raw.githubusercontent.com/joe-warren/opencascade-hs/main/images/logo/waterfall-cad-logo-name.svg) + +This package provides SVG support for Waterfall-CAD. + +Waterfall CAD is a declarative CAD/Solid Modeling library. + +This uses [opencascade-hs](https://hackage.haskell.org/package/opencascade-hs) as the kernel, but provides a "more functional" API over it. + +## Dependencies + +You'll need the main OpenCASCADE libraries/header files installed to use this. + +Please see the [main readme](https://github.com/joe-warren/opencascade-hs/#installing-dependencies) on Github for more information. + +## Examples + +There are examples of how to use the library in [waterfall-cad-examples](https://hackage.haskell.org/package/waterfall-cad-examples). + +You can see images of these examples in the [main readme](https://github.com/joe-warren/opencascade-hs/#examples) on Github. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/src/Waterfall/SVG.hs b/src/Waterfall/SVG.hs new file mode 100644 --- /dev/null +++ b/src/Waterfall/SVG.hs @@ -0,0 +1,17 @@ +{-| +Module: Waterfall.SVG + +This module simply re-exports everything from the various modules +that make up the waterfall-cad-svg package. +-} +module Waterfall.SVG +( +-- | Load SVG Data into "Waterfall" data types + module Waterfall.SVG.FromSVG +-- | Convert "Waterfall" data types to SVG +, module Waterfall.SVG.ToSVG +) where + +import Waterfall.SVG.FromSVG +import Waterfall.SVG.ToSVG + diff --git a/src/Waterfall/SVG/FromSVG.hs b/src/Waterfall/SVG/FromSVG.hs new file mode 100644 --- /dev/null +++ b/src/Waterfall/SVG/FromSVG.hs @@ -0,0 +1,327 @@ +{-| +Load [SVG Data](https://developer.mozilla.org/en-US/docs/Web/SVG) into `Waterfall.Path2D` +-} +module Waterfall.SVG.FromSVG +( SVGErrorKind (..) +, SVGError (..) +, convertPathCommands +, parsePath +, convertTransform +, convertTree +, convertDocument +, readSVG +) where + +import qualified Waterfall +import qualified Data.Attoparsec.Text as Atto +import Graphics.Svg.PathParser (pathParser) +import qualified Graphics.Svg as Svg +import qualified Data.Text as T +import Linear (V3 (..), V2 (..), zero, Metric (norm), normalize, (^*), (*^), _x, _y, unit) +import Control.Lens ((^.), ala, each) +import Data.Monoid (Endo (..)) +import Control.Arrow (second) +import Data.Foldable (foldl') +import Control.Monad (join, (<=<)) +import Data.Maybe (catMaybes) +import Data.Function ((&)) + +-- | Categories of error that may occur when processing an SVG +data SVGErrorKind = SVGIOError | SVGParseError | SVGPathError | SVGTransformError | SVGNumberError + deriving (Eq, Ord, Show) + +-- | Type representing an error that occured when processing an SVG +data SVGError = SVGError SVGErrorKind String + deriving (Eq, Ord, Show) + +uncurry6 :: (a -> b -> c -> d -> e -> f -> g) -> (a, b, c, d, e, f) -> g +uncurry6 fn (a, b, c, d, e, f) = fn a b c d e f + +pathFromToWithControlPoint :: [Maybe (V2 Double) -> V2 Double -> Either SVGError (Maybe (V2 Double), (V2 Double, Waterfall.Path2D))] -> V2 Double -> Either SVGError (V2 Double, Waterfall.Path2D) +pathFromToWithControlPoint commands start = + let go (cp, (pos, paths)) cmd = second (second (:paths)) <$> cmd cp pos + go' b a = join (go <$> b <*> pure a) + in case foldl' go' (Right (Nothing, (start, []))) commands of + Right (_cp, (end, allPaths)) -> Right (end, mconcat . reverse $ allPaths) + Left err -> Left err + +ellipseToRelative :: Double -> Double -> Double -> Bool -> Bool -> V2 Double -> V2 Double -> (V2 Double, Waterfall.Path2D) +ellipseToRelative rx ry angleDeg largeArcFlag sweepFlag relativeEnd = + let angleRads = angleDeg * pi / 180 + scaleFac = ry / rx + transformForward :: Waterfall.Transformable2D a => a -> a + transformForward = Waterfall.rotate2D (angleRads) . Waterfall.scale2D (V2 (1/scaleFac) 1) + transformBack :: Waterfall.Transformable2D a => a -> a + transformBack = Waterfall.scale2D (V2 (scaleFac) 1) . Waterfall.rotate2D (-angleRads) + relativeEndTransformed@(V2 retX retY) = transformBack relativeEnd + transformedDistance = norm relativeEndTransformed + halfTD = transformedDistance * 0.5 + perp = normalize (V2 (-retY) retX) + p1 = if sweepFlag == largeArcFlag then negate perp else perp + p2 = if largeArcFlag then p1 else negate p1 + radius = max ry halfTD + centerPerpDistance = sqrt (radius * radius - halfTD * halfTD) + center = (relativeEndTransformed ^* 0.5) + (p1 ^* centerPerpDistance) + midPoint = center + (p2 ^* radius) + + in Waterfall.splice . transformForward $ Waterfall.arcVia zero midPoint relativeEndTransformed + +quadraticBezierAbsolute :: V2 Double -> V2 Double -> V2 Double -> (V2 Double, Waterfall.Path2D) +quadraticBezierAbsolute p0 p1 p2 = (p2, Waterfall.bezier2D p0 (p0 + ((p1 - p0) ^* (2/3))) (p2 + ((p1 - p2) ^* (2/3))) p2) + +curveToAbsolute :: (V2 Double, V2 Double, V2 Double) -> Maybe (V2 Double) -> V2 Double -> Either SVGError (Maybe (V2 Double), (V2 Double, Waterfall.Path2D)) +curveToAbsolute (cp1, cp2, cp3) _ cp0 = Right (Just (cp3 + cp3 - cp2), Waterfall.bezierTo2D cp1 cp2 cp3 cp0) + +curveToRelative :: (V2 Double, V2 Double, V2 Double) -> Maybe (V2 Double) -> V2 Double -> Either SVGError (Maybe (V2 Double), (V2 Double, Waterfall.Path2D)) +curveToRelative (cp1, cp2, cp3) _ cp0 = curveToAbsolute (cp0 + cp1, cp0 + cp2, cp0 + cp3) Nothing cp0 + +quadraticBezierAbsolute' :: (V2 Double, V2 Double) -> Maybe (V2 Double) -> V2 Double -> Either SVGError (Maybe (V2 Double), (V2 Double, Waterfall.Path2D)) +quadraticBezierAbsolute' (cp1, cp2) _ cp0 = Right (Just (cp2 + cp2 - cp1), quadraticBezierAbsolute cp0 cp1 cp2) + +quadraticBezierRelative' :: (V2 Double, V2 Double) -> Maybe (V2 Double) -> V2 Double -> Either SVGError (Maybe (V2 Double), (V2 Double, Waterfall.Path2D)) +quadraticBezierRelative' (cp1, cp2) _ cp0 = quadraticBezierAbsolute' (cp0 + cp1, cp0 + cp2) Nothing cp0 + +ellipseToAbsolute :: Double -> Double -> Double -> Bool -> Bool -> V2 Double -> V2 Double -> (V2 Double, Waterfall.Path2D) +ellipseToAbsolute rx ry angleDeg largeArcFlag sweepFlag absoluteEnd start = + ellipseToRelative rx ry angleDeg largeArcFlag sweepFlag (absoluteEnd - start) start + +smoothCurveToAbsolute :: (V2 Double, V2 Double) -> Maybe (V2 Double) -> V2 Double -> Either SVGError (Maybe (V2 Double), (V2 Double, Waterfall.Path2D)) +smoothCurveToAbsolute _ Nothing _ = Left (SVGError SVGPathError "S command must follow either an S, s, C or c command") +smoothCurveToAbsolute (cp2, cp3) (Just cp1) cp0 = Right (Just (cp3 + cp3 - cp2), Waterfall.bezierTo2D cp1 cp2 cp3 cp0) + +smoothCurveToRelative :: (V2 Double, V2 Double) -> Maybe (V2 Double) -> V2 Double -> Either SVGError (Maybe (V2 Double), (V2 Double, Waterfall.Path2D)) +smoothCurveToRelative _ Nothing _ = Left (SVGError SVGPathError "s command must follow either an S, s, C or c command") +smoothCurveToRelative (cp2, cp3) cp1 cp0 = smoothCurveToAbsolute (cp0 + cp2, cp0 + cp3) cp1 cp0 + +smoothQuadraticBezierCurveToAbsolute :: V2 Double -> Maybe (V2 Double) -> V2 Double -> Either SVGError (Maybe (V2 Double), (V2 Double, Waterfall.Path2D)) +smoothQuadraticBezierCurveToAbsolute _ Nothing _ = Left (SVGError SVGPathError "T command must follow either an T, t, Q or q command") +smoothQuadraticBezierCurveToAbsolute cp2 (Just cp1) cp0 = Right (Just (cp2 + cp2 - cp1), quadraticBezierAbsolute cp0 cp1 cp2) + +smoothQuadraticBezierCurveToRelative :: V2 Double -> Maybe (V2 Double) -> V2 Double -> Either SVGError (Maybe (V2 Double), (V2 Double, Waterfall.Path2D)) +smoothQuadraticBezierCurveToRelative _ Nothing _ = Left (SVGError SVGPathError "t command must follow either an T, t, Q or q command") +smoothQuadraticBezierCurveToRelative cp2 cp1 cp0 = smoothQuadraticBezierCurveToRelative (cp0 + cp2) cp1 cp0 + +-- | Generate `Waterfall.Path2D`s from a parsed list of `Svg.PathCommand`s. +-- +-- Consective `Svg.PathCommands` will be merged into the same `Waterfall.Path2D` +-- unless either a move command ('m', 'M') or a close path command ('z', 'Z') is encountered. +convertPathCommands :: [Svg.PathCommand] -> Either SVGError [Waterfall.Path2D] +convertPathCommands cs = + let + relativeLocation _ Svg.OriginAbsolute v = v + relativeLocation curPos Svg.OriginRelative v = curPos + v + buildPathInProgress (origin, segments) = + pathFromToWithControlPoint segments origin + withoutControlPoint f _cp o = Right (Nothing, f o) + go (cmd:rest) pathInProgress@(o, segments) paths = + let goSegment ss = go rest (o, segments <> ss) paths + in case cmd of + (Svg.MoveTo origin (v:vs)) -> + let restPlusImplicitLineTo = + case vs of + [] -> rest + implicitLineTos -> Svg.LineTo origin implicitLineTos : rest + in if null segments + then go restPlusImplicitLineTo (relativeLocation o origin v, []) paths + else case buildPathInProgress pathInProgress of + Right (currentPosition, newPath) -> go restPlusImplicitLineTo (relativeLocation currentPosition origin v, []) (newPath : paths) + Left err -> Left err + (Svg.MoveTo _ []) -> Left (SVGError SVGPathError "Empty MoveTo command") + (Svg.LineTo Svg.OriginAbsolute vs) -> goSegment (withoutControlPoint . Waterfall.lineTo2D <$> vs ) + (Svg.LineTo Svg.OriginRelative vs) -> goSegment (withoutControlPoint . Waterfall.lineRelative2D <$> vs) + (Svg.HorizontalTo Svg.OriginAbsolute ds) -> + let f d v@(V2 _x y) = let v' = V2 d y in (v', Waterfall.line2D v v') + in goSegment (withoutControlPoint . f <$> ds) + (Svg.HorizontalTo Svg.OriginRelative ds) -> + let f d v = let v' = v + V2 d 0 in (v', Waterfall.line2D v v') + in goSegment (withoutControlPoint . f <$> ds) + (Svg.VerticalTo Svg.OriginAbsolute ds) -> + let f d v@(V2 x _y) = let v' = V2 x d in (v', Waterfall.line2D v v') + in goSegment (withoutControlPoint . f <$> ds) + (Svg.VerticalTo Svg.OriginRelative ds) -> + let f d v = let v' = v + V2 0 d in (v', Waterfall.line2D v v') + in goSegment (withoutControlPoint . f <$> ds) + (Svg.CurveTo Svg.OriginAbsolute points) -> goSegment (curveToAbsolute <$> points) + (Svg.CurveTo Svg.OriginRelative points) -> goSegment (curveToRelative <$> points) + (Svg.EllipticalArc Svg.OriginAbsolute points) -> goSegment (withoutControlPoint . uncurry6 ellipseToAbsolute <$> points) + (Svg.EllipticalArc Svg.OriginRelative points) -> goSegment (withoutControlPoint . uncurry6 ellipseToRelative <$> points) + Svg.QuadraticBezier Svg.OriginAbsolute points -> goSegment (quadraticBezierAbsolute' <$> points) + Svg.QuadraticBezier Svg.OriginRelative points -> goSegment (quadraticBezierRelative' <$> points) + Svg.SmoothCurveTo Svg.OriginAbsolute points -> goSegment (smoothCurveToAbsolute <$> points) + Svg.SmoothCurveTo Svg.OriginRelative points -> goSegment (smoothCurveToRelative <$> points) + Svg.SmoothQuadraticBezierCurveTo Svg.OriginAbsolute points -> goSegment (smoothQuadraticBezierCurveToAbsolute <$> points) + Svg.SmoothQuadraticBezierCurveTo Svg.OriginRelative points -> goSegment (smoothQuadraticBezierCurveToRelative <$> points) + Svg.EndPath -> + if null segments + then go rest (o, []) paths + else case buildPathInProgress pathInProgress of + Right (_, newPath) -> go rest (o, []) (Waterfall.closeLoop newPath : paths) + Left err -> Left err + go [] pathInProgress@(_o, segments) paths = + if null segments + then Right paths + else (:paths) . snd <$> buildPathInProgress pathInProgress + in reverse <$> go cs (zero, []) [] + +-- | Parse [SVG Path data](https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths) +-- and convert it into a `Path2D` +parsePath :: String -> Either SVGError [Waterfall.Path2D] +parsePath s = + case Atto.parseOnly (pathParser <* Atto.endOfInput) (T.pack s) of + Right r -> convertPathCommands r + Left msg -> Left (SVGError SVGParseError msg) + +-- | Parse a `Svg.Transformation` into a function that can be applied to +-- any Waterfall type with a `Waterfall.Transformable2D` instance +-- +-- This should handle every case except for `TransformUnknown` +convertTransform :: Waterfall.Transformable2D a => Svg.Transformation -> Either SVGError (a -> a) +convertTransform (Svg.TransformMatrix a b c d e f) = Right $ Waterfall.matTransform2D (V2 (V3 a c e) (V3 b d f)) +convertTransform (Svg.Translate x y) = Right $ Waterfall.translate2D (V2 x y) +convertTransform (Svg.Scale v Nothing) = Right $ Waterfall.uScale2D v +convertTransform (Svg.Scale x (Just y)) = Right $ Waterfall.scale2D (V2 x y) +convertTransform (Svg.Rotate angleDeg center) = + let center' = maybe zero (uncurry V2) center + fwd = Waterfall.translate2D (negate center') + angleRad = angleDeg * pi / 180 + back = Waterfall.translate2D center' + in Right (back . Waterfall.rotate2D angleRad . fwd) +convertTransform (Svg.SkewX x) = Right $ Waterfall.matTransform2D (V2 (V3 x 0 0) (V3 0 1 0)) +convertTransform (Svg.SkewY y) = Right $ Waterfall.matTransform2D (V2 (V3 1 0 0) (V3 0 y 0)) +convertTransform Svg.TransformUnknown = Left . (SVGError SVGTransformError) $ "Unknown Transform" + +chain :: [a -> a] -> a -> a +chain = ala Endo foldMap + +svgDPI :: Svg.Dpi +svgDPI = 300 + +convertNumber :: Svg.Number -> Either SVGError Double +convertNumber n = + -- toUserUnit should guarantee we either get a Num, Em, or Percent value here + -- of which only Num is supported + case Svg.toUserUnit svgDPI n of + Svg.Num v -> Right v + Svg.Px _ -> Left (SVGError SVGNumberError "Unexpected Px value") + Svg.Em _ -> Left (SVGError SVGNumberError "Unsupported Em value") + Svg.Percent _ -> Left (SVGError SVGNumberError "Unsupported Percent value") + Svg.Pc _ -> Left (SVGError SVGNumberError "Unexpected Pc value") + Svg.Inches _ -> Left (SVGError SVGNumberError "Unexpected Inches value") + Svg.Mm _ -> Left (SVGError SVGNumberError "Unexpected Mm value") + Svg.Cm _ -> Left (SVGError SVGNumberError "Unexpected Cm value") + Svg.Point _ -> Left (SVGError SVGNumberError "Unexpected Point value") + + +convertPoint :: Svg.Point -> Either SVGError (V2 Double) +convertPoint = fmap (uncurry V2) . each convertNumber + +convertCircle :: Svg.Circle -> Either SVGError [Waterfall.Path2D] +convertCircle circle = do + center <- convertPoint (circle ^. Svg.circleCenter) + radius <- circle ^. Svg.circleRadius & convertNumber + return + . fmap (Waterfall.translate2D center . Waterfall.uScale2D radius) + . Waterfall.shapePaths + $ Waterfall.unitCircle + +convertPoints :: [Svg.RPoint] -> [Waterfall.Path2D] +convertPoints (h:t) = pure $ Waterfall.pathFrom h (Waterfall.lineTo <$> t) +convertPoints [] = [] + +convertPolyLine :: Svg.PolyLine -> [Waterfall.Path2D] +convertPolyLine polyLine = convertPoints (polyLine ^. Svg.polyLinePoints) + +wrap :: [a] -> [a] +wrap (h:t) = h:t <> [h] +wrap [] = [] + +convertPolygon :: Svg.Polygon -> [Waterfall.Path2D] +convertPolygon polygon = convertPoints (polygon ^. Svg.polygonPoints & wrap) + +convertLine :: Svg.Line -> Either SVGError Waterfall.Path2D +convertLine line = + Waterfall.line + <$> convertPoint (line ^. Svg.linePoint1) + <*> convertPoint (line ^. Svg.linePoint2) + +convertEllipse :: Svg.Ellipse -> Either SVGError [Waterfall.Path2D] +convertEllipse ellipse = do + center <- convertPoint (ellipse ^. Svg.ellipseCenter) + rX <- ellipse ^. Svg.ellipseXRadius & convertNumber + rY <- ellipse ^. Svg.ellipseYRadius & convertNumber + return + . fmap (Waterfall.translate2D center . Waterfall.scale2D (V2 rX rY)) + . Waterfall.shapePaths + $ Waterfall.unitCircle + +convertRectangle :: Svg.Rectangle -> Either SVGError [Waterfall.Path2D] +convertRectangle rect = do + upperLeft <- convertPoint (rect ^. Svg.rectUpperLeftCorner) + (rX', rY') <- each convertNumber (rect ^. Svg.rectCornerRadius) + w <- convertNumber (rect ^. Svg.rectWidth) + h <- convertNumber (rect ^. Svg.rectHeight) + let rX = min rX' (w/2) + let rY = min rY' (h/2) + let w' = w - 2 * rX + let h' = h - 2 * rY + let quarterCircle = Waterfall.arcVia (negate $ unit _y) (normalize (V2 1 (-1))) (unit _x) + let scaleBevel = Waterfall.scale2D (V2 rX rY) + if rX == 0 || rY == 0 + then Waterfall.unitSquare & + Waterfall.scale2D (V2 w h) & + Waterfall.translate2D upperLeft & + Waterfall.shapePaths & + return + else return . pure . Waterfall.pathFrom (V2 rX 0) . catMaybes $ + [ if w' > 0 then Just (Waterfall.lineRelative (w' *^ unit _x)) else Nothing + , quarterCircle + & scaleBevel + & Waterfall.splice + & pure + , if h' > 0 then Just (Waterfall.lineRelative (h' *^ unit _y)) else Nothing + , quarterCircle + & Waterfall.rotate2D (pi/2) + & scaleBevel + & Waterfall.splice + & pure + , if w' > 0 then Just (Waterfall.lineRelative (negate (w' *^ unit _x))) else Nothing + , quarterCircle + & Waterfall.rotate2D pi + & scaleBevel + & Waterfall.splice + & pure + , if h' > 0 then Just (Waterfall.lineRelative (negate (h' *^ unit _y))) else Nothing + , quarterCircle + & Waterfall.rotate2D (-pi/2) + & scaleBevel + & Waterfall.splice + & pure + ] + +-- | Recursively convert an `Svg.Tree` into a list of `Waterfall.Path2D`s +-- +-- Text elements are not supported +convertTree :: Svg.Tree -> Either SVGError [Waterfall.Path2D] +convertTree tree = do + transform <- maybe (pure id) (fmap chain . traverse convertTransform) (tree ^. Svg.drawAttr . Svg.drawAttributes . Svg.transform) + fmap transform <$> case tree of + Svg.PathTree path -> convertPathCommands (path ^. Svg.pathDefinition) + Svg.GroupTree group -> mconcat <$> traverse convertTree (group ^. Svg.groupChildren) + Svg.SymbolTree sym -> mconcat <$> traverse convertTree (sym ^. Svg.groupOfSymbol . Svg.groupChildren) + Svg.CircleTree circle -> convertCircle circle + Svg.PolyLineTree polyLine -> pure $ convertPolyLine polyLine + Svg.PolygonTree polygon -> pure $ convertPolygon polygon + Svg.LineTree line -> pure <$> convertLine line + Svg.EllipseTree ellipse -> convertEllipse ellipse + Svg.RectangleTree rectangle -> convertRectangle rectangle + _ -> Right [] + +-- | Convert an `Svg.Document` into a list of `Path2Ds` +convertDocument :: Svg.Document -> Either SVGError [Waterfall.Path2D] +convertDocument doc = fmap mconcat . traverse convertTree $ (doc ^. Svg.elements) + +-- | Load an SVG file into a `Waterfall.Path2D` +readSVG :: FilePath -> IO (Either SVGError [Waterfall.Path2D]) +readSVG path = + let fileReadErr = Left . SVGError SVGIOError $ "Failed to read svg from file: " <> path + in ( convertDocument <=< maybe fileReadErr Right) <$> Svg.loadSvgFile path diff --git a/src/Waterfall/SVG/ToSVG.hs b/src/Waterfall/SVG/ToSVG.hs new file mode 100644 --- /dev/null +++ b/src/Waterfall/SVG/ToSVG.hs @@ -0,0 +1,177 @@ +{-# Language OverloadedStrings #-} +{-| +Convert "Waterfall" data into [SVG](https://developer.mozilla.org/en-US/docs/Web/SVG) +-} +module Waterfall.SVG.ToSVG +( path2DToPathCommands +, diagramToSvg +, writeDiagramSVG +) where + +import qualified Waterfall +import qualified Graphics.Svg as Svg +import qualified Graphics.Svg.CssTypes as Svg.Css +import Linear (_xy, _x, _y) +import Control.Lens ((^.), (&), (.~)) +import Foreign.Ptr (Ptr) +import Control.Monad ((<=<)) +import Control.Monad.IO.Class (liftIO) +import Waterfall.TwoD.Internal.Path2D (Path2D (..)) +import Waterfall.Internal.FromOpenCascade (gpPntToV3) +import qualified Waterfall.Internal.Path.Common as Internal.Path.Common +import qualified Waterfall.Internal.Edges as Internal.Edges +import qualified Waterfall.Internal.Finalizers as Internal.Finalizers +import qualified OpenCascade.TopoDS as TopoDS +import qualified OpenCascade.BRepAdaptor.Curve as BRepAdaptor.Curve +import qualified OpenCascade.Geom as Geom +import qualified OpenCascade.GeomAbs.CurveType as GeomAbs.CurveType +import qualified OpenCascade.Geom.BezierCurve as Geom.BezierCurve +import qualified OpenCascade.Geom.BSplineCurve as Geom.BSplineCurve +import qualified OpenCascade.GeomAbs.Shape as GeomAbs.Shape +import qualified OpenCascade.GeomConvert.BSplineCurveToBezierCurve as GeomConvert.BSplineCurveToBezierCurve +import qualified OpenCascade.GeomConvert.ApproxCurve as GeomConvert.ApproxCurve +import qualified OpenCascade.ShapeConstruct.Curve as ShapeConstruct.Curve +import qualified OpenCascade.BRep.Tool as BRep.Tool +import OpenCascade.Handle (Handle) +import OpenCascade.Inheritance (upcast) +import Data.Acquire (Acquire) +import Codec.Picture.Types (PixelRGBA8 (..)) + +lineToPathCommand :: Ptr TopoDS.Edge -> IO [Svg.PathCommand] +lineToPathCommand edge = do + (s, e) <- Internal.Edges.edgeEndpoints edge + return + [ Svg.MoveTo Svg.OriginAbsolute . pure $ s ^. _xy + , Svg.LineTo Svg.OriginAbsolute . pure $ e ^. _xy + ] + +bezierCurveToPathCommand :: Ptr TopoDS.Edge -> Ptr (Handle Geom.BezierCurve) -> Acquire [Svg.PathCommand] +bezierCurveToPathCommand edge bezier = do + isRational <- liftIO $ Geom.BezierCurve.isRational bezier + nbPoles <- liftIO $ Geom.BezierCurve.nbPoles bezier + if nbPoles > 4 || isRational + then liftIO $ discretizedEdgePathCommand edge + else do + poles <- traverse ((liftIO . gpPntToV3) <=< Geom.BezierCurve.pole bezier) [1..nbPoles] + case poles of + [s, e] -> return + [ Svg.MoveTo Svg.OriginAbsolute . pure $ s ^. _xy + , Svg.LineTo Svg.OriginAbsolute . pure $ e ^. _xy + ] + [s, cp, e] -> return + [ Svg.MoveTo Svg.OriginAbsolute . pure $ s ^. _xy + , Svg.QuadraticBezier Svg.OriginAbsolute . pure $ (cp ^. _xy, e ^. _xy) + ] + [s, cp1, cp2, e] -> return + [ Svg.MoveTo Svg.OriginAbsolute . pure $ s ^. _xy + , Svg.CurveTo Svg.OriginAbsolute . pure $ (cp1 ^. _xy, cp2 ^. _xy, e ^. _xy) + ] + _ -> liftIO $ discretizedEdgePathCommand edge + +bezierToPathCommand :: Ptr TopoDS.Edge -> Ptr BRepAdaptor.Curve.Curve -> Acquire [Svg.PathCommand] +bezierToPathCommand edge curve = do + firstParam <- liftIO $ BRep.Tool.curveParamFirst edge + lastParam <- liftIO $ BRep.Tool.curveParamLast edge + bezier <- BRepAdaptor.Curve.bezier curve + liftIO $ Geom.BezierCurve.segment bezier firstParam lastParam + bezierCurveToPathCommand edge bezier + +convertBSpline :: Ptr TopoDS.Edge -> Ptr (Handle Geom.BSplineCurve) -> Acquire [Svg.PathCommand] +convertBSpline edge someBSpline = do + converter <- GeomConvert.BSplineCurveToBezierCurve.fromHandle someBSpline -- ParametersAndTolerance someBSpline firstParameter lastParameter 1e-3 + nbArcs <- liftIO $ GeomConvert.BSplineCurveToBezierCurve.nbArcs converter + mconcat <$> traverse (bezierCurveToPathCommand edge <=< GeomConvert.BSplineCurveToBezierCurve.arc converter) [1 .. nbArcs] + +approximateCurveToPathCommand :: Ptr TopoDS.Edge -> Acquire [Svg.PathCommand] +approximateCurveToPathCommand edge = do + gc <- BRep.Tool.curve edge + firstParam <- liftIO $ BRep.Tool.curveParamFirst edge + lastParam <- liftIO $ BRep.Tool.curveParamLast edge + scc <- ShapeConstruct.Curve.new + curve <- ShapeConstruct.Curve.convertToBSpline scc gc firstParam lastParam 1e-3 + preciseBSplineToPathCommand edge curve + +preciseBSplineToPathCommand :: Ptr TopoDS.Edge -> Ptr (Handle Geom.BSplineCurve)-> Acquire [Svg.PathCommand] +preciseBSplineToPathCommand edge curve = do + nbPoles <- liftIO $ Geom.BSplineCurve.nbPoles curve + isRational <- liftIO $ Geom.BSplineCurve.isRational curve + let needsApproximating = (nbPoles > 4 || isRational) + if not needsApproximating + then convertBSpline edge curve + else do + approximator <- GeomConvert.ApproxCurve.fromCurveToleranceOrderSegmentsAndDegree (upcast curve) 1e-3 GeomAbs.Shape.C0 100 3 + done <- liftIO $ GeomConvert.ApproxCurve.isDone approximator + if done + then do + newCurve <- GeomConvert.ApproxCurve.curve approximator + convertBSpline edge newCurve + else + liftIO $ discretizedEdgePathCommand edge + +discretizedEdgePathCommand :: Ptr TopoDS.Edge -> IO [Svg.PathCommand] +discretizedEdgePathCommand edge = do + s <- Internal.Edges.edgeValue edge 0 + ps <- traverse (Internal.Edges.edgeValue edge . (/10) . fromIntegral) [1..(10::Integer)] + return + [ Svg.MoveTo Svg.OriginAbsolute . pure $ s ^. _xy + , Svg.LineTo Svg.OriginAbsolute $ (^. _xy) <$> ps + ] + +edgeToPathCommand :: Ptr TopoDS.Edge -> [Svg.PathCommand] +edgeToPathCommand edge = Internal.Finalizers.unsafeFromAcquire $ do + adaptor <- BRepAdaptor.Curve.fromEdge edge + curveType <- liftIO $ BRepAdaptor.Curve.curveType adaptor + case curveType of + GeomAbs.CurveType.Line -> liftIO $ lineToPathCommand edge + GeomAbs.CurveType.BezierCurve -> bezierToPathCommand edge adaptor + -- GeomAbs.CurveType.BSplineCurve -> There's some argument for special casing this, but we don't need to + _ -> approximateCurveToPathCommand edge + +-- | Convert a `Waterfall.Path2D` into a list of `Svg.PathCommands` +path2DToPathCommands :: Waterfall.Path2D -> [Svg.PathCommand] +path2DToPathCommands (Path2D theRawPath) = case theRawPath of + Internal.Path.Common.EmptyRawPath -> [] + Internal.Path.Common.SinglePointRawPath _ -> [] + Internal.Path.Common.ComplexRawPath wire -> + Internal.Finalizers.unsafeFromAcquireT $ + foldMap edgeToPathCommand <$> Internal.Edges.wireEdges wire + +-- | Convert a `Waterfall.Diagram` into an SVG document +-- +-- The diagram paths have the classes "edge", "visible"/"hidden" and "sharp"/"outline" +diagramToSvg :: Waterfall.Diagram -> Svg.Document +diagramToSvg diagram = + case Waterfall.diagramBoundingBox diagram of + Nothing -> Svg.Document Nothing Nothing Nothing [] mempty mempty mempty mempty + Just (lo, hi) -> + let w = Just . Svg.Num $ (hi - lo) ^. _x + 4 + h = Just . Svg.Num $ (hi - lo) ^. _y + 4 + d' = Waterfall.translate2D (2 + negate lo) diagram + paths lt visibility = + path2DToPathCommands =<< + Waterfall.diagramLines lt visibility d' + styles = + [ Svg.Css.CssRule + [[Svg.Css.AllOf [Svg.Css.OfClass "edge"]]] + [Svg.Css.CssDeclaration "fill" [[Svg.Css.CssIdent "None"]]] + , Svg.Css.CssRule + [[Svg.Css.AllOf [Svg.Css.OfClass "edge", Svg.Css.OfClass "visible"]]] + [Svg.Css.CssDeclaration "stroke" [[Svg.Css.CssColor $ PixelRGBA8 0 0 0 255]]] + , Svg.Css.CssRule + [[Svg.Css.AllOf [Svg.Css.OfClass "edge", Svg.Css.OfClass "hidden"]]] + [Svg.Css.CssDeclaration "stroke" [[Svg.Css.CssColor $ PixelRGBA8 200 200 255 255]]] + ] + document e = Svg.Document Nothing w h [e] mempty mempty styles mempty + drawAttrs classes = mempty + & Svg.attrClass .~ classes + pathOf lt visibility classes = Svg.PathTree $ Svg.Path (drawAttrs classes) (paths lt visibility) + group children = Svg.GroupTree $ Svg.Group mempty children Nothing Svg.defaultSvg + in document . group $ + [ pathOf lineType visibility ["edge", ltClass, vClass] + | (visibility, vClass) <- [(Waterfall.Hidden, "hidden"), (Waterfall.Visible, "visible")] + , (lineType, ltClass) <- [(Waterfall.SharpLine, "sharp"), (Waterfall.OutLine, "outline")] + ] + +-- | Write a `Waterfall.Diagram`, to an SVG file at the specified location +writeDiagramSVG :: FilePath -> Waterfall.Diagram -> IO () +writeDiagramSVG path = Svg.saveXmlFile path . diagramToSvg diff --git a/waterfall-cad-svg.cabal b/waterfall-cad-svg.cabal new file mode 100644 --- /dev/null +++ b/waterfall-cad-svg.cabal @@ -0,0 +1,50 @@ +cabal-version: 1.12 + +-- This file has been generated from package.yaml by hpack version 0.37.0. +-- +-- see: https://github.com/sol/hpack + +name: waterfall-cad-svg +version: 0.5.0.0 +synopsis: Declarative CAD/Solid Modeling Library, SVG Support +description: Please see the README on GitHub at +category: Graphics +homepage: https://github.com/joe-warren/opencascade-hs#readme +bug-reports: https://github.com/joe-warren/opencascade-hs/issues +author: Joe Warren +maintainer: josephmarkwarren@gmail.com +copyright: 2025 Joe Warren +license: LGPL-2.1 +license-file: LICENSE +build-type: Simple +extra-source-files: + LICENSE + README.md + CHANGELOG.md + +source-repository head + type: git + location: https://github.com/joe-warren/opencascade-hs + +library + exposed-modules: + Waterfall.SVG + Waterfall.SVG.FromSVG + Waterfall.SVG.ToSVG + other-modules: + Paths_waterfall_cad_svg + hs-source-dirs: + src + ghc-options: -Wall -Werror=compat -Werror=identities -Werror=incomplete-record-updates -Werror=incomplete-uni-patterns -Werror=missing-home-modules -Werror=missing-export-lists -Werror=partial-fields -Werror=redundant-constraints -optc -Werror-implicit-function-declaration + build-depends: + JuicyPixels ==3.* + , attoparsec >=0.14 && <1.0 + , base >=4.7 && <5 + , lens >5 && <6 + , linear >=1.0 && <2.0 + , opencascade-hs >=0.5.0.0 && <0.6 + , resourcet >=1.2 && <1.4 + , svg-tree >=0.6 && <1.0 + , text >=1.2 && <3.0 + , waterfall-cad >=0.5.0.0 && <0.6 + default-language: Haskell2010