6f509d3 Initial version of Scatter.
- Authored by Peter Boughton at Tue 31 Mar 2020, 10:27
- tag: v0.1
demos/cards.html (new) | 219 +++++ demos/index.html (new) | 31 + demos/mobile.html (new) | 131 +++ demos/polaroids.html (new) | 83 ++ demos/slides.html (new) | 96 +++ demos/stars.html (new) | 119 +++ license.txt (new) | 842 ++++++++++++++++++++ readme.md (new) | 60 ++ scatter.js (new) | 457 +++++++++++ 9 files changed, 2038 insertions(+)
diff --git a/demos/cards.html b/demos/cards.html new file mode 100644 index 0000000..fee05cc --- /dev/null +++ b/demos/cards.html (view file) @@ -0,0 +1,219 @@ +<!-- Scatter v0.1 | (c) Peter Boughton | License: LGPLv3 | https://www.sorcerersisle.com/software/scatter --> +<!doctype html><meta charset=utf-8 /> +<title>Cards Scatter Demo</title> + +<h1>Cards Scatter Demo</h1> +<p>A full deck of playing cards strewn across a table. +<p>Uses random mode plus <em>not</em> setting overflow:hidden style on the container to allow cards to overlap the edge. +<p>Click to flip a card - uses custom handler for click event to modify the CSS transform. +<p>Each individual card uses Scatter too - pre-defined pip coordinates are passed to a fixed mode Scatter instance with click events disabled. + +<p><i>(View source to see markup, script and CSS used.)</i> +<script src="../scatter.js"></script> + + +<style> + body + { + font-family:sans-serif; + background:#CCC; + } + + #Table + { + display:block; + background:#484; + border: solid 1px black; + width:960px; + margin:auto; + height:480px; + margin-top:4em; + } + + #Table>* + { + transition: 0.3s; + } + + .card + { + position:relative; + display: inline-block; + background: white; + border: solid 2px white; + border-radius: 9px; + height: 342px; /* 3.5in ~ 346px */ + width: 236px; /* 2.5in ~ 240px */ + box-shadow: 0 0 2px rgba(0,0,0,0.2); + + font-family: serif; + text-align:center; + } + .card.hearts,.card.diams { color: red; } + .card.spades,.card.clubs { color: black; } + + .card .inv{ transform: rotate(180deg); } + + .card .corner + { + width: 30px; + font-size: 34px; + line-height: 1; + position: absolute; + } + .card .corner:not(.inv){left:0;top:0;} + .card .corner.inv{right:0;bottom:0;} + + .card .body + { + width:100%; + height:100%; + font-size:80px; + } + + /* Larger pip for Ace of Spades */ + .card.spades.v1 .body + { + font-size: 160px; + margin-top:-20px; + } + + + .card .body.picture + { + margin: 22px auto; + padding: 4px 0; + width:176px; + height:282px; + border:solid 1px navy; + background:#FFE; + } + + .card.facedown + { + background-color: white; + background-image: radial-gradient(circle,white,navy 6px,white 12px,white); + background-size: 18px 20px; + } + .card.facedown>* + { + display:none; + } +</style> + + +<div id="Table"></div> + + +<script> + var Suits = ['spades','hearts','clubs','diams']; + var Labels = { 1:'A' , 11:'J' , 12:'Q' , 13:'K' , 10:'1<span style="margin-left:-0.4ch;">0</span>' }; + + var Ends = 126; + var Sides = 54; + var Corners = [[-Sides,-Ends],[Sides,-Ends],[-Sides,Ends,180],[Sides,Ends,180]]; + var MidRow = [[-Sides,0],[Sides,0]]; + var NineTen = [[-Sides,-48],[Sides,-48],[-Sides,48,180],[Sides,48,180]]; + var Pictures = [[-Sides,-Ends],[Sides,Ends,180],[0,-Ends+30],[0,Ends-30,180],[0,-Ends+60],[0,Ends-60,180]]; + + var Hats = {11:'♗',12:'♕',13:'♚'}; + + var PipPositions = + { 1: [[0,0]] + , 2: [[0,-Ends],[0,Ends,180]] + , 3: [[0,0],[0,-Ends],[0,Ends,180]] + , 4: Corners + , 5: Corners.concat([[0,0]]) + , 6: Corners.concat(MidRow) + , 7: Corners.concat(MidRow).concat([[0,-68]]) + , 8: Corners.concat(MidRow).concat([[0,-68],[0,68,180]]) + , 9: Corners.concat(NineTen).concat([[0,0]]) + , 10: Corners.concat(NineTen).concat([[0,-87],[0,87,180]]) + , 11: Pictures + , 12: Pictures + , 13: Pictures + }; + + + function renderCard(Value,Suit) + { + var SuitHtml = '&'+Suit+';'; + + var Label = Labels[Value] || Value; + + var CardHtml = '<div class="card '+Suit+' v'+Value+'">' + +'<div class="corner"><div class="value">'+Label+'</div><div class="suit">'+SuitHtml+'</div></div>' + ; + + if ( Value > 10 ) + { + CardHtml += '<div class="body picture">' + + '<div class="pip">'+SuitHtml+'</div><div class="pip">'+SuitHtml+'</div>' + + '<div class="hat">'+Hats[Value]+'</div><div class="hat">'+Hats[Value]+'</div>' + + '<div class="head">☺</div><div class="head">☺</div>' + + '</div>' + ; + } + else + { + CardHtml += '<div class="body">'; + for ( var i = 1 ; i <= Value ; ++i ) + CardHtml += '<div class="pip">'+SuitHtml+'</div>'; + CardHtml += '</div>'; + } + + CardHtml += '<div class="corner inv"><div class="value">'+Label+'</div><div class="suit">'+SuitHtml+'</div></div>' + +'</div>'; + + return CardHtml; + } + + /* + render each card and positions pips using + */ + var Table = document.getElementById('Table'); + for ( var i=0 ; i<Suits.length ; ++i ) + { + for ( var Value = 1 ; Value <= 13 ; ++Value ) + { + Table.innerHTML += renderCard(Value,Suits[i]); + + var CardOptions = + { InitialMode : 'fixed' + , FixedRelativeTo : 'center' + , FixedPositions : PipPositions[Value] + , ChildEvents : {'click':void 0} + , ContainerEvents : {'click':void 0} + }; + + new Scatter('.card.v'+Value+'.'+Suits[i]+' .body',CardOptions ); + } + } + + function flipCard(event) + { + event.stopPropagation(); + event.currentTarget.classList.toggle('facedown'); + + if ( event.currentTarget.style.transform.indexOf('rotate3d') !== -1 ) + { + event.currentTarget.style.transform = event.currentTarget.style.transform.replace(/rotate3d\([^)]+\)/,''); + } + else + { + // non-zero z rotation overcomes animation glitch when card has clockwise 2d rotation. + event.currentTarget.style.transform += ' rotate3d(0,1,0.001,180deg)'; + } + } + + var CardOptions = + { Mode : 'random' + , InitialMode : 'random' + , Scale : 0.3 + , MaxRotation : 45 + , Shuffle : true + , ChildEvents : {click:flipCard} + }; + var CardScatter = new Scatter(document.getElementById('Table'),CardOptions); + +</script> \ No newline at end of file
diff --git a/demos/index.html b/demos/index.html new file mode 100644 index 0000000..3d90604 --- /dev/null +++ b/demos/index.html (view file) @@ -0,0 +1,31 @@ +<!-- Scatter v0.1 | (c) Peter Boughton | License: LGPLv3 | https://www.sorcerersisle.com/software/scatter --> +<!doctype html><meta charset=utf-8 /> +<title>Scatter Demos</title> + +<h1>Scatter Demos</h1> +<p>Scatter is designed to be simple yet versatile. The demos provided here +show how features can be used together and what can be achieved. + +<p>The demos use a mix of Scatter options with custom CSS and JavaScript to +provide the different effects - this is the way Scatter is designed to work: +as a solid core of functionality from which you pick and choose whatever +is needed to create the effect you are after. + +<ul> + <li><a href="./polaroids.html">Polaroids</a> - all options default, using CSS to style items as polaroid photos with captions. + <li><a href="./slides.html">Slides</a> - shows grid mode, limiting rotation, and using next/prev navigation functions. + <li><a href="./mobile.html">Mobile</a> - gives an example of how to detect swipe left/right to trigger navigation. + <li><a href="./cards.html">Cards</a> - shows random mode and overriding the transform style to flip cards. + <li><a href="./stars.html">Stars</a> - uses fixed mode with predefined positions to transition through constellations. +</ul> + +<p>All of the demos are self-contained - none of them use any additional resources beyond scatter.js, +and the entire demo code for each one is available by using View Source. + +<style> + body + { + font-family:sans-serif; + background:#CCC; + } +</style> \ No newline at end of file
diff --git a/demos/mobile.html b/demos/mobile.html new file mode 100644 index 0000000..583b10a --- /dev/null +++ b/demos/mobile.html (view file) @@ -0,0 +1,131 @@ +<!-- Scatter v0.1 | (c) Peter Boughton | License: LGPLv3 | https://www.sorcerersisle.com/software/scatter --> +<!doctype html><meta charset=utf-8 /> +<title>Mobile Scatter Demo</title> + +<h1>Mobile Scatter Demo</h1> +<p>Uses touch/swipe events and scaling to maintain usability on a mobile device. +<p>Press to select, then swipe left and right to navigate between items, swipe upto discard. +<p>(On a non-touch device, enable mobile/touch simulation mode and use click-drag.) + +<p><i>(View source to see markup, script and CSS used.)</i> +<script src="../scatter.js"></script> + + +<style> + body + { + font-family:sans-serif; + background:#CCC; + } + + #MobileGallery + { + width:100%; + height:300px; + display:block; + background:#EEE; + overflow:hidden; + } + + .polaroid + { + background:#FCFCFC; + color:black; + width:226px; + height:274px; + padding:12px; + padding-top:20px; + + box-shadow: 0 0 3px rgba(0,0,0,0.8); + cursor:pointer; + transition: 0.3s; + } + + .polaroid.selected + { + box-shadow: 0 0 5px rgba(50,50,50,0.5); + cursor:default; + } + + .polaroid img + { + display:block; + background:black; + width:226px; + height:226px; + margin: auto; + } + + .polaroid figcaption + { + text-align:center; + margin:1em; + } +</style> + +<div id="MobileGallery"> + <figure class="polaroid"><img /><figcaption>image 1</figcaption></figure> + <figure class="polaroid"><img /><figcaption>image 2</figcaption></figure> + <figure class="polaroid"><img /><figcaption>image 3</figcaption></figure> + <figure class="polaroid"><img /><figcaption>image 4</figcaption></figure> + <figure class="polaroid"><img /><figcaption>image 5</figcaption></figure> + <figure class="polaroid"><img /><figcaption>image 6</figcaption></figure> + <figure class="polaroid"><img /><figcaption>image 7</figcaption></figure> + <figure class="polaroid"><img /><figcaption>image 8</figcaption></figure> + <figure class="polaroid"><img /><figcaption>image 9</figcaption></figure> + <figure class="polaroid"><img /><figcaption>image 10</figcaption></figure> +</div> + +<script> + window.onload=(function() + { + var MobileOptions = + { Mode : 'random' + , Scale : 0.5 + , SelectedScale : 1 + , ContainerEvents: {click:doNothing,dblclick:'arrange'} + }; + + var MobileScatter = new Scatter('#MobileGallery',MobileOptions); + MobileScatter.arrange(); + + + var MobileGallery = document.getElementById('MobileGallery'); + + MobileGallery.addEventListener('touchstart',registerPosition); + MobileGallery.addEventListener('touchend',checkSwipe); + + var StartPos = {}; + + function doNothing(event) + { + event.preventDefault(); + } + + function registerPosition(event) + { + StartPos.x = event.changedTouches[0].pageX; + StartPos.y = event.changedTouches[0].pageY; + } + + function checkSwipe(event) + { + var DistX = event.changedTouches[0].pageX - StartPos.x; + var DistY = event.changedTouches[0].pageY - StartPos.y; + var MinDrag = 30; + + if ( DistX > MinDrag && Math.abs(DistY) < MinDrag ) + { + MobileScatter.prev(); + } + else if ( DistX < -MinDrag && Math.abs(DistY) < MinDrag ) + { + MobileScatter.next(); + } + else if ( DistY < -MinDrag ) + { + MobileScatter.discard(); + } + } + }); +</script> \ No newline at end of file
diff --git a/demos/polaroids.html b/demos/polaroids.html new file mode 100644 index 0000000..6836fde --- /dev/null +++ b/demos/polaroids.html (view file) @@ -0,0 +1,83 @@ +<!-- Scatter v0.1 | (c) Peter Boughton | License: LGPLv3 | https://www.sorcerersisle.com/software/scatter --> +<!doctype html><meta charset=utf-8 /> +<title>Polaroids Scatter Demo</title> + +<h1>Polaroids Scatter Demo</h1> +<p>A collection of polaroids with captions, all options on default. + +<p><i>(View source to see markup, script and CSS used.)</i> +<script src="../scatter.js"></script> + + +<style> + body + { + font-family:sans-serif; + background:#CCC; + } + + .gallery + { + width:80%; + height:600px; + display:block; + background:#DDD; + border: solid 1px black; + overflow:hidden; + } + + .polaroid + { + background:#FCFCFC; + color:black; + width:181px; + height:219px; + padding:10px; + padding-top:16px; + + box-shadow: 0 0 3px rgba(0,0,0,0.8); + cursor:pointer; + transition: 0.3s; + } + + .polaroid.selected + { + box-shadow: 0 0 5px rgba(50,50,50,0.5); + cursor:default; + } + + .polaroid img + { + display:block; + background:black; + width: 181px; + height:181px; + margin: auto; + } + + .polaroid figcaption + { + text-align:center; + margin:1em; + } +</style> + + +<div class="gallery"> + <figure class="polaroid"><img /><figcaption>image 1</figcaption></figure> + <figure class="polaroid"><img /><figcaption>image 2</figcaption></figure> + <figure class="polaroid"><img /><figcaption>image 3</figcaption></figure> + <figure class="polaroid"><img /><figcaption>image 4</figcaption></figure> + <figure class="polaroid"><img /><figcaption>image 5</figcaption></figure> + <figure class="polaroid"><img /><figcaption>image 6</figcaption></figure> + <figure class="polaroid"><img /><figcaption>image 7</figcaption></figure> + <figure class="polaroid"><img /><figcaption>image 8</figcaption></figure> + <figure class="polaroid"><img /><figcaption>image 9</figcaption></figure> + <figure class="polaroid"><img /><figcaption>image 10</figcaption></figure> +</div> + + +<script> + var PolaroidScatter = new Scatter('.gallery'); + PolaroidScatter.arrange(); +</script> \ No newline at end of file
diff --git a/demos/slides.html b/demos/slides.html new file mode 100644 index 0000000..2611f39 --- /dev/null +++ b/demos/slides.html (view file) @@ -0,0 +1,96 @@ +<!-- Scatter v0.1 | (c) Peter Boughton | License: LGPLv3 | https://www.sorcerersisle.com/software/scatter --> +<!doctype html><meta charset=utf-8 /> +<title>Slides Scatter Demo</title> + +<h1>Slides Scatter Demo</h1> +<p>Mimicking a spread of 24mm slide negatives, using grid mode with slight rotation. +<p>Click on a slide to select, click background to discard, click right/left side for next/prev. + +<p><i>(View source to see markup, script and CSS used.)</i> +<script src="../scatter.js"></script> + + +<style> + body + { + font-family:sans-serif; + background:#EEE; + } + + #SlidesArea + { + width: 750px; + height: 500px; + background: #DDD; + border: solid 1px black; + } + + .slide + { + width:102px; + height:102px; + border-radius:6px; + background: rgba(255,252,246,1); + box-shadow: 0 0 5px rgba(0,0,0,0.1); + cursor: pointer; + transition: 0.3s; + } + + .slide.selected + { + box-shadow: 0 0 5px rgba(48,48,48,0.5); + } + + .slide img + { + display:block; + width:72px; + height:48px; + margin:27px auto; + padding:0; + background:black; + } +</style> + + +<div id="SlidesArea"></div> + + +<script> + var Container = document.getElementById('SlidesArea'); + + for ( var i = 1 ; i <= 24 ; ++i ) + Container.innerHTML += '<div class="slide"><img /></div>'; + + var Options = + { Mode : 'grid' + , InitialMode : 'grid' + , SelectedScale : 4 + , MaxRotation : 3 + , GridSpacingX : 15 + , GridSpacingY : 15 + , ChildEvents : {click:selectOrNavigate} + , ContainerEvents : {click:'discard',dblclick:'arrange'} + }; + + var SlideScatter = new Scatter(Container,Options); + + + function selectOrNavigate(event) + { + event.stopPropagation(); + + if ( event.currentTarget.classList.contains('selected') ) + { + if ( event.offsetX > event.currentTarget.offsetWidth/2 ) + SlideScatter.next(); + else + SlideScatter.prev(); + } + else + { + SlideScatter.select(event.currentTarget); + } + } + +</script> \ No newline at end of file
diff --git a/demos/stars.html b/demos/stars.html new file mode 100644 index 0000000..242dc69 --- /dev/null +++ b/demos/stars.html (view file) @@ -0,0 +1,119 @@ +<!-- Scatter v0.1 | (c) Peter Boughton | License: LGPLv3 | https://www.sorcerersisle.com/software/scatter --> +<!doctype html><meta charset=utf-8 /> +<title>Stars Scatter Demo</title> + +<h1>Stars Scatter Demo</h1> +<p>Defaults to random mode, but uses fixed mode to display stars in specific positions. +<p>Each constellation button calls configure to change the FixedPositions option, then arrange to move into place. +<p>The Shuffle option can still be used with fixed mode - apply the same constellation multiple times and see the stars re-organise. + +<p><i>(View source to see markup, script and CSS used.)</i> +<script src="../scatter.js"></script> + + +<style> + body + { + font-family:sans-serif; + background:#CCC; + } + + #Sky + { + display:block; + background:black; + color:white; + width:700px; + height:600px; + } + + #Sky>.star + { + transition: 0.3s; + color:white; + } + + #StarControls button + { + border-width: 2px; + padding: 0.25em 0.5em; + cursor:pointer; + } +</style> + + +<div id="StarControls"> + <button>Random</button> + <button>Gemini</button> + <button>Leo</button> + <button>Orion</button> + <button>Ursa Major</button> +</div> + +<br/> + +<div id="Sky"></div> + + +<script> + var Sky = document.getElementById('Sky'); + + for ( var i=0 ; i<25 ; ++i ) + Sky.innerHTML += '<div class="star">*</div>'; + + var Constellations = + { "Ursa Major": + [[50,141],[119,106],[169,116],[232,123],[346,84],[470,50],[560,42] + ,[259,169],[348,146],[455,103],[507,178],[576,210],[680,197] + ,[261,239],[305,416],[305,435],[331,284],[434,314],[443,296] + ] + , "Leo": + [[512,302],[84,250],[462,166],[236,152],[602,92],[474,105],[233,242] + ,[188,326],[685,47],[660,105],[571,56],[515,219] + ] + , "Gemini": + [[154,87],[109,151],[376,363],[201,263],[347,211],[266,290],[344,425] + ,[313,56],[184,161],[106,214],[205,359],[433,254],[466,253],[507,237] + ,[242,120],[410,295],[143,174] + ] + , "Orion": + [[149,240],[327,512],[279,258],[248,375],[230,390],[211,403],[233,477] + ,[179,538],[236,197],[118,200],[281,412],[85,117],[154,15],[113,18] + ,[366,100],[401,132],[409,191],[428,214],[433,247],[426,270],[414,327],[395,339] + ] + }; + + document.getElementById('StarControls').addEventListener('click',showConstellation); + + function showConstellation(event) + { + if ( event.target.innerText == "Random" ) + { + StarScatter.arrange("random"); + return; + } + + var Constellation = Constellations[event.target.innerText]; + + // all children need a position - so add extra off-screen positions to smaller constellations + while( Constellation.length < Sky.children.length ) + Constellation.push([-100,-100]); + + StarScatter.configure({Mode:"fixed",FixedPositions:Constellation}); + StarScatter.arrange(); + } + + var Options = + { InitialMode : "random" + , Mode : "fixed" + , FixedPositions : Constellations.Orion + , FixedRelativeTo : 'corner' + , Scale : 0.5 + , Shuffle : true + , ChildEvents : {click:void 0} + , ContainerEvents : {click:void 0} + }; + + var StarScatter = new Scatter(Sky,Options); + +</script> \ No newline at end of file
diff --git a/license.txt b/license.txt new file mode 100644 index 0000000..e31bc7c --- /dev/null +++ b/license.txt (view file) @@ -0,0 +1,842 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + 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 that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU 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 as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. + + + + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<https://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<https://www.gnu.org/licenses/why-not-lgpl.html>. \ No newline at end of file
diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..53b63a8 --- /dev/null +++ b/readme.md (view file) @@ -0,0 +1,60 @@ +Scatter + +* Version: 0.1 +* License: LGPLv3 +* Homepage: https://www.sorcerersisle.com/software/scatter +* Documentation: https://docs.sorcerersisle.com/scatter +* Repository: https://github.com/boughtonp/scatter.git +* Issues: https://github.com/boughtonp/scatter/issues + + +Description +----------- + +Scatter is a JavaScript library for randomly arranging HTML elements within a +containing element. + +The main use case is an image gallery, but the library does not restrict what +it can be used for - it can provide a scattered polaroid photo effect as easily +as using decorative images to provide a randomized background, or any other +reasons for scattering items your imagination can come up with. + +The demos directory provides various examples showing how to achieve different +effects. For further detail on how Scatter works, check the docs directory. + + +Requirements +------------ + +Scatter is designed to work in any modern browser, without any dependencies. + +Older browsers (released before 2015) can be supported with polyfills for +Object.assign and Array.from - adding these allows Scatter to work with +Internet Explorer 11.0.9600, and possibly Firefox 3.6 + +With a polyfill for Element.classList it may work as far back as IE9, but this +has not been tested, and is not specifically supported. + + +Licensing & Credits +------------------- + +This project is available under the terms of the LGPLv3 license. +See license.txt to understand your rights and obligations. + +Scatter was created by Peter Boughton. + + +Contributing +------------ + +This project aims to adhere to the philosophy "do one thing well", and also to +keep the core script simple and understandable. + +Fixes, simplifications, and improvements to existing functionality are welcome. +Additional features or larger changes are not a priority. + +If in doubt, raise an issue to discuss first. + + +/eof \ No newline at end of file
diff --git a/scatter.js b/scatter.js new file mode 100644 index 0000000..3efdb6d --- /dev/null +++ b/scatter.js (view file) @@ -0,0 +1,457 @@ +// Scatter v0.1 | (c) Peter Boughton | License: LGPLv3 | Website: https://www.sorcerersisle.com/software/scatter +"use strict"; + +var Scatter = function() +{ + + var DefaultOptions = + { Mode : 'radial' + , InitialMode : void 0 + , InitialSelect : -1 + , SelectedClass : 'selected' + , SelectedScale : 1.5 + , Scale : 1.0 + , MaxRotation : 10 + , Shuffle : 'auto' + , ShuffleModes : ['random','radial'] + , ContainerEvents : { 'click' : 'arrange' } + , ChildEvents : { 'click' : 'select' } + + // Mode-specific options + , GridAlignCenter : true + , GridSpacing : 1 + , GridSpacingX : void 0 + , GridSpacingY : void 0 + , PileOffsetFactor : 3 + , RadialWidthFactor : 0.85 + , RadialHeightFactor : 1.2 + , RadialMinDistance : 0.5 + , FixedRelativeTo : 'center' + , FixedPositions : void 0 + }; + + var Scatter = function Scatter( Target , InitOptions ) + { + var Instance = this; + var Container; + var Options = {}; + var Positions = []; + var SelectedIndex; + + + Instance.configure = function( NewOptions ) + { + if ( typeof NewOptions !== 'object' ) + throw new TypeError('Invalid argument'); + + Options = resolveOptions( Options , NewOptions ); + }; + + + Instance.arrange = function( Mode , Reset ) + { + if ( typeof Mode === 'undefined' || typeof Mode === 'object' ) + Mode = Options.Mode; + + Positions = choosePositions( Mode , Container , Options , Positions ); + + if ( ( typeof Reset !== 'boolean' || Reset ) && typeof SelectedIndex !== 'undefined' ) + Container.children[SelectedIndex].classList.remove(Options.SelectedClass); + + if ( Positions.length !== Container.children.length ) + throw new Error('Found '+Container.children.length+' children; have '+Positions.length+' positions'); + + for ( var i=0 ; i<Container.children.length ; ++i ) + translateCenter( Container.children[i] , Positions[i] , Options.Scale ); + }; + + + Instance.select = function( Index ) + { + if ( typeof Index !== 'number' ) + { + if ( Index.stopPropagation ) + Index.stopPropagation(); + + Index = Array.prototype.indexOf.call( Container.children , Index.currentTarget || Index ); + } + + if ( typeof Index !== 'number' ) + throw new Error('Invalid Index'); + + if ( typeof SelectedIndex !== 'undefined' ) + { + if ( SelectedIndex === Index ) + return; + + Instance.discard(); + } + + if ( Index < 0 || Index >= Container.children.length ) + throw new Error('Index out of bounds ('+Index+' not within 0..'+Container.children.length+')'); + + SelectedIndex = Index; + translateCenter( Container.children[Index] , getCenterCoords(Container) , Options.SelectedScale ); + Container.children[Index].style.zIndex = getHighestZ(Container)+1; + Container.children[Index].classList.add(Options.SelectedClass); + }; + + + Instance.discard = function( Reset ) + { + if (typeof SelectedIndex === 'undefined') + return; + + Container.children[SelectedIndex].classList.remove(Options.SelectedClass); + translateCenter( Container.children[SelectedIndex] , Positions[SelectedIndex] , Options.Scale ); + + if ( typeof Reset !== 'boolean' || Reset ) + SelectedIndex = undefined; + }; + + + Instance.prev = function() + { + if ( typeof SelectedIndex === 'undefined' || SelectedIndex === 0 ) + return Instance.select(Container.children.length-1); + + return Instance.select(SelectedIndex-1); + }; + + + Instance.next = function() + { + if ( typeof SelectedIndex === 'undefined' || SelectedIndex === Container.children.length-1 ) + return Instance.select(0); + + return Instance.select(SelectedIndex+1); + }; + + + Container = getContainer( Target ); + + Options = resolveOptions( DefaultOptions , InitOptions ); + + prepareElements( Container , Options , this ); + + if ( typeof Options.InitialMode !== 'undefined' ) + Instance.arrange(Options.InitialMode); + + if ( Options.InitialSelect !== -1) + Instance.select(Options.InitialSelect); + } + + + function getContainer( Target ) + { + if ( typeof Target === 'object' && Target.nodeType == Node.ELEMENT_NODE ) + return Target; + + if ( typeof Target !== 'string' ) + throw new Error('Invalid Target, expected Element or Selector'); + + var TargetElement = document.querySelector(Target); + + if ( TargetElement === null ) + throw new Error('Selector ['+Target+'] did not match.'); + + return TargetElement; + } + + + function resolveOptions( Current , New ) + { + var Result = {}; + + Object.assign( Result , Current ); + + for ( var CurOpt in New ) + { + Result[CurOpt] = ( typeof Result[CurOpt] === 'object' && ! Result[CurOpt] instanceof Array ) + ? resolveOptions(Result[CurOpt],New[CurOpt]) + : New[CurOpt] + ; + } + + if ( Result.Mode === 'fixed' && ! Result.FixedPositions instanceof Array ) + throw new Error('Invalid Options, Mode "fixed" requires array of FixedPositions'); + + return Result; + } + + + function prepareElements( Container , Options , Instance ) + { + if ( getComputedStyle(Container).position == 'static' ) + Container.style.position = 'relative'; + + var ContainerCenter = getCenterCoords(Container); + + for ( var i=0 ; i<Container.children.length ; ++i ) + { + Container.children[i].style.position = 'absolute'; + positionCenter( Container.children[i] , ContainerCenter , Options.Scale ); + + for ( var CurType in Options.ChildEvents ) + { + var CurListener = Options.ChildEvents[CurType]; + Container.children[i].addEventListener + ( CurType + , (typeof CurListener === 'string') ? Instance[ CurListener ] : CurListener + ); + } + } + + for ( var CurType in Options.ContainerEvents ) + { + var CurListener = Options.ContainerEvents[CurType]; + Container.addEventListener + ( CurType + , (typeof CurListener === 'string') ? Instance[ CurListener ] : CurListener + ); + } + } + + + function getCenterCoords( Element ) + { + var c = getDocumentPosition(Element); + return { left:c.left+c.width/2 , top:c.top+c.height/2 , angle:0 }; + } + + + function positionCenter( Element , Pos , Scale ) + { + var ParentPos = getDocumentPosition(Element.parentElement); + + Element.style.left = (Pos.left - ParentPos.left - Element.offsetWidth/2) + 'px'; + Element.style.top = (Pos.top - ParentPos.top - Element.offsetHeight/2) + 'px'; + Element.style.transform = 'scale('+Scale+')'; + } + + + function translateCenter( Element , Pos , Scale ) + { + var ParentPos = getDocumentPosition(Element.parentElement); + + var x = (Pos.left - ParentPos.left - Element.offsetWidth/2) + 'px'; + var y = (Pos.top - ParentPos.top - Element.offsetHeight/2) + 'px'; + + Element.style.left = '0px'; + Element.style.top = '0px'; + Element.style.transform = 'translate('+x+','+y+') rotate('+Pos.angle+'deg) scale('+Scale+')'; + } + + + function choosePositions ( Mode , Container , Options , Positions ) + { + if ( Container.children.length === 0 ) + throw new RangeError('No children'); + + if ( typeof Mode === 'undefined' || typeof Mode === 'object' ) + Mode = Options.Mode; + + var Result = []; + + var Bounds = getDocumentPosition(Container); + + if ( Mode === 'fixed' ) + { + if ( ! Options.FixedPositions instanceof Array ) + throw new TypeError('Missing or invalid FixedPositions option'); + + // Accept 2/3 item array, or object with named keys... + var k = ( Options.FixedPositions[0] instanceof Array ) + ? [0,1,2] : ['left','top','angle'] + ; + + for ( var i=0 ; i<Options.FixedPositions.length ; ++i ) + { + var CurPos = + { left : Options.FixedPositions[i][k[0]] + Bounds.left + , top : Options.FixedPositions[i][k[1]] + Bounds.top + , angle : Options.FixedPositions[i][k[2]] || 0 + }; + + if ( Options.FixedRelativeTo == 'center' ) + { + CurPos.left += Bounds.width/2; + CurPos.top += Bounds.height/2; + } + Result.push(CurPos); + } + + if ( typeof Options.Shuffle === 'boolean' ? Options.Shuffle : ( Options.ShuffleModes.indexOf(Mode) !== -1 ) ) + shuffle(Result); + + return Result; + } + + if ( Mode === 'radial' ) + { + var ContainerCenter = getCenterCoords(Container); + var WidthRatio = (Bounds.width/Bounds.height)*Options.RadialWidthFactor; + var HeightRatio = (Bounds.height/Bounds.width)*Options.RadialHeightFactor; + } + else if ( Mode === 'grid' ) + { + var AspectRatio = Bounds.width/Bounds.height; + var MaxPerRow = Container.children.length / AspectRatio; + var ColIndex = 0; + var CellSize = + { X : Container.children[0].offsetWidth * Options.Scale + , Y : Container.children[0].offsetHeight * Options.Scale + }; + var CurLeft = CellSize.X/2; + var CurTop = -CellSize.Y/2 - (Options.GridSpacingY||Options.GridSpacing); + var MaxRight=0; + var MaxBottom=0; + } + + for ( var Index=0 ; Index < Container.children.length ; ++Index ) + { + switch (Mode) + { + case 'center': + case 'stack': + case 'pile': + Result[Index] = + { left : Bounds.left + Bounds.width/2 + , top : Bounds.top + Bounds.height/2 + , angle : 0 + }; + + if ( Mode !== 'center' ) + { + Result[Index].angle = getRandomOffset(Options.MaxRotation); + } + + if ( Mode == 'pile' ) + { + var ItemRadius = + { X : Container.children[Index].offsetWidth/2 * Options.Scale + , Y : Container.children[Index].offsetHeight/2 * Options.Scale + }; + + Result[Index].left += getRandomOffset(ItemRadius.X/Options.PileOffsetFactor); + Result[Index].top += getRandomOffset(ItemRadius.Y/Options.PileOffsetFactor); + } + break; + + case 'random': + Result[Index] = + { left : Bounds.left + Math.random()*Bounds.width + , top : Bounds.top + Math.random()*Bounds.height + , angle : getRandomOffset(Options.MaxRotation) + }; + break; + + case 'radial': + var Angle = 2*Math.PI * (Index / Container.children.length); + var Distance = Math.max(Options.RadialMinDistance,Math.random())* Math.min(Bounds.width,Bounds.height)/2; + + Result[Index] = + { left : ContainerCenter.left + (Math.cos(Angle)*Distance*WidthRatio) + , top : ContainerCenter.top + (Math.sin(Angle)*Distance*HeightRatio) + , angle : getRandomOffset(Options.MaxRotation) + }; + break; + + case 'grid': + CurLeft += Container.children[Index].offsetWidth * Options.Scale; + + if ( CurLeft+CellSize.X > Bounds.width || ColIndex > MaxPerRow || Index === 0 ) + { + MaxRight = CurLeft-CellSize.X/2; + CurLeft = CellSize.X/2; + CurTop += CellSize.Y + (Options.GridSpacingY||Options.GridSpacing); + ColIndex = 0; + MaxBottom = CurTop+CellSize.Y/2; + } + else + { + ++ColIndex; + CurLeft += (Options.GridSpacingX||Options.GridSpacing); + } + + Result[Index] = + { left : Bounds.left + CurLeft + , top : Bounds.top + CurTop + , angle : getRandomOffset(Options.MaxRotation) + }; + break; + + default: + throw new Error('Unknown Mode option ['+Options.Mode+']'); + break; + } + } + + if ( Mode === 'grid' && Options.GridAlignCenter ) + { + for ( var Index = 0 ; Index < Result.length ; ++Index ) + { + Result[Index].left += (Bounds.width-MaxRight)/2; + Result[Index].top += (Bounds.height-MaxBottom)/2; + } + } + + if ( typeof Options.Shuffle === 'boolean' ? Options.Shuffle : ( Options.ShuffleModes.indexOf(Mode) !== -1 ) ) + shuffle(Result); + + return Result; + } + + + function getDocumentPosition(Element) + { + var r1 = Element.getBoundingClientRect(); + var r2 = document.documentElement.getBoundingClientRect(); + + var Result = {}; + + for ( var key in r1 ) + Result[key] = r1[key]; + + Result.left -= r2.left; + Result.right -= r2.left; + Result.top -= r2.top; + Result.bottom -= r2.top; + + return Result; + } + + + function getHighestZ(Element) + { + return Math.max.apply + ( null + , Array.from + ( Element.children + , function(Child){ return getComputedStyle(Child)['z-index']/1||0; } + ) + ); + } + + + function getRandomOffset(Limit) + { + return (Math.random()*Limit*2) - Limit; + } + + + function shuffle( Collection ) + { + // Fisher-Yates shuffle algorithm + for ( var OldIndex = Collection.length-1 ; OldIndex > 0 ; --OldIndex ) + { + var NewIndex = Math.floor( Math.random() * (OldIndex+1) ); + var Swap = Collection[OldIndex]; + Collection[OldIndex] = Collection[NewIndex]; + Collection[NewIndex] = Swap; + } + } + + + return Scatter; +}(); \ No newline at end of file