Merge pull request #387 from smkent/swatch-remix

Add and configure usage of GetBurning's material swatch remix

Author: smkent

material-swatches/README.md

@@ -17,6 +17,15 @@ which allows creation of swatches with arbitrary text.
 Material Swatches also happen to be the perfect size to [store in Gridfinity
 bins!][gridfinity-bins-material-swatches]
 
+## Included remix by GetBurning
+
+This model includes a tweaked version of [GetBurning's remix of this
+model][getburning-remix] as `material-swatch-getburning-remix.scad`, which
+supports adding three lines of arbitrary text onto the swatch instead of just
+using the material name.
+
+This remix uses the [Obitron font][orbitron-font] ([license][ofl]).
+
 ## Differences of the remix compared to the original
 
 This is a version of Material Swatches created from scratch in OpenSCAD
@@ -29,9 +38,12 @@ This is a remix of
 Both the original model and this remix are licensed under
 [Creative Commons CC0 1.0 Universal (Public Domain)][license].
 
+[getburning-remix]: https://www.printables.com/model/764204-scad-material-swatch-with-three-lines
 [gridfinity-bins-material-swatches]: https://www.printables.com/model/587675
 [license-badge]: /_static/license-badge-cc0-1.0.svg
 [license]: http://creativecommons.org/publicdomain/zero/1.0/
+[ofl]: https://openfontlicense.org/open-font-license-official-text/
+[orbitron-font]: https://fonts.google.com/specimen/Orbitron
 [original-model-url]: https://printables.com/model/2256
 [printables-badge]: /_static/printables-badge.png
 [printables-model]: https://www.printables.com/model/623563

material-swatches/SConscript

@@ -1,17 +1,132 @@
+from collections import namedtuple
+from datetime import datetime
+
 Import("env")
 b = ModelBuilder(env)
 
+Swatch = namedtuple(
+    "Swatch",
+    (
+        "manufacturer",
+        "material",
+        "color",
+        "string0_size",
+        "string1_size",
+        "string2_size",
+        "string3_size",
+    ),
+    defaults=("", "", "", 4, 4, 4, 4),
+)
+
 model = "material-swatch.scad"
+multiline_model = "material-swatch-getburning-remix.scad"
+dt = datetime.now().strftime("%Y.%m")
+
+swatches = [
+    Swatch("CC3D", "PETG", "blue grey"),
+    Swatch("CC3D", "PETG", "bright green"),
+    Swatch("CC3D", "PETG", "silver"),
+    Swatch("Creality", "PETG", "black", 2.8),
+    Swatch("Creality", "PETG", "blue", 2.8),
+    Swatch("Creality", "PETG", "trans- parent", 2.8),
+    Swatch("Flashforge", "PETG", "gray", 2.4),
+    Swatch("Flashforge", "PETG", "green", 2.4),
+    Swatch("Flashforge", "PETG", "purple", 2.4),
+    Swatch("Flashforge", "PETG", "yellow", 2.4),
+    Swatch("Geeetech", "PETG", "gray", 3),
+    Swatch("Geeetech", "PLA", "silk bronze", 3),
+    Swatch("Geeetech", "PLA", "silk rainbow", 3, string2_size=3.8),
+    Swatch("HZST3D", "PETG", "blue"),
+    Swatch("HZST3D", "PETG", "fluo yellow"),
+    Swatch("HZST3D", "PETG", "green"),
+    Swatch("HZST3D", "PETG", "orange"),
+    Swatch("HZST3D", "PETG", "purple"),
+    Swatch("HZST3D", "PETG", "red"),
+    Swatch("Jayo", "PETG", "black"),
+    Swatch("Jayo", "PETG", "white"),
+    Swatch("Jayo", "PETG", "blue"),
+    Swatch("Jayo", "PLA", "light gold"),
+    Swatch("Jayo", "PLA", "meta black"),
+    Swatch("Jayo", "PLA", "meta red"),
+    Swatch("Jayo", "PLA", "meta white"),
+    Swatch("Jayo", "PLA", "meta yellow"),
+    Swatch("Jayo", "PLA", "red copper"),
+    Swatch("Jayo", "PLA", "silk green"),
+    Swatch("Jayo", "PLA", "silk blue"),
+    Swatch("Overture", "PETG", "grass green", 2.8),
+    Swatch("Overture", "PETG", "rock white", 2.8),
+    Swatch("Overture", "PLA", "grass green", 2.8),
+    Swatch("Polymaker", "PETG", "dark blue", 2.6),
+    Swatch("R3D", "PLA", "pink"),
+    Swatch("Sunlu", "PLA", "apple green", 3.3),
+    Swatch("Sunlu", "PLA", "cream white", 3.3),
+    Swatch("Sunlu", "PLA", "ice blue", 3.3),
+    Swatch("Sunlu", "PLA", "meta blue", 3.3),
+    Swatch("Sunlu", "PLA", "taro purple", 3.3),
+    Swatch("TPMOINS", "PETG", "army green", 3.5),
+    Swatch("TPMOINS", "PETG", "cyan", 3.5),
+    Swatch("TPMOINS", "PETG", "purple", 3.5),
+    Swatch("Voxelab", "ASA", "sky blue", 3.3),
+    Swatch("Voxelab", "PETG", "burnt titanium", 3.3),
+    Swatch("Voxelab", "PLA", "nebula purple", 3.3),
+]
+
+for opts in GenerateOptions(
+    material=(("", "blank"), "PETG", "PLA", "ABS", "HIPS", "TPU", "PC"),
+    steps=((0, "simple"), (1, "steps")),
+):
+    b.STL(
+        (
+            f"material-swatch-{opts.material_fn or opts.material.upper()}"
+            f"-{opts.steps_fn}.stl"
+        ),
+        model,
+        {"Text": opts.material, "Steps": opts.steps},
+    )
 
-for material in {"", "PETG", "PLA", "ABS", "HIPS", "TPU", "PC"}:
-    for steps in {0, 1}:
-        fn_material = material.lower() or "blank"
-        fn_steps = "steps" if steps == 1 else "simple"
-        b.STL(
-            f"material-swatch-{fn_material}-{fn_steps}.stl",
-            model,
-            {"Text": material, "Steps": steps},
+for opts in GenerateOptions(swatch=[(s,) for s in swatches]):
+    swatch_dict = opts.swatch._asdict()
+    manufacturer = swatch_dict.pop("manufacturer")
+    material = swatch_dict.pop("material")
+    color = swatch_dict.pop("color")
+    color_words = color.split(maxsplit=1)
+    strings = {
+        f"string{i}": s
+        for i, s in enumerate(
+            [
+                manufacturer.upper(),
+                color_words[0].upper(),
+                (color_words[1].upper() if len(color_words) > 1 else ""),
+                material.upper(),
+            ]
+            if len(color_words) > 1
+            else [
+                manufacturer.upper(),
+                "",
+                color_words[0].upper(),
+                material.upper(),
+            ]
         )
+    }
+    b.STL(
+        (
+            f"my-swatch"
+            f"-{manufacturer.lower().replace(' ', '-')}"
+            f"-{material.lower().replace(' ', '-')}"
+            f"-{color.lower().replace(' ', '-')}"
+            ".stl"
+        ),
+        multiline_model,
+        {
+            **strings,
+            **{
+                "string3_origin": 1.0,
+                "string3_size": 4,
+                "Steps": 0,
+            },
+            **swatch_dict,
+        },
+    )
 
 b.Image(
     "demo.gif",

material-swatches/fonts/Orbitron/OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2018 The Orbitron Project Authors (https://github.com/theleagueof/orbitron), with Reserved Font Name: "Orbitron"
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://openfontlicense.org
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

material-swatches/fonts/Orbitron/Orbitron-Black.ttf

@@ -0,0 +1,68 @@
+Orbitron Variable Font
+======================
+
+This download contains Orbitron as both a variable font and static fonts.
+
+Orbitron is a variable font with this axis:
+  wght
+
+This means all the styles are contained in a single file:
+  Orbitron-VariableFont_wght.ttf
+
+If your app fully supports variable fonts, you can now pick intermediate styles
+that aren’t available as static fonts. Not all apps support variable fonts, and
+in those cases you can use the static font files for Orbitron:
+  static/Orbitron-Regular.ttf
+  static/Orbitron-Medium.ttf
+  static/Orbitron-SemiBold.ttf
+  static/Orbitron-Bold.ttf
+  static/Orbitron-ExtraBold.ttf
+  static/Orbitron-Black.ttf
+
+Get started
+-----------
+
+1. Install the font files you want to use
+
+2. Use your app's font picker to view the font family and all the
+available styles
+
+Learn more about variable fonts
+-------------------------------
+
+  https://developers.google.com/web/fundamentals/design-and-ux/typography/variable-fonts
+  https://variablefonts.typenetwork.com
+  https://medium.com/variable-fonts
+
+In desktop apps
+
+  https://theblog.adobe.com/can-variable-fonts-illustrator-cc
+  https://helpx.adobe.com/nz/photoshop/using/fonts.html#variable_fonts
+
+Online
+
+  https://developers.google.com/fonts/docs/getting_started
+  https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Fonts/Variable_Fonts_Guide
+  https://developer.microsoft.com/en-us/microsoft-edge/testdrive/demos/variable-fonts
+
+Installing fonts
+
+  MacOS: https://support.apple.com/en-us/HT201749
+  Linux: https://www.google.com/search?q=how+to+install+a+font+on+gnu%2Blinux
+  Windows: https://support.microsoft.com/en-us/help/314960/how-to-install-or-remove-a-font-in-windows
+
+Android Apps
+
+  https://developers.google.com/fonts/docs/android
+  https://developer.android.com/guide/topics/ui/look-and-feel/downloadable-fonts
+
+License
+-------
+Please read the full license text (OFL.txt) to understand the permissions,
+restrictions and requirements for usage, redistribution, and modification.
+
+You can use them in your products & projects – print or digital,
+commercial or otherwise.
+
+This isn't legal advice, please consider consulting a lawyer and see the full
+license for all details.