3D Designer
Modules
At some point, things are going to get complex. You are going to have objects twisted around other objects, modifying other objects that are used in combination with yet more objects.
It helps then that openSCAD supports modules to organize stuff. Modules are simply a bunch of instructions that go together.
To illustrate how they work, let's make a funnel as shown in Figure 7.
A funnel is made up by two parts: a hollow, cut-off conical object that I am going to call the hat (I couldn't find formal names for the parts of a funnel, so I am improvising here), and a hollow cylinder I am calling the pipe.
Turns out both the hat and the pipe can be made entirely from cylinders, since the hat, for openSCAD, is a cylinder with two different diameters at each end. As you need it to be hollow, you make another cylinder with a slightly smaller radius at both ends and subtract that from the bigger one. The module for that would look like Listing 3.
Listing 3
Hat Module
module hat () { difference () { cylinder (r1=8, r2=2, h=10, center=true, $fn=50); cylinder (r1=7.5, r2=1.5, h=10, center=true, $fn=50); } }
The pipe module is even simpler (Listing 4), but you do have to remember to translate the lower end of the pipe to the top of the hat (line 2).
Listing 4
Pipe Module
01 module pipe () { 02 translate ([0,0,10]) { 03 difference () { 04 cylinder (r=2, h=10, center=true, $fn=50); 05 cylinder (r=1.5, h=10, center=true, $fn=50); 06 } 07 } 08 }
With these two modules, you can create a funnel ()
module that calls the other two (Listing 5, lines 17 to 20). Then call the funnel ()
module to actually show something in the preview pane (Listing 5, line 22).
Listing 5
funnel.scad
01 module hat () { 02 difference () { 03 cylinder (r1=8, r2=2, h=10, center=true, $fn=50); 04 cylinder (r1=7.5, r2=1.5, h=10, center=true, $fn=50); 05 } 06 } 07 08 module pipe () { 09 translate ([0,0,10]) { 10 difference () { 11 cylinder (r=2, h=10, center=true, $fn=50); 12 cylinder (r=1.5, h=10, center=true, $fn=50); 13 } 14 } 15 } 16 17 module funnel () { 18 hat (); 19 pipe (); 20 } 21 22 funnel ();
You can take this modularity further and save a set of modules into a separate .scad file altogether. You can then import them back into other files using either the include
or the use
methods.
The include </path/to/file.scad>
method imports the whole thing, modules and commands that are not in modules, integrating the whole imported file into your current file. The use </path/to/file.scad>
method, on the other hand, only imports the modules so you can use them as library modules with the code in your current file.
This means that, to get a funnel with include
, all you have to do is:
include <funnel.scad>;
To do the same with use
, you would also have to call the funnel ()
method like this:
use <funnel.scad>; funnel ();
Conclusion
This article has covered the most essential bits and pieces of the OpenSCAD language. With this and the user manual's excellent documentation [5], you should be able to start creating your first 3D pieces.
That said, there is quite a lot more to learn regarding OpenSCAD. We'll be looking at more advanced things in next month's issue. We will also be creating a real piece to print and showing how you can go all the way from concept to real physical object.
Until then, have fun!
Infos
- Thingiverse: https://www.thingiverse.com/
- Atelier: https://atelier.kde.org/
- OpenSCAD: http://www.openscad.org
- FreeCAD: https://www.freecadweb.org/
- OpenSCAD User Manual: https://en.wikibooks.org/wiki/OpenSCAD_User_Manual
« Previous 1 2 3
Buy this article as PDF
(incl. VAT)
Buy Linux Magazine
Subscribe to our Linux Newsletters
Find Linux and Open Source Jobs
Subscribe to our ADMIN Newsletters
Support Our Work
Linux Magazine content is made possible with support from readers like you. Please consider contributing when you’ve found an article to be beneficial.
![Learn More](https://www.linux-magazine.com/var/linux_magazin/storage/images/media/linux-magazine-eng-us/images/misc/learn-more/834592-1-eng-US/Learn-More_medium.png)
News
-
NVIDIA Released Driver for Upcoming NVIDIA 560 GPU for Linux
Not only has NVIDIA released the driver for its upcoming CPU series, it's the first release that defaults to using open-source GPU kernel modules.
-
OpenMandriva Lx 24.07 Released
If you’re into rolling release Linux distributions, OpenMandriva ROME has a new snapshot with a new kernel.
-
Kernel 6.10 Available for General Usage
Linus Torvalds has released the 6.10 kernel and it includes significant performance increases for Intel Core hybrid systems and more.
-
TUXEDO Computers Releases InfinityBook Pro 14 Gen9 Laptop
Sporting either AMD or Intel CPUs, the TUXEDO InfinityBook Pro 14 is an extremely compact, lightweight, sturdy powerhouse.
-
Google Extends Support for Linux Kernels Used for Android
Because the LTS Linux kernel releases are so important to Android, Google has decided to extend the support period beyond that offered by the kernel development team.
-
Linux Mint 22 Stable Delayed
If you're anxious about getting your hands on the stable release of Linux Mint 22, it looks as if you're going to have to wait a bit longer.
-
Nitrux 3.5.1 Available for Install
The latest version of the immutable, systemd-free distribution includes an updated kernel and NVIDIA driver.
-
Debian 12.6 Released with Plenty of Bug Fixes and Updates
The sixth update to Debian "Bookworm" is all about security mitigations and making adjustments for some "serious problems."
-
Canonical Offers 12-Year LTS for Open Source Docker Images
Canonical is expanding its LTS offering to reach beyond the DEB packages with a new distro-less Docker image.
-
Plasma Desktop 6.1 Released with Several Enhancements
If you're a fan of Plasma Desktop, you should be excited about this new point release.