From 66c960604b07b2cc7cf994669a12209b03c6431f Mon Sep 17 00:00:00 2001 From: Michael Ragazzon Date: Wed, 6 Jan 2021 00:42:38 +0100 Subject: [PATCH] Basic implementation of SVG plugin using the lunasvg library --- CMake/FileList.cmake | 13 + CMake/Modules/Findlunasvg.cmake | 27 + CMake/SampleFileList.cmake | 7 + CMake/gen_filelists.sh | 2 + CMake/gen_samplelists.sh | 2 +- CMakeLists.txt | 38 ++ Include/RmlUi/Lottie/ElementLottie.h | 1 - Include/RmlUi/SVG/ElementSVG.h | 95 ++++ Samples/basic/svg/data/LICENSE.txt | 669 ++++++++++++++++++++++++ Samples/basic/svg/data/svg.rml | 25 + Samples/basic/svg/data/tiger.svg | 725 +++++++++++++++++++++++++++ Samples/basic/svg/src/main.cpp | 119 +++++ Samples/readme.md | 3 +- Source/Core/Core.cpp | 7 + Source/SVG/ElementSVG.cpp | 202 ++++++++ Source/SVG/SVGPlugin.cpp | 73 +++ Source/SVG/SVGPlugin.h | 41 ++ readme.md | 7 +- 18 files changed, 2051 insertions(+), 5 deletions(-) create mode 100644 CMake/Modules/Findlunasvg.cmake create mode 100644 Include/RmlUi/SVG/ElementSVG.h create mode 100644 Samples/basic/svg/data/LICENSE.txt create mode 100644 Samples/basic/svg/data/svg.rml create mode 100644 Samples/basic/svg/data/tiger.svg create mode 100644 Samples/basic/svg/src/main.cpp create mode 100644 Source/SVG/ElementSVG.cpp create mode 100644 Source/SVG/SVGPlugin.cpp create mode 100644 Source/SVG/SVGPlugin.h diff --git a/CMake/FileList.cmake b/CMake/FileList.cmake index bcc239fc9..1e4a3a74a 100644 --- a/CMake/FileList.cmake +++ b/CMake/FileList.cmake @@ -590,3 +590,16 @@ set(Lottie_SRC_FILES ${PROJECT_SOURCE_DIR}/Source/Lottie/LottiePlugin.cpp ) +set(SVG_HDR_FILES + ${PROJECT_SOURCE_DIR}/Source/SVG/SVGPlugin.h +) + +set(SVG_PUB_HDR_FILES + ${PROJECT_SOURCE_DIR}/Include/RmlUi/SVG/ElementSVG.h +) + +set(SVG_SRC_FILES + ${PROJECT_SOURCE_DIR}/Source/SVG/ElementSVG.cpp + ${PROJECT_SOURCE_DIR}/Source/SVG/SVGPlugin.cpp +) + diff --git a/CMake/Modules/Findlunasvg.cmake b/CMake/Modules/Findlunasvg.cmake new file mode 100644 index 000000000..0182ba56d --- /dev/null +++ b/CMake/Modules/Findlunasvg.cmake @@ -0,0 +1,27 @@ +# Try to find LunaSVG + +find_path(LUNASVG_INCLUDE_DIR document.h + HINTS $ENV{LUNASVG_DIR} + PATH_SUFFIXES lunasvg lunasvg/include include ) + +find_library(LUNASVG_LIBRARY_DEBUG NAMES lunasvg liblunasvg + HINTS $ENV{LUNASVG_DIR} $ENV{LUNASVG_DIR}/build + PATH_SUFFIXES debug Debug) + +find_library(LUNASVG_LIBRARY_RELEASE NAMES lunasvg liblunasvg + HINTS $ENV{LUNASVG_DIR} $ENV{LUNASVG_DIR}/build + PATH_SUFFIXES release Release) + +set(LUNASVG_LIBRARY + debug ${LUNASVG_LIBRARY_DEBUG} + optimized ${LUNASVG_LIBRARY_RELEASE} +) + +include(FindPackageHandleStandardArgs) +find_package_handle_standard_args(lunasvg DEFAULT_MSG + LUNASVG_LIBRARY LUNASVG_INCLUDE_DIR) + +mark_as_advanced(LUNASVG_INCLUDE_DIR LUNASVG_LIBRARY_DEBUG LUNASVG_LIBRARY_RELEASE ) + +set(LUNASVG_LIBRARIES ${LUNASVG_LIBRARY} ) +set(LUNASVG_INCLUDE_DIRS ${LUNASVG_INCLUDE_DIR} ) diff --git a/CMake/SampleFileList.cmake b/CMake/SampleFileList.cmake index d2edc3664..51c187ab1 100644 --- a/CMake/SampleFileList.cmake +++ b/CMake/SampleFileList.cmake @@ -108,6 +108,13 @@ set(lottie_SRC_FILES ${PROJECT_SOURCE_DIR}/Samples/basic/lottie/src/main.cpp ) +set(svg_HDR_FILES +) + +set(svg_SRC_FILES + ${PROJECT_SOURCE_DIR}/Samples/basic/svg/src/main.cpp +) + set(sdl2_HDR_FILES ${PROJECT_SOURCE_DIR}/Samples/basic/sdl2/src/RenderInterfaceSDL2.h ${PROJECT_SOURCE_DIR}/Samples/basic/sdl2/src/SystemInterfaceSDL2.h diff --git a/CMake/gen_filelists.sh b/CMake/gen_filelists.sh index bb155e65c..6f5014a3a 100644 --- a/CMake/gen_filelists.sh +++ b/CMake/gen_filelists.sh @@ -75,4 +75,6 @@ printpluginfiles "Lua" printpluginfiles "Lottie" +printpluginfiles "SVG" + popd diff --git a/CMake/gen_samplelists.sh b/CMake/gen_samplelists.sh index 7620911e3..5c0e6b49f 100755 --- a/CMake/gen_samplelists.sh +++ b/CMake/gen_samplelists.sh @@ -8,7 +8,7 @@ srcdir='${PROJECT_SOURCE_DIR}' srcpath=Samples samples=( 'shell' 'basic/animation' 'basic/benchmark' 'basic/bitmapfont' 'basic/customlog' 'basic/databinding' 'basic/demo' 'basic/drag' 'basic/loaddocument' 'basic/treeview' 'basic/transform' - 'basic/lottie' 'basic/sdl2' 'basic/sfml2' + 'basic/lottie' 'basic/svg' 'basic/sdl2' 'basic/sfml2' 'tutorial/template' 'tutorial/datagrid' 'tutorial/datagrid_tree' 'tutorial/drag' 'invaders' 'luainvaders' ) diff --git a/CMakeLists.txt b/CMakeLists.txt index a4287a4b6..2df57de79 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -126,6 +126,10 @@ if(NOT DEFINED ENV{RLOTTIE_DIR}) set(ENV{RLOTTIE_DIR} "${PROJECT_SOURCE_DIR}/Dependencies/rlottie") endif() +if(NOT DEFINED ENV{LUNASVG_DIR}) + set(ENV{LUNASVG_DIR} "${PROJECT_SOURCE_DIR}/Dependencies/lunasvg") +endif() + #=================================== # Plaform specific global hacks ==== #=================================== @@ -253,6 +257,7 @@ elseif( CMAKE_CONFIGURATION_TYPES ) endif() option(ENABLE_LOTTIE_PLUGIN "Enable plugin for Lottie animations. Requires the rlottie library." OFF) +option(ENABLE_SVG_PLUGIN "Enable plugin for SVG images. Requires the lunasvg library." OFF) option(DISABLE_RTTI_AND_EXCEPTIONS "Build with rtti and exceptions disabled." OFF) if(DISABLE_RTTI_AND_EXCEPTIONS) @@ -366,6 +371,28 @@ if( ENABLE_LOTTIE_PLUGIN ) endif() endif() +# lunasvg +if( ENABLE_SVG_PLUGIN ) + if(NOT DEFINED LUNASVG_DIR) + set(LUNASVG_DIR $ENV{LUNASVG_DIR}) + endif() + + message("-- Can SVG plugin be enabled - looking for lunasvg library") + + find_package(lunasvg REQUIRED) + + list(APPEND CORE_LINK_LIBS ${LUNASVG_LIBRARIES}) + list(APPEND CORE_INCLUDE_DIRS ${LUNASVG_INCLUDE_DIR}) + list(APPEND CORE_PRIVATE_DEFS RMLUI_ENABLE_SVG_PLUGIN) + + list(APPEND Core_HDR_FILES ${SVG_HDR_FILES}) + list(APPEND Core_PUB_HDR_FILES ${SVG_PUB_HDR_FILES}) + list(APPEND Core_SRC_FILES ${SVG_SRC_FILES}) + + message("-- Can SVG plugin be enabled - yes - lunasvg library found") +endif() + + if(NOT BUILD_FRAMEWORK) #=================================== # Build libraries ================== @@ -736,6 +763,17 @@ if(BUILD_SAMPLES) BUNDLE DESTINATION ${SAMPLES_DIR} ) endif() + + if( ENABLE_SVG_PLUGIN ) + bl_sample(svg ${sample_LIBRARIES}) + + # The samples always set this as their current working directory + install(DIRECTORY DESTINATION ${SAMPLES_DIR}/basic/svg) + install(TARGETS svg + RUNTIME DESTINATION ${SAMPLES_DIR}/svg + BUNDLE DESTINATION ${SAMPLES_DIR} + ) + endif() # Build and install the tutorials foreach(tutorial ${tutorials}) diff --git a/Include/RmlUi/Lottie/ElementLottie.h b/Include/RmlUi/Lottie/ElementLottie.h index f37e8f2e9..2b2044568 100644 --- a/Include/RmlUi/Lottie/ElementLottie.h +++ b/Include/RmlUi/Lottie/ElementLottie.h @@ -33,7 +33,6 @@ #include "../Core/Element.h" #include "../Core/Geometry.h" #include "../Core/Texture.h" -#include namespace rlottie { class Animation; } diff --git a/Include/RmlUi/SVG/ElementSVG.h b/Include/RmlUi/SVG/ElementSVG.h new file mode 100644 index 000000000..b5a78c4ce --- /dev/null +++ b/Include/RmlUi/SVG/ElementSVG.h @@ -0,0 +1,95 @@ +/* + * This source file is part of RmlUi, the HTML/CSS Interface Middleware + * + * For the latest information, see http://github.com/mikke89/RmlUi + * + * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd + * Copyright (c) 2019 The RmlUi Team, and contributors + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + * + */ + +#ifndef RMLUI_SVG_ELEMENT_SVG_H +#define RMLUI_SVG_ELEMENT_SVG_H + +#include "../Core/Header.h" +#include "../Core/Element.h" +#include "../Core/Geometry.h" +#include "../Core/Texture.h" + +namespace lunasvg { class Document; } + +namespace Rml { + +class RMLUICORE_API ElementSVG : public Element +{ +public: + RMLUI_RTTI_DefineWithParent(ElementSVG, Element) + + ElementSVG(const String& tag); + virtual ~ElementSVG(); + + /// Returns the element's inherent size. + bool GetIntrinsicDimensions(Vector2f& dimensions, float& ratio) override; + +protected: + /// Renders the image. + void OnRender() override; + + /// Regenerates the element's geometry. + void OnResize() override; + + /// Checks for changes to the image's source or dimensions. + /// @param[in] changed_attributes A list of attributes changed on the element. + void OnAttributeChange(const ElementAttributes& changed_attributes) override; + + /// Called when properties on the element are changed. + /// @param[in] changed_properties The properties changed on the element. + void OnPropertyChange(const PropertyIdSet& changed_properties) override; + +private: + // Generates the element's geometry. + void GenerateGeometry(); + // Loads the SVG document specified by the 'src' attribute. + bool LoadSource(); + // Update the texture when necessary. + void UpdateTexture(); + + bool source_dirty = false; + bool geometry_dirty = false; + bool texture_size_dirty = false; + + // The texture this element is rendering from. + Texture texture; + + // The image's intrinsic dimensions. + Vector2f intrinsic_dimensions; + // The element's size for rendering. + Vector2i render_dimensions; + + // The geometry used to render this element. + Geometry geometry; + + UniquePtr svg_document; +}; + +} // namespace Rml + +#endif diff --git a/Samples/basic/svg/data/LICENSE.txt b/Samples/basic/svg/data/LICENSE.txt new file mode 100644 index 000000000..51774ea31 --- /dev/null +++ b/Samples/basic/svg/data/LICENSE.txt @@ -0,0 +1,669 @@ +The file 'tiger.svg' included in this directory is licensed under the GNU Affero General Public License. The license is restated below. +This work was downloaded from [1] on 2021-04-24 and included without modifications. Originally derived from tiger.eps (GPL Ghostscript SVN) [2]. + +[1] https://commons.wikimedia.org/wiki/File:Ghostscript_Tiger.svg +[2] http://git.ghostscript.com/?p=ghostpdl.git;a=blob;f=examples/tiger.eps;hb=HEAD + + +---------------------------- + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/Samples/basic/svg/data/svg.rml b/Samples/basic/svg/data/svg.rml new file mode 100644 index 000000000..53abd6593 --- /dev/null +++ b/Samples/basic/svg/data/svg.rml @@ -0,0 +1,25 @@ + + + Demo + + + + + + + diff --git a/Samples/basic/svg/data/tiger.svg b/Samples/basic/svg/data/tiger.svg new file mode 100644 index 000000000..679edec2e --- /dev/null +++ b/Samples/basic/svg/data/tiger.svg @@ -0,0 +1,725 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Samples/basic/svg/src/main.cpp b/Samples/basic/svg/src/main.cpp new file mode 100644 index 000000000..0a6f01eb2 --- /dev/null +++ b/Samples/basic/svg/src/main.cpp @@ -0,0 +1,119 @@ +/* + * This source file is part of RmlUi, the HTML/CSS Interface Middleware + * + * For the latest information, see http://github.com/mikke89/RmlUi + * + * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd + * Copyright (c) 2019 The RmlUi Team, and contributors + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + * + */ + +#include +#include +#include +#include +#include + +Rml::Context* context = nullptr; + +ShellRenderInterfaceExtensions* shell_renderer; + +void GameLoop() +{ + context->Update(); + + shell_renderer->PrepareRenderBuffer(); + context->Render(); + shell_renderer->PresentRenderBuffer(); +} + +#if defined RMLUI_PLATFORM_WIN32 +#include +int APIENTRY WinMain(HINSTANCE RMLUI_UNUSED_PARAMETER(instance_handle), HINSTANCE RMLUI_UNUSED_PARAMETER(previous_instance_handle), char* RMLUI_UNUSED_PARAMETER(command_line), int RMLUI_UNUSED_PARAMETER(command_show)) +#else +int main(int RMLUI_UNUSED_PARAMETER(argc), char** RMLUI_UNUSED_PARAMETER(argv)) +#endif +{ +#ifdef RMLUI_PLATFORM_WIN32 + RMLUI_UNUSED(instance_handle); + RMLUI_UNUSED(previous_instance_handle); + RMLUI_UNUSED(command_line); + RMLUI_UNUSED(command_show); +#else + RMLUI_UNUSED(argc); + RMLUI_UNUSED(argv); +#endif + + int window_width = 1024; + int window_height = 768; + + ShellRenderInterfaceOpenGL opengl_renderer; + shell_renderer = &opengl_renderer; + + // Generic OS initialisation, creates a window and attaches OpenGL. + if (!Shell::Initialise() || + !Shell::OpenWindow("SVG sample", shell_renderer, window_width, window_height, true)) + { + Shell::Shutdown(); + return -1; + } + + // RmlUi initialisation. + Rml::SetRenderInterface(&opengl_renderer); + shell_renderer->SetViewport(window_width, window_height); + + ShellSystemInterface system_interface; + Rml::SetSystemInterface(&system_interface); + + Rml::Initialise(); + + // Create the main RmlUi context and set it on the shell's input layer. + context = Rml::CreateContext("main", Rml::Vector2i(window_width, window_height)); + if (context == nullptr) + { + Rml::Shutdown(); + Shell::Shutdown(); + return -1; + } + + Rml::Debugger::Initialise(context); + Input::SetContext(context); + Shell::SetContext(context); + + Shell::LoadFonts("assets/"); + + // Load and show the demo document. + if (Rml::ElementDocument* document = context->LoadDocument("basic/svg/data/svg.rml")) + { + document->Show(); + document->GetElementById("title")->SetInnerRML("SVG"); + } + + Shell::EventLoop(GameLoop); + + // Shutdown RmlUi. + Rml::Shutdown(); + + Shell::CloseWindow(); + Shell::Shutdown(); + + return 0; +} diff --git a/Samples/readme.md b/Samples/readme.md index 9cd219840..c3a8bb223 100644 --- a/Samples/readme.md +++ b/Samples/readme.md @@ -20,9 +20,10 @@ This directory contains basic applications that demonstrate initialisation, usag - `demo` demonstrates a variety of features in RmlUi and includes a sandbox for playing with RML/RCSS - `drag` dragging elements between containers - `loaddocument` loading your first document -- `lottie` playing Lottie animations, only enabled with the Lottie plugin +- `lottie` playing Lottie animations, only enabled with the [Lottie plugin](https://mikke89.github.io/RmlUiDoc/pages/cpp_manual/lottie.html) - `sdl2` integrating with SDL2 - `sfml2` integrating with SFML2 +- `svg` render SVG images, only enabled with the [SVG plugin](https://mikke89.github.io/RmlUiDoc/pages/cpp_manual/svg.html) - `transform` demonstration of transforms - `treeview` using data bindings to create a file browser diff --git a/Source/Core/Core.cpp b/Source/Core/Core.cpp index f959778cf..54392a23e 100644 --- a/Source/Core/Core.cpp +++ b/Source/Core/Core.cpp @@ -55,6 +55,10 @@ #include "../Lottie/LottiePlugin.h" #endif +#ifdef RMLUI_ENABLE_SVG_PLUGIN +#include "../SVG/SVGPlugin.h" +#endif + namespace Rml { @@ -132,6 +136,9 @@ bool Initialise() #ifdef RMLUI_ENABLE_LOTTIE_PLUGIN Lottie::Initialise(); #endif +#ifdef RMLUI_ENABLE_SVG_PLUGIN + SVG::Initialise(); +#endif // Notify all plugins we're starting up. PluginRegistry::NotifyInitialise(); diff --git a/Source/SVG/ElementSVG.cpp b/Source/SVG/ElementSVG.cpp new file mode 100644 index 000000000..60f9ecb93 --- /dev/null +++ b/Source/SVG/ElementSVG.cpp @@ -0,0 +1,202 @@ +/* + * This source file is part of RmlUi, the HTML/CSS Interface Middleware + * + * For the latest information, see http://github.com/mikke89/RmlUi + * + * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd + * Copyright (c) 2019 The RmlUi Team, and contributors + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + * + */ + +#include "../../Include/RmlUi/SVG/ElementSVG.h" +#include "../../Include/RmlUi/Core/Core.h" +#include "../../Include/RmlUi/Core/PropertyIdSet.h" +#include "../../Include/RmlUi/Core/GeometryUtilities.h" +#include "../../Include/RmlUi/Core/ElementDocument.h" +#include "../../Include/RmlUi/Core/SystemInterface.h" +#include "../../Include/RmlUi/Core/FileInterface.h" +#include "../../Include/RmlUi/Core/Math.h" +#include +#include + +namespace Rml { + + +ElementSVG::ElementSVG(const String& tag) : Element(tag), geometry(this) +{ +} + +ElementSVG::~ElementSVG() +{ +} + +bool ElementSVG::GetIntrinsicDimensions(Vector2f& dimensions, float& ratio) +{ + if (source_dirty) + LoadSource(); + + dimensions = intrinsic_dimensions; + if (dimensions.y > 0) + ratio = dimensions.x / dimensions.y; + + return true; +} + +void ElementSVG::OnRender() +{ + if (svg_document) + { + if (geometry_dirty) + GenerateGeometry(); + + UpdateTexture(); + geometry.Render(GetAbsoluteOffset(Box::CONTENT)); + } +} + +void ElementSVG::OnResize() +{ + geometry_dirty = true; + texture_size_dirty = true; +} + +void ElementSVG::OnAttributeChange(const ElementAttributes& changed_attributes) +{ + Element::OnAttributeChange(changed_attributes); + + if (changed_attributes.count("src")) + { + source_dirty = true; + DirtyLayout(); + } +} + +void ElementSVG::OnPropertyChange(const PropertyIdSet& changed_properties) +{ + Element::OnPropertyChange(changed_properties); + + if (changed_properties.Contains(PropertyId::ImageColor) || + changed_properties.Contains(PropertyId::Opacity)) { + geometry_dirty = true; + } +} + +void ElementSVG::GenerateGeometry() +{ + geometry.Release(true); + + Vector< Vertex >& vertices = geometry.GetVertices(); + Vector< int >& indices = geometry.GetIndices(); + + vertices.resize(4); + indices.resize(6); + + Vector2f texcoords[2] = { + {0.0f, 0.0f}, + {1.0f, 1.0f} + }; + + const ComputedValues& computed = GetComputedValues(); + + const float opacity = computed.opacity; + Colourb quad_colour = computed.image_color; + quad_colour.alpha = (byte)(opacity * (float)quad_colour.alpha); + + const Vector2f render_dimensions_f = GetBox().GetSize(Box::CONTENT).Round(); + render_dimensions.x = int(render_dimensions_f.x); + render_dimensions.y = int(render_dimensions_f.y); + + GeometryUtilities::GenerateQuad(&vertices[0], &indices[0], Vector2f(0, 0), render_dimensions_f, quad_colour, texcoords[0], texcoords[1]); + + geometry_dirty = false; +} + +bool ElementSVG::LoadSource() +{ + source_dirty = false; + intrinsic_dimensions = Vector2f{}; + geometry.SetTexture(nullptr); + svg_document.reset(); + + const String attribute_src = GetAttribute("src", ""); + + if (attribute_src.empty()) + return false; + + String path = attribute_src; + String directory; + + if (ElementDocument* document = GetOwnerDocument()) + { + const String document_source_url = StringUtilities::Replace(document->GetSourceURL(), '|', ':'); + GetSystemInterface()->JoinPath(path, document_source_url, attribute_src); + GetSystemInterface()->JoinPath(directory, document_source_url, ""); + } + + String svg_data; + + if (path.empty() || !GetFileInterface()->LoadFile(path, svg_data)) + { + Log::Message(Rml::Log::Type::LT_WARNING, "Could not load SVG file %s", path.c_str()); + return false; + } + + // We use a reset-release approach here in case clients use a non-std unique_ptr (lunasvg uses std::unique_ptr) + svg_document.reset(lunasvg::Document::loadFromData(svg_data).release()); + + if (!svg_document) + { + Log::Message(Rml::Log::Type::LT_WARNING, "Could not load SVG data from file %s", path.c_str()); + return false; + } + + intrinsic_dimensions.x = Math::Max(float(svg_document->width()), 1.0f); + intrinsic_dimensions.y = Math::Max(float(svg_document->height()), 1.0f); + + return true; +} + +void ElementSVG::UpdateTexture() +{ + if (!svg_document || !texture_size_dirty) + return; + + // Callback for generating texture. + auto p_callback = [this](const String& /*name*/, UniquePtr& data, Vector2i& dimensions) -> bool { + RMLUI_ASSERT(svg_document); + + const size_t total_bytes = 4 * render_dimensions.x * render_dimensions.y; + + lunasvg::Bitmap bitmap = svg_document->renderToBitmap(render_dimensions.x, render_dimensions.y); + + data.reset(new byte[total_bytes]); + memcpy((void*)data.get(), bitmap.data(), total_bytes); + dimensions = render_dimensions; + + return true; + }; + + texture.Set("svg", p_callback); + geometry.SetTexture(&texture); + texture_size_dirty = false; +} + +} // namespace Rml diff --git a/Source/SVG/SVGPlugin.cpp b/Source/SVG/SVGPlugin.cpp new file mode 100644 index 000000000..77a8e36d1 --- /dev/null +++ b/Source/SVG/SVGPlugin.cpp @@ -0,0 +1,73 @@ +/* + * This source file is part of RmlUi, the HTML/CSS Interface Middleware + * + * For the latest information, see http://github.com/mikke89/RmlUi + * + * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd + * Copyright (c) 2019 The RmlUi Team, and contributors + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + * + */ + + +#include "../../Include/RmlUi/SVG/ElementSVG.h" +#include "../../Include/RmlUi/Core/Core.h" +#include "../../Include/RmlUi/Core/ElementInstancer.h" +#include "../../Include/RmlUi/Core/Factory.h" +#include "../../Include/RmlUi/Core/Log.h" +#include "../../Include/RmlUi/Core/Plugin.h" + +namespace Rml { +namespace SVG { + + +class SVGPlugin : public Plugin { +public: + void OnInitialise() override + { + instancer = MakeUnique >(); + + Factory::RegisterElementInstancer("svg", instancer.get()); + + Log::Message(Log::LT_INFO, "SVG plugin initialised."); + } + + void OnShutdown() override + { + delete this; + } + + int GetEventClasses() override + { + return Plugin::EVT_BASIC; + } + +private: + UniquePtr> instancer; +}; + + +void Initialise() +{ + RegisterPlugin(new SVGPlugin); +} + +} // namespace SVG +} // namespace Rml diff --git a/Source/SVG/SVGPlugin.h b/Source/SVG/SVGPlugin.h new file mode 100644 index 000000000..31363e3a5 --- /dev/null +++ b/Source/SVG/SVGPlugin.h @@ -0,0 +1,41 @@ +/* + * This source file is part of RmlUi, the HTML/CSS Interface Middleware + * + * For the latest information, see http://github.com/mikke89/RmlUi + * + * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd + * Copyright (c) 2019 The RmlUi Team, and contributors + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + * + */ + +#ifndef RMLUI_SVG_SVG_PLUGIN_H +#define RMLUI_SVG_SVG_PLUGIN_H + + +namespace Rml { +namespace SVG { + +void Initialise(); + +} +} + +#endif diff --git a/readme.md b/readme.md index c435fb65a..82e23d8f8 100644 --- a/readme.md +++ b/readme.md @@ -191,8 +191,10 @@ body ![Lottie animation](https://github.com/mikke89/RmlUiDoc/blob/086385e119f0fc6e196229b785e91ee0252fe4b4/assets/gallery/lottie.gif) **Vector animations with the [Lottie plugin](https://mikke89.github.io/RmlUiDoc/pages/cpp_manual/lottie.html)** -See the **[full gallery](https://mikke89.github.io/RmlUiDoc/pages/gallery.html)** for more screenshots and videos of the library in action. +![SVG image](https://github.com/mikke89/RmlUiDoc/blob/2908fe50acf7861e729ce113eafa8cf7610bf08a/assets/gallery/svg_plugin.png) +**Vector images with the [SVG plugin](https://mikke89.github.io/RmlUiDoc/pages/cpp_manual/svg.html)** +See the **[full gallery](https://mikke89.github.io/RmlUiDoc/pages/gallery.html)** for more screenshots and videos of the library in action. ## License @@ -236,8 +238,9 @@ See [Source/Debugger/LICENSE.txt](Source/Debugger/LICENSE.txt) - SIL Open Font L See - [Samples/assets/LICENSE.txt](Samples/assets/LICENSE.txt) -- [Samples/basic/lottie/data/LICENSE.txt](Samples/basic/lottie/data/LICENSE.txt) - [Samples/basic/bitmapfont/data/LICENSE.txt](Samples/basic/bitmapfont/data/LICENSE.txt) +- [Samples/basic/lottie/data/LICENSE.txt](Samples/basic/lottie/data/LICENSE.txt) +- [Samples/basic/svg/data/LICENSE.txt](Samples/basic/svg/data/LICENSE.txt) #### Libraries included with the test suite *(in Tests/Dependencies/)*