diff --git a/README.md b/README.md index d6a5ee7..83a94fb 100644 --- a/README.md +++ b/README.md @@ -58,17 +58,25 @@ const main = async () => { main(); ``` -> A commented version of the above code can be found [in this repo](https://github.com/schmelczerandras/sdf-2d-minimal-example). +> A commented version of the above code can be found [in this repo](https://github.com/schmelczer/sdf-2d-minimal-example). ## Examples For further examples, please visit the following repositories: -- [Minimal example (using Webpack)](https://github.com/schmelczerandras/sdf-2d-minimal-example) -- [More complex example](https://github.com/schmelczerandras/sdf-2d-more-complex-example) +- [Minimal example (using Webpack)](https://github.com/schmelczer/sdf-2d-minimal-example) +- [More complex example](https://github.com/schmelczer/sdf-2d-more-complex-example) - [Source for the demo page](https://git.schmelczer.dev/andras/sdf-2d-demo) - [Source for decla.red, the multiplayer game](https://github.com/schmelczerandras/decla.red) +## Building the documentation + +Run `npm run docs` to regenerate `docs/`, or `npm run build` to build both the library and documentation. Documentation warnings fail the build, including unresolved `{@link Symbol}` references. Use these references for API links in source comments and `documentation-readme.md` so TypeDoc can validate them. + +`typedoc.json` selects the public modules exported by `src/main.ts`, along with the settings, defaults, and renderer information used by their signatures. Keep these entry points aligned when adding public APIs. The module layout preserves existing API URLs while leaving internal implementation modules out of navigation. + +The factory return types listed in `intentionallyNotExported` are private implementation types. Their constructor signatures, arguments, and examples are documented on each factory page instead of exporting the base classes. Keep that guidance up to date when changing a factory's constructor. + ## Documentation For more technical details, please consult the documentation available in the repository and at [sdf-2d-docs.schmelczer.dev/](https://sdf-2d-docs.schmelczer.dev/). diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index 60aef28..7225974 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJyNjs0KgzAQhN9lztHiD1JytW8hImmSYmhMSjbSg+Tdi1WhPbWXYRnmm50FwftI4F1Z9QxB36yW0XhH4AvKalUnJg2OSxBPcbUaDHfjFHhRnhnmYMEhrSDSdFJ7hobjyg8sH+NkwbYoOCKpbO3JNoNBjsaqoB14V9RNnxiKuvn433rrw222rQny3xU0ioemQe5oJt9s/l31Y1lK6QWJ4mRz" \ No newline at end of file +window.hierarchyData = "eJyNjkEKwyAURO8ya5Oii1DcprcIIVg1RGq0+A1dBO9e0ibQrtrN8BnmzZ8VKcZMkJ0QPUOyo7c6uxgIcoUQmwY1W0hcknqoq7dguLlgILk4MyzJQ0J7RWTpZPYMDcdVH1g95dmDvaOQyGSqrad6Gwx6ct4kGyA7zpu+MHDefPxvo49pXHzrkv53BU3qbmnQO1rpF1t/V/1YVkp5AoR7ZGs=" \ No newline at end of file diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index da10e0d..f100afc 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJytmttu3DYQht9le2umiWOnje/SBEED9OgEyEUQLGYlakWUIlWSsr0o8u6FTrs8DUXt5soLa+b7Z0hqxNOX/zaGPpnN3aaQTcs43VxtWjD15m7TyLLjVP84PXhWm4Zvrjb/MFFu7q6vNkXNeKmo2Nx9wSFVJwrDpDhhorhXN9++frs6YkoFj7DjVG/iMvPzMNij53b+lRX3uwBYcNA6DnwXJb+4/jmaAympLhRrjVQ54VrmqyJ/F1FhwlBVQbEoFEI87dtXTm60ac2B5PSCa+lRLSJn+9pg3V0wVXBKBpuU2AjZ2uZZbfh2cPjNxYcDIIa3XNPDoeKg69wMTsZZ8b+PsNHwLfZ7RMaPfTDJ6u5Jw3Xwe91G6xpa9DWfWrqCwkh1SOmOmK3rsKLv3/sSp7q1JOIAklWtkFyqquNkJOTk43rkJTT5vPVEwgGBiLiApSInW07Nii7yPDJr3OCzppN8GReR7KaaPsFeihU5eR5ZOf06+qzJyZdxEcmcmHigytCSmE4Iylfkhnhm5fhh8v00uK5JFVONEpOZN9QAWV1IIl5ZGf9ODayvKDG1gJTMUkimD6SV/LBu5Eb9sjL9o/f8a3Rck2tcMUJL5rs+03NynAL6BXROHfUVLO+wiF75ImvaEFHKaTglDfTvlaKFAbFf9VKgvlmNeT9638/OaxLGlRFqpA2+Ou2wV9DWrMBmHvNjwtlOwRBlfLkj+l+ES20IfSpo2ycQNuWM2/rcbZyAz5MrBQ0lu66qqMIWR7SCjhvimWaHZPttY7Ds6M6TzJMa1jYNLRkY+n1SRYmp+WtNeYv2BBXDQsvpY82ajkN0MYjHOapskzy8qSY3+mSo0CvHp6t8ROBie2pIDap8BEUJE5U8Qy1gJNaNEkrSCVZJ1ZyhZLvjItrI9hFMUZ+hcPRNjaIWFHBOOZk2R1YNjsAZT6RVcq+gQYZrpWDfUGGIrqGkikjBD+Tkkh/Q6LJN8RIv9iWSbJl/AX2RPY0kAkrBgUBnpC6AM7G/JKdFaGpk9X86RdHvF5eKnGyyY5tctg4Ab5eSaQOioJdI+YxEDwOnxlwk5iFwrQs0ctlEDnMCfYHGjMjbTWLcUMXE/k9fl4quOUfVJ7ph2JPhzwra7yZrwXDFT6NTIGrtna5XdqHhXmog/5mZOgjBHNpL1C2mF8Hz1z+9uL32ZsSdYA9UaeBEUVEO3TXPNNaMvAQmVaeOxti3qdXk3w44M6cSmPxMHoHbuGveq9Dqv0fPNxHNeSWYrxnjpTfYRiRpQaNnIXNddE2X28Wy38YgS5v1FwmGCFzuEp2EQNjM6ER+nnHDMCO1jHODoWobZ+BZ9xsl52q5vllDfTTu92Gip3cr1CxSeivirNRWJXUfSMTKekrlPi7nnYfN5oQ1Laf9nBcWNgISmh5k6b3oHdLLrKRWuLpKN+UHR2tlc45yNirWrs75EDWGiT1a/KbtCdUJwxpKLPPl1piNtxglq2Em5/vR92MQwAMoNmxmnRdCHO9G9tItZjNLG1Cmay9sFJ+yplE+jr6XNkoQQhyfbJTLRshZIwMdEum3BhdNDgK/Jl3W+2f1OtrdmQkHoskODovFtFLW/cL4gZWZn5bAK5woZO/4DWv0UHXaCxqe4vW84NC0qPPwNOEsS0oqqci4JIeioLHp0gyLWafgwzJfEm2mOTqGdewWgFhRr+lTWmE4Cs0akQ7qNJuJwHygfyis+WJMmufFZKPQmHqYD/QnUPvdUkxqv8ub/dkoLKYeFgDDmK5vbzPCur69zY3MASaC65ExchgiZAQIueFBVnDwLGRGAstrPFjRepDbfDC1Xwifzs/sGQY3QIaPUwG8wA40Jomodd7Fj97zE2vo24jKvPxOqkQI6QU3fWqloMIw4KSkRaKaB5aJczGpGugPbPDSeTJJn60UstkxAciOoHWAYhsmlvKgI9s78+kI6GDTxrpZwfAy3TC/PtuOOuNTYhslFslds6PDF2fPNScVl4CnEzPG0Y/AcFT/MLWf0ACLrP76/15yKS3g/DBeGjkd4Y/Umxevb14+v7Hiid5wxHDzTUIUhtwwi/Amy+OFNwyJXj62WbMJBklWixA4FIy+XjglDIWjtx8t4slmCRO7rosDnSvEODp+Sy6GHSyXhw1+FBBCq9n2dFyBYhN3YS2gbYWhonPFE2N8jDljd/CinN5yucWi80SLo3nCeeG+XIibr8mNt+SWo0tcTwvh/a203PqSvA0WoodLYNMtpmV49BpWCJ14u9FsAZYRZHZ84S5jCLM2OzFMdAcWI4nJDIXF1gYWZHiccI7OQx3/0SKBiEyyHQAsuC+HAOkYFm+cRaCjy/Ge2XLnq068EaxB9nstcifAssNw2HFkCJxO/ZarbeqIEcU+MlMvo6PHtSHzUUGLwbw9OgJ4YzqP85Y/0c45rYFcom0dWwD9D65qAkA=" \ No newline at end of file +window.navigationData = "eJytWVtP2zAU/i95bmDrVrb1bQOhIe2mgsQDQtFp6ibWHCdyHEY18d+nxAn1vXa7JxDxdzvHOYnDw9+Eo2eeLJO8rhpMUDJLGuBlskyqetMR1J6PF85KXpFklvzGdJMs57MkLzHZMEST5YObZNvRnOOa7mmsdBfvXx5fZq80GwZ/YE1Qm9hlpuum2VdkNv0W5PvKIMwJtK2d8MrK/Hb+0Zoh3aA2Z7jhNQuxKy2Pcn5lUcGUI7aF/KCQSaJpLy6UbAQXJXc1J8csJygd1vgSC5JMXh6U+HIAfFPpzXbZ6CWov3lbAm0ZmmC/OMj/tYXbaV/ivnbICO+y+7aExnnvjAXZQs5rtvPFEzSZCoho0bUusR8Gh0QUAu+oyGtSs21HUsEQkkdFhAUaMZeaiNk3h4hKcGhy1A1BPKJFGiJwcAyYmCbpMiqFt00leoaiphGZNERQpq8CE5NJl1EpvJkwfUKMo03KO0oRicjmQAZlvBmxdwM0JqpL1croTV4hDmn0ILGgghJ/RxziJ4pNzWDypqQ1bndpU5Nd3M614oKS/uiRvwQwJqtd0cLmzRuf9JiMo6Ev0IbMUV1BQptDdKaLxNTQoRRSOFZz6O8rhnIOtIi6KZzYoGKuBHo1gWMCu5UdrJYaqO8dBYOmxLnrzWO6nBK8ZsB25/3fO4amn2ndDFbNqk3ITKfIRmimUYS9iGHCEcO0+KnrItpVx6jqjKoNeYPeM2j+m6xE5la8EyBDVDokxCurpOahwZC/x7w0LPBdc4q6xKk5ePPpw9vFXL1XEd0MLXJsUnEdMcflftKiVFrk2qmvOtm0OFOxQVtULO4HufVMHaEmMfln2VHRokKtDAnbHvSprOxy2il1Wp5iuq2PyzNAo0LdKFqRwYScTGVLqBz1EOeYFs4PJWgLHeEp6yjHFUql5YerMS3OXCxBhRnBK4G9NQw8AcPDc+k4C3Z61dk7dQRMXC0HxrvmxKLoLDFFuRXYU4tiWLDTe4ty2g45amc4t4T/rnGLejeBPh1O6/5RXXe2OzCwIept8DQsHrWDOGmcT7fhq4VrlpTo2ayRoBOfO4bDdFAhFKr948xCphPqnxVactBTS8I8yVROTz2ZTqg/QYv1IU+sWIc9/mUql6eezCA0Pc0XiwBb88Ui1JlC6DHXU9qYTYsQYBBC7UGQOTgzOS3GwooHEdWD0PLBWD+TfDyByQ82wiEdZmIOJO8IWP/pMEpYV4d9OuyRd7hClxaV6SjvVbEwHPqozTqaAsUV9HUyQymXw5rQ0c8m374TKqO82taGfwyX2Wo=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index d1e3a1b..16c0e91 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "eJzFXduS2ziS/ZUN+ZUqK8G733rs7pmO6Nva3ukHR0cFS0JVcYYitSTly3b0v28AJKVMICmBElXz1OoycZAJHAAJHFz+XNTVl2bx5tOfi3/n5WbxRniLMtvKxZvFutru8kIuvMW+LhZvFttqsy9k87r/+91zuy0W3mJdZE0jm8WbxeIvb0CJglGYx325bvOqPAKNA3qLXVbLskUwxzyOlm7q7Ev2oGwbfllGHz65H36dtB9EckB/Z2L2KTjMd+PgyBfG3mPWIeAqKJu23q/bqp6c+yua2NWSAwgujZU41udGNus6311kEkl7jUViFRwr6Em2vz78S67bj9UHWedZkf/f9Mp69STbSqO0VYNQjla2zWaZN8tdXbVy3crNlVZv8/Jd3rRZub7A2G1ebo6JryrJE61oydT1eINCX59sWyKMrLb1zs4oL1tZP2brs3nZGFNbH/ZzhPVyu2u/zWbbqwHuAgsZzDGjOz6/rfZl+2GdFXK+wn3VQa8VdDNA39aZXV3tZN1++58yf6zq7c/ZbpeXT/N5NODvO/ztAf+2bjWbx/l86MBubPBztpH122r7kJeZGsg/tHLXzOiDxl8f8Zse/7Zu9dWuG8vP2bquflF/n82rHl43mK2CLzv42Z3i+nPd2ywdYiP64elenMmnyJ+e2+b1Oq/XhVzq/zuRWff1Pf7aOSZ7qxP9RHKwB08uB5TSdZjg3LomXnMxa2L0xpiIIcdIv5aK11ebOqBYsVJePss6H42VLrW6KuYo36J6QZtVB1I2OYohLrQbA72Q7frDUjbNe9UfX+vAAa3u0cYj7P+6qVtOExknlyZNa9ytvWaS42T35CnP7BVywYzIybOx+dFN7W9k+9OsTaWR7fnWMp8v4yP6Y5E1z47j+fFb59H8Bxt+tMQQ/A+ncjpVGMidGcbxcYsuG8RZvGtH8FNGXjl8T7PXbew+WaZXDdyTrN3ktdSLlVdZjFFuwYEJscUJK2cILCZZPTWqOGH6zUKKSQ41bVa3b/dt9fh4lTcaZz3g3IIwUyKfU7y+IOw5Z+cMMc8Ji2da473El0nBzQkXZolsJll+QVhzit3zxTRnvRgPaPR/XFZEeofo95MXRprnbCcPQdhjpgKCbydy7b6/p9+7Cm5ddPeDkclRdjuXDUnvGlnxHrqVihrQH/fFskvsUCw0gfuiUZ/uLc3HZvFIPjT91JIxvLwm8HS3b2IEyttqAF8cik4x245Jb2Gx+urHciO/zlXYRVXnPd5NLa+zTb5v5rH6gHVTi51ijglWTwo+plp+TRQywYeZwpGrvHOLSyY4NU2anmz7+DiyqatdIVv34dVI4Dq+vuuSTRhgzYwowsSBxHTTqWye5dfsqSrdy8ZI4Fo2/+iSTSgbMyOKMLFsTDedyiYvP8u6lZtluy9LWbiX0UhC17L6sU/+UaeeUGRj+bKAE0twrDCcSnIr22w5NchlErmW4M+yzSZHu1x+FtDEUuMcdyqxssqbb8tdVXyb1DrZZK6l9otK/FuXdkK58XkyYBPLji8Cp9KbXG5TSgzPHHoH/5Y1DoOkmQlKPLFoxgvl4jnDOeMumzCcQB2LB1U3k6+lQwx71mQEdTt7p8SvZy0eCV7dVj8m+TBDJHvWm1vJiJc7OimoPevfdUtuk7xA3fT0Hnoki8u65Ys65LpqMxU8KL0jK5+mhAGjSV2HtfcdwPsh/YSCG897BHRiWY4XC1eqT3W2e87Xzevhx7LIH+qs/vZ6XZWt/Noui6ppl/LrWu6INjWU7ZDu3gS45wEclzPH7Xqss61cPuwfH2X9eiMfs33RLvEfJ5iIk91zWPNaO4eVt7NObzvcyk2etXKWAh0FvNruZ1nsZP1alnq3IiFak2/3RcZtIh+3uoO7Pwk3s83yqxZAJzUoauYBYS7LnmS7fM7qzZeslsu8fKymm2ZBzGVbUWWbZb+tdbpZOPVcFjVttfuStevn6eYckl5tyy6rs6KQxbI/sDSF9Fba662pq6c626pe5Wkry3bZ7a5eVmXxbdn/4xQDuxT3p+Bmszm/wsB8dmsut2VuS/pWs8zqOvu2zPZtpU5g5OXTFeV1FvNq61X/va9lt9K77P9vgqV9inuSfjarhvj+CsNMiNls22WFbNtrTDMQZrPscotuZMmy0gFtc7lFA8JJy9DOxbxoZZ2XT78aGctyv70kWxPw9ExjesGg1Y3jKbyffvzl++/e38b2V0Veymx8LWmyC1Y2vE/Ko+8/fLyRU8ol2bQv49WRbr/X2W4upiGsFyHZ25+++/m3+4+/3n//7u/fz279q3WRbXf3bXUvN0/jwuP0esFFzvr184/v3//6/vt39++//+37764nnOXZNq/rqpab+1ruZDYn5876diuXXsgTfNL4Y5fCbD3oYN90vyjmDVsRXojeZl+7vuJmPrzaZl8fhyzmqiGj/Mecy8ubO5eX/yHnvtTZ7sPtHFPw4xrILZ36eFun5uwoRp0SqzSGUJj9xe95+2z2Ge233TX+IcgX6jKqz7Ku8428mQuvcA4zVxWugbGd99W+RkrP3M4d4F/EM5dpz77MP8u6yYplLcuNDhuHNdIJU58TKFMnZgeA14+7Zvm/+6zI2+M6wqlFsEPKez6l+yGyXfPfXerv7GwH8c89Ww7OsbmeLYzpOv4Mdjsp+84+sPmMtc/HXfOPb00ra9nktuA/h2+Pu+YZ5/CS3vUrZd9rDWBzE/f6LOQhixeuvY9Z/STtw5kz1Vw7oN/YKxEJCI5+/fDbh1t59AK+4O0O2WbzThZt9jHf2vsd5nAp22w2KoM2P3FpyXy+nRpful/LXdY0x1Vb9EeXkQZ9fs9hXD76Yeu6o0PX2GYjzGPZFSbNaIusDxsaMq1ODn92t0nW9zzEDLapfYkX2kSTum5g6b5XGyq5yxIn5IeAJkcsY+5PLb2Lys2t9tCiznszF27+eSqj9+M5OpYTU0L0jFFWfs6aD3in3VVGvuoAG3OP3VR7D6jjp8ob3f3MZDaCu6HRn3P55btaZjOWt4LMapndpMStYdw8kXqd7WrcPiLe0PSNbNq6Yi9IvMDsI9otTc6bXZF9+1j9XtXF5m1V1Rt14Zyci/A9flt9Ufhrgn9Dt7oPBx7N5Uz35w1CvaELjWzf70sVa36QbZuXT3N50ci27oCbI/BtHfln3yHN58HQH93WdE3aj9W7jsTztw6N31Z9I7lp65gUryzz7a6Qam9Tdnpv7QlXDYwZYtEj8sk9gCdtOrv1j4mrfsTZTazwLkeMdH2Q1fk/dkXvsPvyYo6OmPyKIF9pPYEfXXIpqqz9URm/qwpNInN1aSbPdEY5zuiCNaYrHM2b3+XD338Sc/uVN1/kw1MhXsiNfpOcvjx2bld67HWP/RLuWJO3mVxBuC/nxm9dRjdxZTdgv4Q7zeZRbP4pa7JFfSZ3NPbnA/aLuKOuudrv1Jrlj+XPeVHkjVxX5Wb2quozUmFfXm5pRi/h6GdZbvh77a/x6oB6IxdOBiZD+Hw47NOH1cvGDNhPxCjDt/djICfDFR8dQ+vSj80ZPmd13h3HusgIHn1yLHO+yC4t+57f15W9CTKx7D90ya8se8sIHv36sreKbGrZX8X3STwnYflFs+LxfGfj9Akuk64w2z7ksmzpve1zWv+qz2G4TPZ6V8xsTt4l9Vu30f42rukcdoccXs61QSLrRgr9kshtPBwy6gCaPqOXc7Sb+/wjf3p+t8vfD7i38bXL6zl/et7s8hrl9XLu5o1e+hyujbmNn3mjl3ryYyYv56DuBbobWa3rAGZ1UmfUXdl69u6rmzna3Lx9dtn8p1rntlLrE38r9q6x9ETvOvyHDv/l3Oo3B95mNH+F0F/QpbyQP++LNt8VufMqwlTH8kJucR43dc8tKrwqEp8UgeOocCz2dixuK9/Zou0TUTahy0O2/vdTXe3LzVtyO/ycDrw6ZmJfIH+pQ2ZOp+OKt91OlZ+qpv1g3Ygwq69dfv3OGHVnAr6B4aXd/mCdyr+Br/jo/8s5mD+VVS0nrWBP9K7LYfpa9tWu6aH+18+yLrLde7nZ01cQZvVRZ1V1WdUoqxd29jdZylbfSF7SW87nd3Z3zMq+Av3WzvYzyAk7ZCa62Gcwdb/M1Y6puyiqLx/rbC2nCDETvetyaVUukyWZS1w8GXn01zboq9U+5xu37XZWIkeBur9lRV8RYeXT36Oi/3Eanj64O4an/3EiXrWRy8eqXnY3RWTrtWS2uQ743MdT89MXUlTLpiWrBVZO5LML8tDX256E17fpum43xWDHbaYMHAuJiG7b6OBJU5zzpCmcPUFgo54oOBZy3JOmcPCkfno440n99OC8BRiBjXmi4HjIUU8UrJMnIgzPOyPCcII/GPKESwp0FPuUYwrfybfsvGfZBL8yF6+yuxHUUx5ljv44VVY2rbYyx+rK+voagT/p3pka0wdNlnpivs6K9cjNcb1F7MfORwYPh2be2hkNx2dOZsQAOJUG7+P0Y4EXGed0EPCUoRyy68bg6yw/tzF4LqufZPuL/NqOH6q6zPwn2Zbya3v+KNU1fpjtSX7dqV1dbZ4Vy41cj8du1ofTYhQVU2bqisbREOj4xTRkdYUhfg98DN/8blouRdbYh6eH2wqzxvVIdI+2zUdDtW1+OkazsZrz4SX+Zhp6ud8+SB2ZPhVNsdQ7Asdy4b6dltuXLB9FV//miLbNcntvrvrjyfQBpIG/OvdSlgX3qrvZ/3iVMd9otU3nMqPS91hWp+Xrcxnxz1wxefUfHt7duii7/q7Kk/kMX1yUwalR2s7s0LmS4OGyjMeeh0O5nTtd45jFO/t2+fHMHJ4+Opst+4QNl6X+8Erqj96SZ2f4OHx6vMnvsizHXyxGmeGPLsqGm5Ef8Z9PPAR2BnjkIR02D/XhlTXEzcdRHs14RHsG+PQjN3ZWwz6B7vmZK70afx/Gzlg94TJLP3/qeRU7W/36SX/X/pUZc4+U2Bn2eT10X12T0Xnn5vHLOuRrZ3R2Y/mZLLr09Oj1WC5l/9VlGTGrRSgD/a+XAnPrAQS7++BSeHv9hICPn0dzgD5renaF7ecehmAy7FIcnmu4ksD1vvyuzLf8gTKU677M0GcXZTVyy6GdWb8v5MpR9sQlaaNZfsnb5yuz5a5BtfNTV8dNzEjgOltmo5VG/tV5eY2jwXGNjWLij08vKVFL//rDW3QvkL75czEc6HizEHf+XbrwFo+5LDbN4s2nzihPRe/qoOLCW2yq9V7//KP/7J9SsV593H39erXwPq28ILkTkPzxh/dpSKz/Qf9hwDj+RSeEsYRgJQSSUCy8T+CF4m4VhyShsBIKktBfeJ+EF4R3vh+ThL6V0CcJg4X3yff89C5IBEkYWAkDkjBceJ8CL4A7ED5JGFoJQ5IwWnifQi/w71aGqZGVMCIJ44X3KeISxlbCmCRMdKn66Z0fe4Hnw90qJekTK31C0qcL71PM1UpqJUwpDxQtEi+M71JaRmAzCAwKKWKkXFKGQ5REoFm04tLaNALKI1DsAODS2kwCSiVQBAHBpbXJBJRNoDgCPpfW5hNQQkGkye8HdyKOPAgUReI0oig2uYCyCxRnIOwTexCxMDbVgHINNNlYtoDNM6BEg3SsNYJNNaBcE4o/kHC9jrDZJijbhGIQpGxim2/C6LQUhcSK7baYfosSTuiei+/zbMYJyjgRjHVCwmacoIwT4Vg/JGzGCco4EY11RcLmmaA8E4ovQrAO2+wSlF1C8UVwzUTY5BKUXELxRQRsxja7BGWXvxpjpm+Ty6fk8mGUmb5NLp+SyxejzPRtcvnGqKjJFTLF5TPjIuWWH4yy2rfJ5VNy+eEoq32bXT5ll6/7s4iz2maXT9nlx2MtwrfJ5VNy+clYi/BtcvmUXH461iJ8m1s+5VawGm0RgU2ugJIrANz5i5jrtQObZQFlWaC7sGTo/EXqieQujgxjbL4FlG+BopDPciawCRcYkZgOxWCwwRddxEJRmKiMMi9QXPJ91gSbeQFlXhCNRoM28wLKvCAebeWBTb2AUi9QbPIDhvKBTb2AUi/QgybXyAObegGlXrgajWJt5oWUeSGMNZfQ5ltI+RaKseYS2iQLKclC3akNDPV8NlAJbbqFlG6hphsbqIQ2y0Ij+A+pDQlrAzMToHwLNd9S1gabcCElXBj3Nviq8rxg5fnhnVjFXgD9LwpokzCkJAwVrwK2HwptFoaUhWFKrFGtF+6iQBUMa41NzZBSM9LUZIfryOZmRLkZAS2b8FA2EWdNZBM2ooSNFAcDli2RzdiIMjaijA1YtkQ2YyPK2EhHeyxbIpuxEWVsFI51bZFN08iYseopKzehipg5K2VpNDogRzYhI0rIaHRAjmw+RpSP0eiAHNnUiyj1YkWmkI1eYpt6MaVeTKkXioF6IdsQYpt6MaVerMgUsg0htqkXU+rFikJh6EFwJ1ahF6qx/S7QI40norsgTL0w6f9GoW06xpSOcdBDizuxCrww9QTcqU010coT4Z1IEi8CT4i72BdeJPp/pZnYtI0pbeOQ2p96IrgL0lQD9r981n6b1TFldRyN2W9b7UVB7xPNxKZ/bKzZxDST+AAdHn5Fh18xmwmzvEPbSZz0mUR3aQoKuu97o4SlnN14Ytp44pSUepQOrIlXh1/Q84dC220rpm0rWRFb40PziNnmkdjtLaHtLYEOUMAd+JEXs8sfid3KEtrKEkHtOowYMTtiJHbLS2jLS3xS8/FQt16cHH6lw69kxTWPxG6DCW2DSUCsTnT1qJXzhI0BEru9JbS9JSEpzUSwpWm3rYS2rYS2rYN7XuIfXA4Ov0KO9ondthLatpKYOj9UlJfEfTFQQLsdJcY6KW1HBxgvYdtRwqyb0naUpGOAKQtot56Etp50RaonXTFzpNRuMiltMikQsxRK11+kLGtSu/GktPGkivopGzmmdkNJaUNJFaVTbk0ntfmfUv6nir0pN29KbaqnlOqpomwaskbbBE8pwVNFxZRbo0ht3qaUt6liXRpzaW2KppSiqSJYyi2ppzYbU2MZX3EpZePHlFnJN5fy9frqil1WX3HL+cZ6/kqvgq3YpfUVs6a/Mhb1V92qPru8vmLW9VfGwv5Kr+yv2CX2FbO2vzIW91d6dX/FxmHdP5oAxgr/Si/xr7iJevdvZnpjlX8V6fQc57p/M9Mb6/urmA7q0RAAwioeRnVYscFgl9bENxb+V3rlfzX0bB7A6viT7Vi6JCasIQmsUq3I8PXOqAIrg7cwunILnAplyVCatrwyw0pRBm07MQq4Lgo4OcrUo3pBimUNJ0mZmlQnSgHLGk6WMnWpTpgCrrcCTpoytSmtMgEkQ7QOcAgmQawOFBTQf2DkwPDa1K064QrlwMF6IATLbE7RMiWtTtOCZBi9Nezwkw1bgdO6TLFLC1gggkMrEeHxp26dEBryGyeDGToYdEKYUCuod6GvsNhFYWBUMTBkMeh0MZGwnR6jjIEhjYFWu0Cw+gUw6hgY8hhoxUt5w8zkgVHIwJDIQMte4PNyMNMADJkMRKfMsuMWo5SBIZWBlr/AZ/svRi0DQy4DrYCBz3ZAjGAGhmIGWgUDnx+3GNUMDNkMtBIG7AIzMMIZGMoZaDVMRaucps5w0FDPoJPPfLYHYvQzMAQ06BQ0n92GwEhoYGhooHUx8Nm9CIyMBoaOBn7QNwFfdUqBB8GKbY+MqgaGrAZaKYuHvRxHUAOJoaWhsYHWzSDgdzowtDR0NtDaGQQsrRmpDQytDbR+BgFLa0ZuA0NvA62hqde9uPQMKw3NDbSMBgHLakZ1A0N2gwBO9EuM4AaG4gZaOoOAbRaM0gaG1AZaPYOAbRaM2AaG2gZaN4OAbRaMzAaGzgZaOoOAbRaM0gaG1AZaPoPwMPeEEA6jXyg8Ed+FJq8ZEQ4MFQ46GS5kecXocGAIcaDFNWLWYIsHYcCO9YxEB4ZGB1p3g5CnG0NXQ6cDrb0pW4ZdPiG/P4eR7cDQ7UBrcRCyzGGkOzC0O9B6HIQscxj5Dgz9DrQQByHLHEa3A0O4A63FQcSO6Ix0B4Z2B1qEg4jt+hjNDgzRDrQOBxHb9TGyHRi6HWjZDSJ+sxdDUUOmA628QcR2fYxQB4ZSB1pog4jlIqPLgSHMgdbaIGJ7LkaaA0ObAy2tQcTyj1HiwJDiIBJGW4hYQQ0YYQ4MZQ60xAYRy0VGkQNDkgOtskHMcpER5cBQ5UArbRCzXGSEOTCUOdBqG8QsFxlxDgx1DrTiBjHLRUagA0Ohg6jb7sdykRHpwFDpQCtvELNcZIQ6MJQ60OIbxCwXGa0ODLEOtNYGMctFRpoDQ5sDLbdBfNg5A3HK75tkuGhIdaD1NUhYLjFyHBh6HGjpDBKWS4zSBobUBlofg4PCBok4zNQT//gzYOfRjN4GhuAGWhuD5DjLTaLDPDqJ+xHXgGU4bEhsEHc7b9jxiBHPwFDPQItfkLALo8CIZWCoZaAlLkj5imNIbEhioBUtSFnBGRgFDAwJDJJu+yrbCzDSFxjaFyTdJkN21xQwUhcYWhdoWQrYhXhgVCwwZCzQKhTwi/HAqFZgyFaQdNxl+wFGrgJDrwItLUE6sm+ZIaGhRYGWkoBdmQdGeQJDegKtHAG/Og+M0gSG1ARaKRKrw5qrWMHxp2ADV0ZvAkNwAi0diRVPDUZqAkNrAi0VjezpZqhpKEuQihPLF4y4BIa6BFox6rR3q2IYgQkMhQnSbh/sYWO8WPGRNyM4gaE4gRaR9DakAYuPXBj9CQwBCrSoJFbpAQv4ZQVGjwJDkAItMgn+2AOjSYEhSoEWmgS/Rs/oUmAIU6C1JnY08ATwC6yMYgWGZCU6yUrBdiOagGHs8gSEx58RN6IJRtQShqgltEgl2NVxwYhawhC1hBapBHC9hmBELWGIWmI1vuFWMKKWMEQt0YlabK8nGE1LGJqWWI3vthWMpiUMTUtojYo9KSYYSUsYkpbQEtRI5yQYzUoYmpXQYhN7bkww2pQwtCmxGj0ZJRhpShjSlOikKT49o00JQ5sS3Rkp/igFo00JQ5sSWmsaORHBaFPC0KZEp03xgZNgxClhiFNCi038/lfBiFPCEKdEJ07xgZNg1ClhqFNCa0n8llfBaE/C0J6EVor4TaqCUZaEoSwJLQnx20oFIyEJQ0ISWvvht4QKRisS5pkpMb7TUXCnpsxjU+LEKqjgTk5ZR6fEuMAk2NNTBgc7fYgPXQV3gso8QiVOhJ6CO0ZlnqPqBCI+dBTcWSrzMFWnEPGhn+AOVJknqrTkw+8QFdyZKvNQVXeqCkYMYGhonqwS4ztLBHe2ypCIRCcR8XsrBKMRCUMjElrzGalDRiMShkYktOYjxOoQTAngginB6EXC0ItEd+hqpDQZwWj4mz7I3V2G8mN3oPvTp8Vwm+2fi/v+lLeagOuc1IFvNcV+8+dffx3Pdb/58y90tFv9m8pMvQt+vIQOgUGMwMAd7HANEsLyfYQlYjcs8nwTAgsTBBYKN7DjafsjkqrKA5KqLCek7s7jIwou9CRyw9i3lX40paYljsxRm12mQOn74JBR4XSj1FPSxB4RYgakTijW2woIL14hvChww9s/PtJiisQRJQ66ZB3XvUXs5moHOjwBR8BXJrgr2GOd0QYUIc47tsUeSl9SvpWbPGspImKao6f45jNE/BUqQzWvd4MqP2dNd5U7btq4UoVbka2l8pB2XaglrrpkPnT/Ddz6i+HquiOoj7wMeqaEjs7S658QJnI38LvUau7kDmp3aLijTQZIx5JUl6Lft9W93DwR39PoCJo6csVqsCmqlL4yul7Scx5ezIsFUUmi9hGEg9sTUDscjIjaR+DWfdKH9PAgk+JBxrF+ycWkqLkBbiPOtdHflHjEQSh9E4Gh2CZhkkqOEVEStyGQXBqMih+Vfm9e2pOmNzeIuv9GfXWrLZX9h+Cas7o6iHSKyP447uFWbl1Gfwcu7hgjXFNubbAfRvonpI4PPmE24fjHsT/rYfv3IXhYPEAHbj0beykmLgFsaroaCOZq8/E6yiMmapZ9xQ+9XM8Tv6+3sM8ucs6tuwIaD0c4BBbJQC83Ym9ydc+XGSWiQvbdOoJN3uyK7Ftb6fcO11VVb1S/IGnt+bj2hGPtcc9iIkwcv6jdDU6YTMSORs5+kIO+7QaHPseth+VuKkW9DxqlBlzHkuhxm9fsjAONXIhyE1DldtdSamFmufW3R7TuucTX9igImASOtDdR8d2lqApRQxZTve+RbVBUYYFbn30EbZ6zneQKQaDoL3BsqhZqH2iQEQnMAHA6bn/tLYFFg4RjaGDB9ne1ElhUCqFbHGTBHt9WRd0v6hPCqRTrcdWVqAQTkcsxpLYw9X2nBBS1hehCcvX3jBJYVK7RhdXVXwOJYUM8D3W1ll6hjOoetauwHxVFFx2dRbV6Krw+4ghx4pVAPFHBCxSRG0XHHjfGgxaGdWS+9dYfNhPPbiO3rlp+XcudOfTjlabYjTnyayvLxsCJMI5bV3zAoTFDgF3z3RozQzeRmh2u1/dkXt/1eH1XMcyYvb5Fen0T8lw5b9/ijSapyJtUDKx3xOUHPTRIiyGiALchpX/uAM/bUEevBF5nFL2Cs6sKPRfsqLqh9YijbN+NEo9Ga0wwhuN0/HFH+YQ9VAe8HDGevzWtrGWTG2jYItd63DX/u8+KvP02tiqKKe8YHD7u1LTpiQ7bQGItcGvP9rIe6qwOy49ufYz95gued+HwMnUz7km21cO/5Lptq0bWeVYYi3N4PO3bQt+4/X5mFA6N2o2C6qkP2kLC6S3k8Hjh8IOYHJpdrjeyyusdpvtx70zcN/ikn0YmvXPJMAXo8ZIeLxlmoz1e0uMlPV7S4w2z4LTHc11eYF5pNNvfCi8zOc6oGNjuFyU7jgKGyRvAsEICV+al3/GyFmMA97+uksGpPPob1nEOeLVUTGQck8PxvnicCa4WMSx5+sOylu/W2Z569pPRHtTRErScM1SZ40qmw+vmNDPc84cXl6P5jikN7DAHI7dR+MTTpjTIw9ixG/ZzVm9MlQuLUrEbYenrp3hExhXoGDDSp08xGI6KHbUo9O4pxRLTQwX8Wh8FI0sWbkMf83gpRiR16da5Mo+IYuWC1MSkasWPeWJEIpm5xTb8o5oYFHeXyTTC4NcsMSRu18n0qkYPSmJUXEPJpBrS4Q4NdXDlOKqP9gt2FBJz0nHdnjxWR9HwGJNOKkMj5hRkgHeUfsgrdDjYwj1COqkS9Bt0GAqzOXUbYQ5P0FEkohdMqszuCTmKFkyPJ8lzchgrxliuLdbomXD1DXGmcJw7mO8xoeUeBBsOobnj9Mvq6jArhtBXOG7YyZ/KqpZf5MNTIejwiqvVUY/Jt7tCqr9YO20Ar0H2cdR5uPKxIiM1mCO1eyiWl41e0aYCDC454Qqk12VaQzZETOujRWcn2Ueu0OolaqnhgYBuHUneMDUb4DHHd2uweaOVLG51GfB+HAjdDCvyhzqrv3FTCByXOoZQA5o1V8ci/oVbhQbsYfwpTaUpwhNWMiGdim0MHVFq0n0qYFFlpKrwumji1rcaiOx6a4w3wLl1swPsLquzopCkQ4vx1jW3uP4AV1dPdbZVRHjSH2BYNBo4RlombE4W2VHnkbi1dROv/y9BxVXk1iOZqP1siaCiztxxN+CA2r/UZE8DErxvxG18MDEHMZvAokAzmdaMBlhmOw8exh0DThO1/y9ZvkbdPl0jckbfl7l6mYlGs0DiT8fFJntbGZ4ITMBY79vq8ZGrG8BbGsFRStSYpWyaWkUFNEBDo2a/NOc4nGvQ6rOsi2xXy83e2rQBMVHrXYn09NzuZClbbWtpWQy4b1IHzp1Rm9ENG9jO0NXOUmakMaaoYhzXjvXj3DiEwTM8xzmPUgrJeBubY/ewSHsWqnvFGZOD7Ah1Gwe22ddObqKtCceejnMK5glQFJKhOosOAbejn3nJNS0c9PSA/bTA7yPdsI8rHVm3zUuuKMgOc7euapvXdVXLzX0td5JOlFO8fcfR/0q1rIdiTw3DURQ4bihQjUBSAuL1FMdVAPbVVVTXyMXoIFG6tdNOm1lX+7K1dS08sXSriKosiGlxOjmi4TRYRAnHwUt1vHW+MbazkSUYx328/VBtbSqPydjl1mR3mXEaBo8vlysgCpaNVABSC98NrbCnogJPohy7Eo3FKD+CqLCOXjLbZlAdOO7GIQ8KIyRUUNFhc4tbIx9vmSFeDhh6YUdBiIu8V2ZrQkKhY+V2qLrB0yk32afrbOJO1u23PpzfZruduW+GnLxwBf2cm3yJyRqXG1Av2dP2QMZZN97V2Sbfk6aAd8U6bmk+PM5L6IGP37jRl2tLq/E+xBHvsJeMrj3hHs53owQvVZIdHMOy2HCGBobAGg77dsWUwlACHF2FUxdDIsvdWga/74uEnI7THPLwNi4GjCUOvrqxuQPddU/qEl9x4TruTGXCJGSb41q7pT7hPn3YzyCE26jPCU+4Rxq6OeF4fMvWnMgJpmE923FFlZWbcJc0bMcQwpFsY092o84Bn6Q7lKYjA/fGIVK8+Ot4iJS+741nPfjI1XB8QTgeO2BlftxaA8cCPHWSBVd16NaV9OdTuX1wZFO94yDWbB4pBu6PXBHEZngRm7R37F3gCCbbE2scKK4TfeTpGAA08uSRIrxjGHzHimBrVFgMOew68YatIZ7z/o1Gtp9zqXZZ0D4C724Hx2bSPGfGgIx3fTjOeToQfDavlcYuLFICzqDVl7bO1tIO9/BSMzjGHuyG6wivp7j1Tk21r415CjnT5nhSUO/m6VYCCZ0RlOPQz+0Lwt2v6/6mU+fgsFQCjlv8ezzVvvJymxdF3qgN8BsjAMCsdTxC0rRWpJMQRgxtzFEtZ1aeMR6/a9EVlVsRQKWZDnuoHc+n9ahG9WACRm69Xw/0JW+fGROB7JZdDfGLYxzd5oXc7os23xW5EU3jFgeOs157Ky9R5B0LjgbZSTROGM95Z0QnKpOpODLNcQGf0ZPw5gBHIbFH0Z3lNlvXVWlotWQfiVvk+FmWG2NvGl5qgMAVpm7zNeUs3orpeIJkGPXsGxLw8OIYw2q5va36g6SjJ0ixt45B4pc623GNHk0I0uE0vmNYoSCN5kn27LsN9gqFjqPkKLLLHQt/eItdvpNKH1m8+fTHX3/9P3t3LQk="; \ No newline at end of file +window.searchData = "eJzFXV1z2ziy/Su35FfaIcDvvM0mmd1UJTMpJ3fmIZVy0RJs8y5FqkgqH5vKf78FkJQaQENuSpT2KY4tHHQ3DhqNbgj4uWjqb+3i5eefi38X1WrxknuLKl+LxcvFsl5vilIsvMW2KRcvF+t6tS1F+2L4/c1Tty4X3mJZ5m0r2sXLxeKXN6LEoRPmYVstu6Ku9kBuQG+xyRtRdQBm38de0lWTf8vvpWzjT5bQu4/cjT8dlJ/xdIf+2sQcWmCYr93gQBdE3n3XEYNDULVds112dTO59yu9MVWSHQi0hs/347kS7bIpNkeJpLU9RSLuh/sBehTdn/f/J5bdp/qjaIq8LP4zfbCuHkVXK5SubgHKXsquXV0X7fWmqTux7MTqRKnXRfW6aLu8Wh4h7LqoVvvGJ1nywCy6RsbaPaHApw/OLR7F1tx6bXdUVJ1oHvLls33ZGFNnH9TTwXqx3nQ/ZpPtaoQ7QkIE0yV0z+dX9bbqPi7zUsxn3Kseeimh2xH6vMpsmnojmu7H/1bFQ92s3+ebTVE9zqfRiL/t8dc7/POq1a4e5tOhBzuzwE/5SjSv6vV9UeVyIf/YiU07ow4Kf7nHbwf886o1DLuaLO/zZVP/IX8/m1YDvJowawlf9fCzK4X587J4fOraF8uiWZbiWv3vgD/vP30HP02OlV6pRu+0HuxFDesBtKS6b0ytU+IoilgToypERAjpIuNSSL6dLOqIYsUwRfUkmsIZwxwrdV3OYd+yvqDMcmJXbQHW9iPlhkAXkl19sBJteyv95KkK7NCaAc0d+f7PWdUibTBIKk3abtClPWXzQZJ78lZk9gE5YqdC0sy1bzmr/K3o3s06VVrRPT9b5tPFvaI/lHn7RFzP958lr+a/2/BOiwH43w/1dMgYQJ0Z1nG3RMct4ijeqSv4ISFPXL6nyUtbuw/a9KSFe5K0q6IRKol4ksQQ5RwcmBBbHJByhsBiktRTo4oDop8tpJikUNvlTfdq29UPDydpo3CWI845CDMl8jnE6yPCnufknCHmOSDxTLnXY3SZFNwcUGGWyGaS5EeENYfYPV9M86wWSEDTPuUbsQuHHnK5NP84ENT0n7/TP08tSfVx1u9GJ/vC1HPdaO2pMQ6uIc0qcml92JbXfWOCWfQG9PTN0O6V3o/NJ0c/evupljG0PCUEpMs3MRbEZTWAjw4Kp4htR4fnkFh+6m21Et/nMnZZN8WAd1bJm3xVbNt5pN5hnVVi0uo/QepJYcBUyU+JByboMFNgcJJ2tAhhglLTireTZXevI6um3pSioy+vRgPq+vq6bzZhgTU70hEmLiSmmiTbPInv+WNd0W1jNKDa5l99swm2MTvSESbaxlSTZJui+iqaTqyuu21ViZJuI0dDqq3eDs0/qdYTTObqFwWcaEGXMUiWXIsuv54a5CKNqBZ8L7p8crSL9WcBTbQapjjJYlVdtD+uN3X5Y9LsRJtRrfaHbPyhbzvBbnifCNhE2+EmIFlvst2mWAzuHAYF/5G3hEXS7AQ0nmgat1GO3jM8J9xxG4YDqK54ULqZYikIMeyzIgOo88k7JX59VmJH8ErLQ0zSYYZI9lltzlXQO17RSUHts/qdlvyapAVw09M9tKOL49zyUQ65qbtcBg+y8pBXj1PCAGdT6rJ22wPcju0nGM7dtwN0oi3dZsGs+tjkm6di2b4Yf7gui/smb3686MT3btuI8d/reqMUsow7NrwzEe6GlncGwkEbg4ppUXaiKarHP42ORbVdH9OtCXjYrtMNA3z5/lTuu7d/vPnt9jyyX5VFJXL3yjlZBasbXCep0ZuPn86klFRJtN1ltNrT7e8m38zFNIB1EZK9evfb+w93n/68e/P6n29ml/5qWebrzV1X34nVozvNMn1coMlRvd6/vb398/bN67vbNx/e/HY64SzN1kXT1I1Y3TViI/I5OfesbudS6UKawG8efOpbmLMHHPSdrpeOecZZBMPudf699xVn0+FqnX9/GLuYa4QM+7uUK6qzK1dU/yXlvjX55uP5FJPw7h3fOZX6dF6l5nQUTqW4nyUs4qa/+Lvonkyf0f3YnKIfgLyQy6i/iqYpVuJsKlzBHmYeKjgCrhM/9bYB+9q5ldvBX0QzZNvTiGqlYsPhJ9GoHKG4Hv/r3u/smt6Nn73Tm1I3k/3nZXIT+2rvhP4AEJH+z6s/1XpH2Y1kMRhy3Jq9YN7xUEe37h6JdkIspNf78+pr3n6EWa+ThLzqAVsz3zVV3h2q+6xlqw4fzSQ2gDuj0F8L8e23RuQz2ltC5o3Iz2JxLYOYr1bWN+NPkz1frVZ7xDOKvhJt19To13mPEHuPdk6Ri3ZT5j8+1X/XTbl6VdfNSn49UsxF+AG/q79J/KWGf0a1+g+OPJpLmf7XK4B6RhVa0d1uq65Yi4+i64rqcS4tWtE1PXC7Bz6vIn8NDmk+DUZ/dF7RFWk/1a97Es8/OxR+Vw+T5KyzY1K8cl1UD/VRQYtqOTlyeQu7m2jSvkeIdHoY0+vvurLhu/rixHPZnekiX2nIJ0qvwbtUeSjrvHsrhd/UpfpS/JtKurbV3JqpjgrYkdh1dAlFi/Zvcf/Pd3xuvYr2m7h/LPmF1Ng09WOT95cJzK3KgL0csC+hjrU9mkkVgHs5NT70HZ1Flc2IfQl12tUDX/0lmhZ+D24mdRT21x32RdSRX6/abj4Va/G2el+UZdGKZV2tZh+qoSMZWBXVWu/oEop+FdUKv+foFK12qGdS4WBgMgaoL1biId+W3fUQuF63Zkh8IEYZP3vnAjkYrgTg0EXf3hWVf82boj98cJQQOPrkWOZ5kx1r+4Hfp9neBJlo+4998xNtbwmBo59ue8tkU21/Et8n8VwLy4/ad7r7nY3TB7isucJ8fV+IqtPvC5pT+quhh/ESg9NVMbs5+M2pD3kpuo6aH5uomuphs+vhcqqNR/36lULdLHceDceOeoB26OhyivZ7n38Vj0+vN8XtiHseXfu+norHp9WmaEBfl1O3aFVycfySxHn0LFqVTCn2nVxOQeUF+psArMOvsyqpOuqvCnj2m15nU7Q9+/zsu/lvzc51LfMT/yi31Fh6onY9/n2Pfzm1huLweVbzK4B+QZWKUrzfll2xKQtyFmGqYkUp1rCPs6pHiwpPisQnReAwKnTF3kRzW/3OFm0fiLI1utzny38/NvW2Wr3SbiWaU4GrfSf2xUXHKmT2dDiueFVXcja+q9vuY7Helrnj9uPTde37W/b9lXXbtaC/S6v9sas33/Ju+XROXVvQyeUULB6ruhGTMtgTtet7mJ7LPlk1tdT/+VU0Zb65FautfvvWrDqqruq+qwZ0dWFlP4hKdOomnEq/XWd+ZTf7ruyrd86t7LCDnHAGZaKKQwdTT6ScrJi8SLr+9qnJl2JKIWaidn0vnexlcknmGBX3kceTKDei6S+GUF/st8KL/hP9nRTqHgHq4T4Itj/Uh8ChkEBpW0aCJm35nCZtSdYEgDk1kXAopFuTtiRo0jzeP6NJ83hPPnAJwFyaSDgc0qmJhCVpwqPoeWV4FE3QB0IeUEmCOrEPKSbxSbrlz2uWT9Arp2iV3zhQD2mUE/UhDVY+bbRy4nDlw3g54A+q98yIrUTZ5ddqk7bMy6URMxuKoh8mX2jwWraWxchXdkfjF6UPdoQAkKyB6zj9YoOjhCNdbnBIUAyZegzzNMmfO4Y5l9SPovtDfO92LWYS/1F0lfjeqVZdceBtiFP02E/nbXWdV8U618L4cQJpfyV7iG31m4W4dxM6Jvzw4VmhS/rri7for497+XMxnk94ueA3wU228BYPhShX8jWzXihPvhq2FiooW9XLrfrxy/Cxv4Qkufxw/+kX/sL77HtheMO/fPE+j03Vr9UvRoT9b1QzhjdjVjOmNeML7zOzm3GrGdeaBQvvM/fC7CYOI61hYDUMtIbhwvsceEF447NQaxhaDUOtYbTwPodYw8hqGGkN44X3OfKC6CbJdFFjq2GsNUwW3ucYa5hYDROtYapsGvAbHnuhx8OblMcaQGoBpBpAtvA+J5h1M6thppNAciLFWjKbP8wgkCRGhrZFSKSziCka+Whjm0pM5xKTDGEMbWzTiel8YpIlDKUisynFdE4xyRQWoI1tWjGdV0yyhYVeEN/wIPJYNPykw9gkYzrLmOQOi1EZbKIxnWksdU0nZnOM6SRjkjos8UL/JmaB3tjmGdOJxiV3WIo4DptnXOcZl9RhGdLUphk3nJUkDke8HEf8lU4yHrj8B7c5xnWO8dDlQrhNMa5TjEcuL8JthnGdYVwyhWPe2WYV11nFJU84Oi24zSqus4pLonB0WnCbVlynFc9clOQ2q7jOqsB3UjKweRXovAqYg5KBzatA51WgeBWi65nNrMBYCgMHnwNkLdSJFYQOPgc2rwKdV4GkCo9QkW1iBTqxgtg1GQKbWYHOrCBxTYbAJlagEytIXZMhsHkV6LwKMsdkCGxaBTqtQkkUHo+emice5zdJkOnxh02wUCdYKEnD0dU1tCkW6hQLFcWyUYbA7+MDHcXmWqhzLZT8CdClMrTZFhqhlzv2QoIvnW5h5JyZoU23UKdbKBkUoM4otPkW6nwLJYUC1BmFNuFCnXBh6iJ6aBMu1AkXZi6ihzbjQp1xke8iemTTLNJpFimajRz1ghCLKyKbcJFOuEgyJ0AdRGTzLNJ5FgW6DDEqg824SGdcpBiHRrKRTbnICPijXgaW3GR+4AWpx9ObSE6hbPhJB0T2AToNI+X10CA1smkY6TSMEl0a3+PRTeiFDJXFJmakEzNSxESnRGQzM9KZGWWaLGEwWiYMUWlsukY6XWPJwBDlSmzzNdb5Gut8DVGuxDZfY52vsWRgiHIltvka63yNA5dri22SxjpJY0m7EHXrsU3SWCdp7NyWxjYfY2Nj6t6ZIltTnY6xc3Ma29yLde7FinvoTi+2uRfr3It17kX+yL0InQmxzb1Y514i2RShMyGxuZfo3Eskh6Id/6Nw91OESZPYLEx0FiaSVxG6G0tsFiY6CxNJrAilcGLTMNFpmKhNBkrDxKZhotMwkcyK0CFNbB4mOg8TSa0Y9YuJTcTESJIoIqIRSYLkSXQmJioexMfeZmKiMzGRPIrRwCCxWZforEvVAo1G/KnNulRnXSo5E6PuMrUZluoMSyVnYpRhqc2wVGdYKjkTowxLbYalOsNSyZkYZVhqMyzVGZaqfSzKsNRmWKozLJWcSVCGpTbDUp1hqeRMwsbIOeEelzB6EJraXEuNpJxkT4LSJUXycTrXUpWRC+3NR2ozLdWZlknuJByLnDObaZnOtExyJ0GZltlMy3SmZZI7Ccq0zGZapjMtk9xJ8CSkzbRMZ1omuZOgTMtspmU60zLJnQTZT2c2zzKdZ5lkToryLLN5luk8yyRfUtSTZTa7Mp1dmeRLinqyzGZXZqR7JWNSlJoZkvE1U74q54u6sv5venPwu6E967nd56tTPI3pIylg38gB+5JBKZ7J9JEssG+kgX1JohSlXP83s72RCfYlj1JH9hvJBftGMtiXZErxDLiPpIN9Ix/sSz5leBLcR/LAvpEI9hOnp+j/ZrY3csG+ZFWG59F9JB3sG/lgXxIrw1PpPpIR9g0iqnpChmfTsfKDVX9QBQicyGgJwuCfKitkUb8xy+IxFMwSj7ObJMsMRISRZmFC1RoynFFYacKsTahyw06iUQ4vQzewDKtXmAWLvmLh4yTDahZm0UJVH6QoyU2cJh7zGTrfsbqFWbjoKxc+ThisdmEWL1RBgvkOxiCMNSsYfQnDd1AGoaxRxWB9GcNHF1iGlDKYUctgfTHDx50eUtBgRkWD8b5yhns9pKzBjLoGU7UK5uMkRWobzChuMFWwYD7u95ACBzMqHExVLZir+odw0ihzMFW7YI4KIFLrYEaxg6n6BXNUAZF6BzMKHkzVMMCsYAE6K5DqBzPKH0yVNBjDOYmUQJhRA2F9EYThnETKIMyog7C+EOIoKSLFEGZUQ5gqcDCGcxIpiDCjIsL6kgjDOYmURZhRF2Gq2MEYzkmkOMKM6ghTBQ/GcU4iBRJmVEiYqnow7qhKI5w0yiRMlT4YXoJjSKmEGbUSpuofDC/DMaRewoyCCVNVEIaXtRhSNWFG2YSp+gfDi0wMqZcwo2DCVA2EcZyJSM2EGUUTpsofjONMRMolzKiXMFUCYXjRhiElE2bUTFjYny/AmYjUTZhROGF95STAmYjUTphRPGGqHsLwog9D6ifMKKAwVRNheP2FITUUZhRRmCqMMLwGw5BCCjMqKUxVR1iAMxGppjCjnMJUiYQFY1LPY0G8/zFBoymk0MKMSgtTJRMW4OxASizMqLGwvsiCnr9AiizMqLIwVS7BtroMqa0wo7jCVL2EBTg1kfoKMwosTNVHWOjvjrCEeDCIlFaYUVthUX8aBicZUl4Zf6cO0vXfwe7fd5Xn4LQbOH8u7oajdsnu9OPPRRYuXv789Wt/tO7lz1/gdJ38m+xPv3dhDyWjzh2WjCtJYPtzhQApZAApikhI1rf+AB6LAF7gk/DgKWQAFSRQNCrU/qZcYHogVMZoQMPLwEAeKE7WN+sV9BYhzXDjy9N70MDfg4a8bxYlE8B2Dx/tMTkgWkjUVmHZPIuBykSp9BdD9lgx0DSJaVgWu4BmfDB9QNRweOkVGQIwA8KADjY8wAyAOACaoOHu9hE4wUM4wTMi2HpT6LoBmw/moloLHGAHGgIFB7i0/5cPEyIcfh8Hw98jTupwuEPIuqp133eWQovQxmlAHb4YhqHKZASApU3j3fFyl+OCokY0i8On+vZQgAVR33C092DfIB7sPvw+pmowHPMHPjIDPjIaR49o50I+OWYsLRwIHxBZ4L4/eY+bghHLaNNshV2BA0kAFy1OW2mwJR44AKLhBhB89MGCQ/MA+xfhMOmAn+OATBNQ+6tKXtg+lEF3RRwTE/WhzNsnawniwKactgTZr35b8nKwsIXTxtt6S1zDzczlfDru8PC25nehHyD6E8eb1RossAJ1prsectZwgf8jhpToU8eaJwTsJQZI+BPAGihY0KKpU0x/wFKDBXaNjxyu4S1HCBsBxxdTpVVcQoLEALg84hot1ptOw4DLHG0SHbpDA24iYNxJDPBcV39BNw9h+RRYcBMGFBPuCIhLHLz1GlgSIvm0qYhF/onp1rzBX3jDBPeGCTnuMryB995AVI/KrIfxZcXd46CAqMDOCc0sDucP5ienLVYH7t4G5taYS9uL218thBFfBiM+MiDynDGwIpjtQ9A3BNfBMHThOHS0Fdd6UknrDZg6oU2NZ58S0mIZ4L9Tmv+mvTUEugCrZDqYRpb5j+zLvN9U24zAgJEN0ZQsd57a17AB0t0WTNEQoyvCPRm6K4MJJeJUQ67OAIhw7srk/hGIbakjQqMTozbkKgmICN0uMV7Dr3SAoNAXhDRKYHcpQPcCGUBMLTiuM4CocITCSSOkvKAOBgeHmKyzKAN3EQFtHRrCWizCAYNLdMkW42DAQEyl6ZdLwSkGF52Atsb3L5OAhQtameja9q9wAVcJFMtovJdratUWegTIANf5EECQVes3Dt22qkSJjF8Iwt2Ixvn9AxXAZHA6+rTdiHW9KvTG0Gdwmu0cTxdq6284ef2107WQHTSLoXesQm0haTltZBVmJdp2uIYLxHNgSPmwaga0qem4zwzOLzjQU1Dti8OgC4D5wYBGH+RGV2hSKCenytk/9w74AmiY0MYFPEAM0vIwaKK5bbk1dxYfQpCviWhryrqoMO7BTcQQ/w5bl2BIdkbDFiemxZPgjWLQC5gzKW3eWU+HAzSwUCdEqcAFuZDNkHecxjvJEdFqAkVg/iY0rqksyZDVwAYY7ktohOm3OepiNzUdNE3hbKDZH9txRpO9J3hcF4wfkCalGV27mA86DhizBTRvjOWSYOqPFhINKPe5vgMLgceIaevWARYAQ8W0aa4/uQQIAJnuEw3V1BvRdD+2VfFQN+t1vtlYyR44f0igTb4qthodYIQc0qazLITk1aPu8yPABWJ+pV89wOuLIKIBaBlVKmS7DDx1OnjYbKwS+tNwrTgVBs4+0fwKy04cgDFIaUzTn5ECTINT0qdiWT4e2C0hgpj7ThhVEWvOyE4THh5gxCMI9t6SQxDisGO7Sbh5C4kk75PcuzmDOJoIWpu23DRb44gLNBOxHtFsK8d5GWgu4rYESepkcIJQ/ZO7OC7PsQM82ii2qwc95IALFhUBPHAGtIPS+DQutKI7sHGAtcshG0pMEGAPwAJHBSTNaJMZPZyQWMO5ywd6Y9LOI2fWtCdfgbDAFWZE7Z/ylWiW9fpeFtJl2NSJjU4dbf6TQfXbeiEcxAuITKy3jR78J2DOprRZptKa/VZWow4IDYn7NyRBmmlhKtFMB46daAVzThxL95N7QFDtZCDNYQ7pCCSujmFVgCbl/m0MqC70LZw2ngPQt6J7wiQDS2hKGw/zcQsoHyQt8ZiBXQSCPp2YAu2zX1rMCZhGXKyGKFjNxXW+bGrVXhMNSkbCHF9CBMzSjqTRNlkyf1YsdTKEYORi2siNztA61wlPyNCWrAOPUANHC1X1aSP5rck32M4UDGdCM71E0rkOiJXSYgWJoUetwFQpwVRfvMWm2AiZeFq8/Pzl16//B7r2vno="; \ No newline at end of file diff --git a/docs/classes/drawables_drawable.Drawable.html b/docs/classes/drawables_drawable.Drawable.html index a5e6e9c..3cc3ac7 100644 --- a/docs/classes/drawables_drawable.Drawable.html +++ b/docs/classes/drawables_drawable.Drawable.html @@ -18,7 +18,7 @@

Although lights are also subclasses of Drawable, you cannot create your own light sources.

-
+

Hierarchy (View Summary)

Returns PolygonBase

+
  • Defined in drawables/shapes/polygon-factory.ts:18
    • -
    vertices: vec2[]
    +
  • Defined in drawables/shapes/polygon-factory.ts:18
    • descriptor: DrawableDescriptor
    diff --git a/docs/classes/graphics_rendering_fps-quality-autoscaler.FpsQualityAutoscaler.html b/docs/classes/graphics_rendering_fps-quality-autoscaler.FpsQualityAutoscaler.html deleted file mode 100644 index afa8435..0000000 --- a/docs/classes/graphics_rendering_fps-quality-autoscaler.FpsQualityAutoscaler.html +++ /dev/null @@ -1,142 +0,0 @@ -FpsQualityAutoscaler | SDF-2D - v0.8.0
    -
    SDF-2D - v0.8.0 - -
      -
      -
      Preparing search index...
      -
      -
      -
      - -

      Class FpsQualityAutoscaler

      -
      -

      Set the quality of rendering based on FPS values.

      -

      When using this, the size of the canvas must be fixed with CSS.

      -

      The addDeltaTime method should be called once every frame.

      -

      Usage:

      -
       const renderer = await compile(...);
       const autoscaler = new FpsQualityAutoscaler(renderer);
-
      - -
      -
      -
      -
      -
      Index
       -
      -
      - -
      constructor -
      -
      - -
      fpsHysteresis -scalingEnabled -fpsTarget -
      -
      - -
      FPS -
      -
      - -
      addDeltaTime -
      -
      - -
      -
      - -
        -
      • - -
        -
        -

        Parameters

        -
          -
        • renderer: Renderer
          • -
        • initialScales: Partial<Pick<RuntimeSettings, "distanceRenderScale" | "lightsRenderScale">> = {}
        -

        Returns FpsQualityAutoscaler

      -
      - -
      -
      - -
      fpsHysteresis: number = 5
      -
      - -
      scalingEnabled: boolean = true
      -

      When false, FPS is still measured but the render scales are left alone.

      -
      -
      - -
      fpsTarget: number = 30
      -
      - -
      -
      - -
        -
      • -
        get FPS(): number
        -
        -

        Returns number

      -
      - -
      -
      - -
        -
      • - -
        -

        Record the time taken by the latest frame. Autoscaling is also performed -as part of this call.

        -
        -
        -

        Parameters

        -
          -
        • deltaTimeInMilliseconds: number
        -

        Returns void

      -
      -
      -
      -
      -

      Settings

       -
      -
      Member Visibility -
        -
        • -
      -
      -
      -

      On This Page

       -
      -
      Constructors -
      -
      Properties -
      -
      Accessors -
      -
      Methods -
      -
      -
      -
      diff --git a/docs/functions/drawables_shapes_circle-factory.CircleFactory.html b/docs/functions/drawables_shapes_circle-factory.CircleFactory.html index e0cb76d..1c54cbb 100644 --- a/docs/functions/drawables_shapes_circle-factory.CircleFactory.html +++ b/docs/functions/drawables_shapes_circle-factory.CircleFactory.html @@ -16,13 +16,27 @@
    • +

      Creates a drawable circle class with a shared color.

      +

      Parameters

        -
      • color:
            | number
            | IndexedCollection
            | [number, number, number]
            | [number, number, number, number]
      -

      Returns typeof CircleBase

      +

      Returns typeof CircleBase

      A class with constructor new Circle(center: vec2, radius: number). +center is the position in world coordinates; radius is in world units. +Pass the class's static descriptor to compile!compile, then pass instances to +graphics/rendering/renderer/renderer!Renderer.addDrawable.

      + +
      +
      +
      import { CircleFactory, compile } from 'sdf-2d';

      const Circle = CircleFactory([1, 0.5, 0]);
      const circle = new Circle([160, 120], 30);
      const canvas = document.createElement('canvas');
      document.body.appendChild(canvas);
      const renderer = await compile(canvas, [Circle.descriptor]);
      renderer.addDrawable(circle);
      renderer.renderDrawables();
+
      + +
      • +
    • Defined in drawables/shapes/circle-factory.ts:44
      • diff --git a/docs/functions/drawables_shapes_droplet-factory.DropletFactory.html b/docs/functions/drawables_shapes_droplet-factory.DropletFactory.html index b0be31d..dbd8e1b 100644 --- a/docs/functions/drawables_shapes_droplet-factory.DropletFactory.html +++ b/docs/functions/drawables_shapes_droplet-factory.DropletFactory.html @@ -16,13 +16,29 @@
    • +

      Creates a drawable droplet class with a shared color.

      +

      Parameters

        -
      • color:
            | number
            | IndexedCollection
            | [number, number, number]
            | [number, number, number, number]
      -

      Returns typeof DropletBase

      +

      Returns typeof DropletBase

      A class with constructor +new Droplet(from: vec2, to: vec2, fromRadius: number, toRadius: number). +from and to are endpoint positions in world coordinates; fromRadius and +toRadius are the radii at those endpoints in world units. +Pass the class's static descriptor to compile!compile, then pass instances to +graphics/rendering/renderer/renderer!Renderer.addDrawable.

      + +
      +
      +
      import { DropletFactory } from 'sdf-2d';

      const Droplet = DropletFactory([1, 0.5, 0]);
      const droplet = new Droplet([100, 100], [200, 140], 30, 10);
+
      + +
      • +
    • Defined in drawables/shapes/droplet-factory.ts:45
      • diff --git a/docs/functions/drawables_shapes_hexagon-factory.HexagonFactory.html b/docs/functions/drawables_shapes_hexagon-factory.HexagonFactory.html index 97e7c7a..24064c8 100644 --- a/docs/functions/drawables_shapes_hexagon-factory.HexagonFactory.html +++ b/docs/functions/drawables_shapes_hexagon-factory.HexagonFactory.html @@ -16,13 +16,27 @@
    • +

      Creates a drawable hexagon class with a shared color.

      +

      Parameters

        -
      • color:
            | number
            | IndexedCollection
            | [number, number, number]
            | [number, number, number, number]
      -

      Returns typeof HexagonBase

      +

      Returns typeof HexagonBase

      A class with constructor new Hexagon(center: vec2, radius: number). +center is the position in world coordinates; radius controls the size in world units. +Pass the class's static descriptor to compile!compile, then pass instances to +graphics/rendering/renderer/renderer!Renderer.addDrawable.

      + +
      +
      +
      import { HexagonFactory } from 'sdf-2d';

      const Hexagon = HexagonFactory([1, 0.5, 0]);
      const hexagon = new Hexagon([160, 120], 30);
+
      + +
      • +
    • Defined in drawables/shapes/hexagon-factory.ts:39
      • diff --git a/docs/functions/drawables_shapes_inverted-tunnel-factory.InvertedTunnelFactory.html b/docs/functions/drawables_shapes_inverted-tunnel-factory.InvertedTunnelFactory.html index d6ca3ed..d858d79 100644 --- a/docs/functions/drawables_shapes_inverted-tunnel-factory.InvertedTunnelFactory.html +++ b/docs/functions/drawables_shapes_inverted-tunnel-factory.InvertedTunnelFactory.html @@ -16,15 +16,31 @@
    • -

      Providing a noise texture is required for this drawable.

      +

      Creates a drawable inverted tunnel class with a shared color.

      +

      Providing a noiseTexture in graphics/rendering/settings/runtime-settings!RuntimeSettings.textures is required for this +drawable. A noise texture can be generated with graphics/rendering/renderer/noise-renderer!renderNoise.

      Parameters

        -
      • color:
            | number
            | IndexedCollection
            | [number, number, number]
            | [number, number, number, number]
      -

      Returns typeof InvertedTunnelBase

      +

      Returns typeof InvertedTunnelBase

      A class with constructor +new InvertedTunnel(from: vec2, to: vec2, fromRadius: number, toRadius: number). +from and to are endpoint positions in world coordinates; fromRadius and +toRadius are the radii at those endpoints in world units. +Pass the class's static descriptor to compile!compile, then pass instances to +graphics/rendering/renderer/renderer!Renderer.addDrawable.

      + +
      +
      +
      import { InvertedTunnelFactory } from 'sdf-2d';

      const InvertedTunnel = InvertedTunnelFactory([1, 0.5, 0]);
      const tunnel = new InvertedTunnel([100, 100], [200, 140], 30, 20);
+
      + +
      • +
    • Defined in drawables/shapes/inverted-tunnel-factory.ts:48
      • diff --git a/docs/functions/drawables_shapes_meta-circle-factory.MetaCircleFactory.html b/docs/functions/drawables_shapes_meta-circle-factory.MetaCircleFactory.html index 4d1232f..d91e22c 100644 --- a/docs/functions/drawables_shapes_meta-circle-factory.MetaCircleFactory.html +++ b/docs/functions/drawables_shapes_meta-circle-factory.MetaCircleFactory.html @@ -16,14 +16,30 @@
    • +

      Creates a drawable class of smoothly merging circles with a shared color.

      +

      Parameters

        -
      • color:
            | number
            | IndexedCollection
            | [number, number, number]
            | [number, number, number, number]
        • -
      • k: number = 32
      -

      Returns typeof MetaCircleBase

      +

      Returns typeof MetaCircleBase

      A class with constructor new MetaCircle(center: vec2, radius: number). +center is the position in world coordinates; radius is in world units. +Pass the class's static descriptor to compile!compile, then pass instances to +graphics/rendering/renderer/renderer!Renderer.addDrawable.

      + +
      +
      +
      import { MetaCircleFactory } from 'sdf-2d';

      const MetaCircle = MetaCircleFactory([1, 0.5, 0], 32);
      const circle = new MetaCircle([160, 120], 30);
+
      + +
      • +
    • Defined in drawables/shapes/meta-circle-factory.ts:41
      • diff --git a/docs/functions/drawables_shapes_noisy-polygon-factory.NoisyPolygonFactory.html b/docs/functions/drawables_shapes_noisy-polygon-factory.NoisyPolygonFactory.html index 5bb6059..ce2eccd 100644 --- a/docs/functions/drawables_shapes_noisy-polygon-factory.NoisyPolygonFactory.html +++ b/docs/functions/drawables_shapes_noisy-polygon-factory.NoisyPolygonFactory.html @@ -16,14 +16,34 @@
    • +

      Creates a drawable polygon class with a noisy outline and a shared color.

      +

      Providing a noiseTexture in graphics/rendering/settings/runtime-settings!RuntimeSettings.textures is required for this +drawable. A noise texture can be generated with graphics/rendering/renderer/noise-renderer!renderNoise.

      +

      Parameters

        -
      • vertexCount: number
        • -
      • color:
            | number
            | IndexedCollection
            | [number, number, number]
            | [number, number, number, number]
      -

      Returns typeof PolygonBase & NoisyPolygonBase

      +

      Returns typeof PolygonBase & NoisyPolygonBase

      A class with constructor new NoisyPolygon(vertices: Array<vec2>). +vertices contains between one and vertexCount positions in world coordinates, +ordered around the polygon's outline. Instances also have a randomOffset property +(default 0) for varying the sampled noise. +Pass the class's static descriptor to compile!compile, then pass instances to +graphics/rendering/renderer/renderer!Renderer.addDrawable.

      + +
      +
      +
      import { NoisyPolygonFactory } from 'sdf-2d';

      const NoisyPolygon = NoisyPolygonFactory(3, [1, 0.5, 0]);
      const polygon = new NoisyPolygon([[100, 100], [200, 100], [150, 180]]);
+
      + +
      • +
    • Defined in drawables/shapes/noisy-polygon-factory.ts:38
      • diff --git a/docs/functions/drawables_shapes_polygon-factory.PolygonFactory.html b/docs/functions/drawables_shapes_polygon-factory.PolygonFactory.html index 400db57..f297d18 100644 --- a/docs/functions/drawables_shapes_polygon-factory.PolygonFactory.html +++ b/docs/functions/drawables_shapes_polygon-factory.PolygonFactory.html @@ -16,14 +16,31 @@
    • +

      Creates a drawable polygon class with a shared color.

      +

      Parameters

        -
      • vertexCount: number
        • -
      • color:
            | number
            | IndexedCollection
            | [number, number, number]
            | [number, number, number, number]
      -

      Returns typeof PolygonBase

      +

      Returns typeof PolygonBase

      A class with constructor new Polygon(vertices: Array<vec2>). +vertices contains between one and vertexCount positions in world coordinates, +ordered around the polygon's outline. Fewer vertices are padded automatically. +Pass the class's static descriptor to compile!compile, then pass instances to +graphics/rendering/renderer/renderer!Renderer.addDrawable.

      + +
      +
      +
      import { PolygonFactory } from 'sdf-2d';

      const Polygon = PolygonFactory(3, [1, 0.5, 0]);
      const polygon = new Polygon([[100, 100], [200, 100], [150, 180]]);
+
      + +
      • +
    • Defined in drawables/shapes/polygon-factory.ts:46
      • diff --git a/docs/functions/drawables_shapes_rotated-rectangle-factory.RotatedRectangleFactory.html b/docs/functions/drawables_shapes_rotated-rectangle-factory.RotatedRectangleFactory.html index cde2ddd..8bf6e94 100644 --- a/docs/functions/drawables_shapes_rotated-rectangle-factory.RotatedRectangleFactory.html +++ b/docs/functions/drawables_shapes_rotated-rectangle-factory.RotatedRectangleFactory.html @@ -16,13 +16,29 @@
    • +

      Creates a drawable rotated rectangle class with a shared color.

      +

      Parameters

        -
      • color:
            | number
            | IndexedCollection
            | [number, number, number]
            | [number, number, number, number]
      -

      Returns typeof RotatedRectangleBase

      +

      Returns typeof RotatedRectangleBase

      A class with constructor +new RotatedRectangle(center: vec2, size: vec2, rotation: number). +center is the position in world coordinates; size is [width, height] in world +units; rotation is the angle in radians. +Pass the class's static descriptor to compile!compile, then pass instances to +graphics/rendering/renderer/renderer!Renderer.addDrawable.

      + +
      +
      +
      import { RotatedRectangleFactory } from 'sdf-2d';

      const RotatedRectangle = RotatedRectangleFactory([1, 0.5, 0]);
      const rectangle = new RotatedRectangle([160, 120], [80, 40], Math.PI / 4);
+
      + +
      • +
    • Defined in drawables/shapes/rotated-rectangle-factory.ts:42
      • diff --git a/docs/functions/run-animation.runAnimation.html b/docs/functions/run-animation.runAnimation.html index 5e9b8e7..0fc7462 100644 --- a/docs/functions/run-animation.runAnimation.html +++ b/docs/functions/run-animation.runAnimation.html @@ -46,10 +46,14 @@ ever needs to be drawn by this renderer has to be given before compiling.

      if the animation should be continued. To break out of the animation loop, a false (falsy) return value must be given.

      -
    • settings: Partial<StartupSettings & RuntimeSettings> & { enableAutoscaler?: boolean } = {}
      • +
    • settings: Partial<StartupSettings & RuntimeSettings> & { enableAutoscaler?: boolean } = {} +

      Startup and runtime settings overrides. Sensible defaults are provided. +Set enableAutoscaler to false to keep the render scales exactly as configured +instead of letting the FPS-based autoscaler adjust them.

      +

      • Returns Promise<void>

      +
    • Defined in run-animation.ts:47
      • diff --git a/docs/hierarchy.html b/docs/hierarchy.html index c186279..da28999 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -10,9 +10,9 @@

      SDF-2D - v0.8.0

      Hierarchy Summary

      +
    • ColorfulCircle
      • diff --git a/docs/index.html b/docs/index.html index 55fbd1f..b439fe4 100644 --- a/docs/index.html +++ b/docs/index.html @@ -14,31 +14,31 @@ -

      If you're planning to create animated content, use the runAnimation function to save yourself from writing boilerplate code. -See its documentation for more details.

      +

      If you're planning to create animated content, use the runAnimation function to save yourself from writing boilerplate code. +See its documentation for more details.

      -

      Iñigo Quilez has a great collection of 2D SDFs

      +

      Iñigo Quilez has a great collection of 2D SDFs

      @@ -50,11 +50,9 @@ and writes the closest drawable's RGBA color to color on every code to shader uniforms, and compiles and renders it. Use it in a JavaScript module with sdf-2d and gl-matrix installed. Documentation CI runs this exact code with both WebGL 1 and WebGL 2.

      - 
      import { compile, Drawable } from 'sdf-2d';
      import { vec2 } from 'gl-matrix';

      class CustomCircle extends Drawable {
        constructor(center, radius) {
          super();
          this.center = center;
          this.radius = radius;
        }

        static descriptor = {
          propertyUniformMapping: {
            center: 'customCircleCenters',
            radius: 'customCircleRadii',
          },
          uniformCountMacroName: 'CUSTOM_CIRCLE_COUNT',
          shaderCombinationSteps: [0, 1, 4],
          // Unused array entries are filled with this zero-radius circle and moved away.
          empty: new CustomCircle([0, 0], 0),
          sdf: {
            distanceFunctionName: 'customCircleDistance',
            shader: `
              uniform vec2 customCircleCenters[CUSTOM_CIRCLE_COUNT];
              uniform float customCircleRadii[CUSTOM_CIRCLE_COUNT];

              float customCircleDistance(in vec2 target, out vec4 color) {
                color = vec4(1.0, 0.25, 0.0, 1.0);
                float minDistance = 1000.0;
                for (int i = 0; i < CUSTOM_CIRCLE_COUNT; i++) {
                  float d = distance(target, customCircleCenters[i]) - customCircleRadii[i];
                  minDistance = min(minDistance, d);
                }
                return minDistance;
              }
            `,
          },
        };

        minDistance(target) {
          return vec2.distance(this.center, target) - this.radius;
        }

        getObjectToSerialize(transform2d, transform1d) {
          return {
            center: vec2.transformMat2d(vec2.create(), this.center, transform2d),
            radius: this.radius * transform1d,
          };
        }
      }

      const canvas = document.createElement('canvas');
      canvas.width = 320;
      canvas.height = 240;
      document.body.appendChild(canvas);

      const renderer = await compile(canvas, [CustomCircle.descriptor]);
      renderer.setRuntimeSettings({ ambientLight: [1, 1, 1], motionBlur: 0 });
      renderer.addDrawable(new CustomCircle([160, 120], 50));
      renderer.renderDrawables();

      // Call renderer.destroy() when the renderer is no longer needed.
      -

      The vec2, vec3, and vec4 types seen in the documentation come from the glMatrix library and are equivalent to regular JS Arrays or Float32Arrays, so feel free to pass [x, y] to functions that expect a vec2.

      diff --git a/docs/interfaces/drawables_drawable-descriptor.DrawableDescriptor.html b/docs/interfaces/drawables_drawable-descriptor.DrawableDescriptor.html index b24da15..fa304c9 100644 --- a/docs/interfaces/drawables_drawable-descriptor.DrawableDescriptor.html +++ b/docs/interfaces/drawables_drawable-descriptor.DrawableDescriptor.html @@ -14,10 +14,10 @@

      Used for containing the required information to compile drawables into shader code.

      -

      Each [[Drawable]] must have a static property of this type, called descriptor.

      +

      Each drawables/drawable!Drawable must have a static property of this type, called descriptor.

      For more information on how to create your own DrawableDescriptors, look at the complete custom drawable example, -or the code of [[CircleFactory]] or [[InvertedTunnelFactory]].

      +or the code of drawables/shapes/circle-factory!CircleFactory or drawables/shapes/inverted-tunnel-factory!InvertedTunnelFactory.

      interface DrawableDescriptor {
          empty: Drawable;
          objectCountScaler?: number;
          propertyUniformMapping: { [property: string]: string };
          sdf?: {
              distanceFunctionName: string;
              isInverted?: boolean;
              shader: string;
          };
          shaderCombinationSteps: number[];
          uniformCountMacroName: string;
      }
      +
      compile
      drawables/drawable
      drawables/drawable-descriptor
      drawables/lights/circle-light
      drawables/lights/flashlight
      drawables/shapes/circle-factory
      drawables/shapes/colorful-circle
      drawables/shapes/droplet-factory
      drawables/shapes/hexagon-factory
      drawables/shapes/inverted-tunnel-factory
      drawables/shapes/meta-circle-factory
      drawables/shapes/noisy-polygon-factory
      drawables/shapes/polygon-factory
      drawables/shapes/rotated-rectangle-factory
      graphics/graphics-library/texture/texture-options
      graphics/rendering/renderer/noise-renderer
      graphics/rendering/renderer/renderer
      graphics/rendering/renderer/renderer-info
      graphics/rendering/settings/default-runtime-settings
      graphics/rendering/settings/default-startup-settings
      graphics/rendering/settings/runtime-settings
      graphics/rendering/settings/startup-settings
      helper/colors/hex
      helper/colors/hsl
      helper/colors/rgb
      helper/colors/rgb255
      helper/colors/rgba
      helper/colors/rgba255
      helper/delta-time-calculator
      run-animation
      @@ -26,7 +26,7 @@

      On This Page

      Modules -
      compiledrawables/drawabledrawables/drawable-descriptordrawables/empty-drawabledrawables/lights/circle-lightdrawables/lights/flashlightdrawables/lights/light-drawabledrawables/shapes/circle-factorydrawables/shapes/colorful-circledrawables/shapes/droplet-factorydrawables/shapes/hexagon-factorydrawables/shapes/inverted-tunnel-factorydrawables/shapes/meta-circle-factorydrawables/shapes/noisy-polygon-factorydrawables/shapes/polygon-factorydrawables/shapes/rotated-rectangle-factorygraphics/graphics-library/context-lost-exceptiongraphics/graphics-library/frame-buffer/default-frame-buffergraphics/graphics-library/frame-buffer/frame-buffergraphics/graphics-library/frame-buffer/intermediate-frame-buffergraphics/graphics-library/helper/enable-context-lost-simulatorgraphics/graphics-library/helper/enable-extensiongraphics/graphics-library/helper/get-hardware-infographics/graphics-library/helper/load-uniformgraphics/graphics-library/helper/stopwatchgraphics/graphics-library/parallel-compilergraphics/graphics-library/program/fragment-shader-only-programgraphics/graphics-library/program/i-programgraphics/graphics-library/program/programgraphics/graphics-library/program/uniform-array-autoscaling-programgraphics/graphics-library/texture/color-texturegraphics/graphics-library/texture/distance-texturegraphics/graphics-library/texture/palette-texturegraphics/graphics-library/texture/texturegraphics/graphics-library/texture/texture-optionsgraphics/graphics-library/universal-rendering-contextgraphics/rendering/fps-quality-autoscalergraphics/rendering/render-pass/distance-render-passgraphics/rendering/render-pass/lights-render-passgraphics/rendering/render-pass/render-passgraphics/rendering/renderer/context-aware-renderergraphics/rendering/renderer/noise-renderergraphics/rendering/renderer/renderergraphics/rendering/renderer/renderer-implementationgraphics/rendering/renderer/renderer-infographics/rendering/settings/default-runtime-settingsgraphics/rendering/settings/default-startup-settingsgraphics/rendering/settings/runtime-settingsgraphics/rendering/settings/startup-settingsgraphics/rendering/uniforms-providerhelper/arrayhelper/clamphelper/code-for-color-accesshelper/color-to-stringhelper/colors/hexhelper/colors/hslhelper/colors/rgbhelper/colors/rgb255helper/colors/rgbahelper/colors/rgba255helper/delta-time-calculatorhelper/exponential-decayhelper/format-loghelper/get-combinationshelper/lasthelper/mixhelper/ms-to-stringhelper/number-to-glsl-floathelper/waitmainrun-animation
      +
      compiledrawables/drawabledrawables/drawable-descriptordrawables/lights/circle-lightdrawables/lights/flashlightdrawables/shapes/circle-factorydrawables/shapes/colorful-circledrawables/shapes/droplet-factorydrawables/shapes/hexagon-factorydrawables/shapes/inverted-tunnel-factorydrawables/shapes/meta-circle-factorydrawables/shapes/noisy-polygon-factorydrawables/shapes/polygon-factorydrawables/shapes/rotated-rectangle-factorygraphics/graphics-library/texture/texture-optionsgraphics/rendering/renderer/noise-renderergraphics/rendering/renderer/renderergraphics/rendering/renderer/renderer-infographics/rendering/settings/default-runtime-settingsgraphics/rendering/settings/default-startup-settingsgraphics/rendering/settings/runtime-settingsgraphics/rendering/settings/startup-settingshelper/colors/hexhelper/colors/hslhelper/colors/rgbhelper/colors/rgb255helper/colors/rgbahelper/colors/rgba255helper/delta-time-calculatorrun-animation
      defaultRuntimeSettings: RuntimeSettings = ...
      -

      Contains the default values used for [[RuntimeSettings]].

      +

      Contains the default values used for graphics/rendering/settings/runtime-settings!RuntimeSettings.

      diff --git a/docs/variables/graphics_rendering_settings_default-startup-settings.defaultStartupSettings.html b/docs/variables/graphics_rendering_settings_default-startup-settings.defaultStartupSettings.html index b6a9ae6..fca5f07 100644 --- a/docs/variables/graphics_rendering_settings_default-startup-settings.defaultStartupSettings.html +++ b/docs/variables/graphics_rendering_settings_default-startup-settings.defaultStartupSettings.html @@ -12,7 +12,7 @@
    • defaultStartupSettings

      • Variable defaultStartupSettingsConst

      defaultStartupSettings: StartupSettings = ...
      -

      Contains the default values used for [[StartupSettings]].

      +

      Contains the default values used for graphics/rendering/settings/startup-settings!StartupSettings.

      diff --git a/documentation-readme.md b/documentation-readme.md index 9b21061..e1d640b 100644 --- a/documentation-readme.md +++ b/documentation-readme.md @@ -6,29 +6,29 @@ The motivation behind this library and more in-depth information about the rende - [Repository](https://git.schmelczer.dev/andras/sdf-2d) - [Demo](https://sdf2d.schmelczer.dev/) -- [Minimal example](https://github.com/schmelczerandras/sdf-2d-minimal-example) -- [More complex example](https://github.com/schmelczerandras/sdf-2d-more-complex-example) +- [Minimal example](https://github.com/schmelczer/sdf-2d-minimal-example) +- [More complex example](https://github.com/schmelczer/sdf-2d-more-complex-example) - [Source code of the demo](https://git.schmelczer.dev/andras/sdf-2d-demo) ## Usage (1st option) -- To start using cutting-edge 2D graphics, you first need a renderer instance. You can get one by calling the [compile function](functions/compile.compile.html). - - For this, you have to provide one or more [DrawableDescriptors](interfaces/drawables_drawable-descriptor.DrawableDescriptor.html). - - Optionally, the default compile settings can be overridden using [StartupSettings](interfaces/graphics_rendering_settings_startup-settings.StartupSettings.html). -- Once you have a renderer, you can start drawing objects through the [Renderer](interfaces/graphics_rendering_renderer_renderer.Renderer.html) interface. +- To start using cutting-edge 2D graphics, you first need a renderer instance. You can get one by calling the {@link compile!compile | compile function}. + - For this, you have to provide one or more {@link drawables/drawable-descriptor!DrawableDescriptor | DrawableDescriptors}. + - Optionally, the default compile settings can be overridden using {@link graphics/rendering/settings/startup-settings!StartupSettings}. +- Once you have a renderer, you can start drawing objects through the {@link graphics/rendering/renderer/renderer!Renderer} interface. ## Usage (2nd option) -If you're planning to create animated content, use the [runAnimation function](functions/run-animation.runAnimation.html) to save yourself from writing boilerplate code. -See its [documentation](functions/run-animation.runAnimation.html) for more details. +If you're planning to create animated content, use the {@link run-animation!runAnimation | runAnimation function} to save yourself from writing boilerplate code. +See its {@link run-animation!runAnimation | documentation} for more details. ## Extending drawables -> Iñigo Quilez has a great collection of [2D SDFs](https://iquilezles.org/www/articles/distfunctions2d/distfunctions2d.htm) +> Iñigo Quilez has a great collection of [2D SDFs](https://iquilezles.org/articles/distfunctions2d/) -- Subclass [Drawable](classes/drawables_drawable.Drawable.html) +- Subclass {@link drawables/drawable!Drawable} - Implement its abstract methods -- Add a static `descriptor` property of type [DrawableDescriptor](interfaces/drawables_drawable-descriptor.DrawableDescriptor.html) to your class +- Add a static `descriptor` property of type {@link drawables/drawable-descriptor!DrawableDescriptor} to your class - Follow the instructions given in [Usage](#usage-1st-option) ### Custom drawable example diff --git a/package.json b/package.json index 573b0e0..47e1f22 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,8 @@ }, "scripts": { "start": "rm -rf lib/* && webpack --mode development -w", - "build": "rm -rf lib/* docs/* && npx typedoc && webpack --mode production", + "build": "rm -rf lib/* docs/* && npm run docs && webpack --mode production", + "docs": "typedoc", "test": "tsc --noEmit", "format": "prettier --check \"src/**/*.{ts,json}\"", "format:fix": "prettier --write \"src/**/*.{ts,json}\"", diff --git a/typedoc.json b/typedoc.json index c6072da..06a16f4 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,7 +1,22 @@ { "out": "docs", "name": "SDF-2D", - "entryPoints": ["src"], + "entryPoints": [ + "src/compile.ts", + "src/run-animation.ts", + "src/drawables/drawable.ts", + "src/drawables/drawable-descriptor.ts", + "src/drawables/lights/circle-light.ts", + "src/drawables/lights/flashlight.ts", + "src/drawables/shapes/*.ts", + "src/graphics/graphics-library/texture/texture-options.ts", + "src/graphics/rendering/renderer/noise-renderer.ts", + "src/graphics/rendering/renderer/renderer.ts", + "src/graphics/rendering/renderer/renderer-info.ts", + "src/graphics/rendering/settings/*.ts", + "src/helper/colors/*.ts", + "src/helper/delta-time-calculator.ts" + ], "entryPointStrategy": "expand", "excludeExternals": true, "excludePrivate": true, @@ -11,5 +26,20 @@ "readme": "documentation-readme.md", "favicon": "media/favicon.ico", "skipErrorChecking": true, + "validation": { + "invalidLink": true, + "notExported": true + }, + "treatWarningsAsErrors": true, + "intentionallyNotExported": [ + "CircleBase", + "DropletBase", + "HexagonBase", + "InvertedTunnelBase", + "MetaCircleBase", + "NoisyPolygonBase", + "RotatedRectangleBase" + ], + "highlightLanguages": ["typescript", "javascript", "html", "glsl"], "plugin": ["typedoc-plugin-extras"] }