Notice:
This library was developed as part of the PrusaSlicer project. You can find the original version here. This repository is a continuation of the original project (effectively a fork) that contains backported stable changes and is open to further development.
libnest2d is released under terms of the LGPLv3 License. Terms of the license can be found in the LICENSE file. Or at
http://www.gnu.org/licenses/lgpl.html
But in general it boils down to:
You need to share the source of any libnest2d modifications if you make an application with libnest2d.
- Python 3.6 or higher
- Ninja 1.10 or higher
- VS2022 or higher
- CMake 3.23 or higher
- nmake
- Python 3.6 or higher
- Ninja 1.10 or higher
- apply clang 11 or higher
- CMake 3.23 or higher
- make
- Python 3.6 or higher
- Ninja 1.10 or higher
- gcc 12 or higher
- CMake 3.23 or higher
- make
Note:
We are currently in the process of switch our builds and pipelines to an approach which uses Conan and pip to manage our dependencies, which are stored on our JFrog Artifactory server and in the pypi.org. At the moment not everything is fully ported yet, so bare with us.
If you want to develop Cura with libnest2d see the Cura Wiki: Running Cura from source
If you have never used Conan read their documentation which is quite extensive and well maintained. Conan is a Python program and can be installed using pip
pip install conan --upgrade
conan config install https://github.com/ultimaker/conan-config.git
conan profile new default --detect --force
Community developers would have to remove the Conan cura repository because it requires credentials.
Ultimaker developers need to request an account for our JFrog Artifactory server at IT
conan remote remove cura
git clone https://github.com/Ultimaker/libnest2d.git
cd libnest2d
conan install . --build=missing --update
# optional for a specific version: conan install . libnest2d/<version>@<user>/<channel> --build=missing --update
cmake --preset release
cmake --build --preset release
conan install . --build=missing --update build_type=Debug
cmake --preset debug
cmake --build --preset debug
To create a new libnest2d Conan package such that it can be used in Cura and Uranium, run the following command:
conan create . nest2d/<version>@<username>/<channel> --build=missing --update
This package will be stored in the local Conan cache (~/.conan/data
or C:\Users\username\.conan\data
) and can be used in downstream
projects, such as Cura and Uranium by adding it as a requirement in the conanfile.py
or in conandata.yml
.
Note: Make sure that the used <version>
is present in the conandata.yml in the libnest2d root
You can also specify the override at the commandline, to use the newly created package, when you execute the conan install
command in the root of the consuming project, with:
conan install . -build=missing --update --require-override=libnest2d/<version>@<username>/<channel>
You can use your local development repository downsteam by adding it as an editable mode package. This means you can test this in a consuming project without creating a new package for this project every time.
conan editable add . libnest2d/<version>@<username>/<channel>
Then in your downsteam projects (Cura) root directory override the package with your editable mode package.
conan install . -build=missing --update --require-override=libnest2d/<version>@<username>/<channel>
A simple example may be the best way to demonstrate the usage of the library.
#include <iostream>
#include <string>
// Here we include the libnest2d library
#include <libnest2d/libnest2d.hpp>
int main(int argc, const char* argv[]) {
using namespace libnest2d;
// Example polygons
std::vector<Item> input1(23,
{
{-5000000, 8954050},
{5000000, 8954050},
{5000000, -45949},
{4972609, -568550},
{3500000, -8954050},
{-3500000, -8954050},
{-4972609, -568550},
{-5000000, -45949},
{-5000000, 8954050},
});
std::vector<Item> input2(15,
{
{-11750000, 13057900},
{-9807860, 15000000},
{4392139, 24000000},
{11750000, 24000000},
{11750000, -24000000},
{4392139, -24000000},
{-9807860, -15000000},
{-11750000, -13057900},
{-11750000, 13057900},
});
std::vector<Item> input;
input.insert(input.end(), input1.begin(), input1.end());
input.insert(input.end(), input2.begin(), input2.end());
// Perform the nesting with a box shaped bin
size_t bins = nest(input, Box(150000000, 150000000));
// Retrieve resulting geometries
for(Item& r : input) {
auto polygon = r.transformedShape();
// render polygon...
}
return EXIT_SUCCESS;
}
It is worth to note that the type of the polygon carried by the Item objects is the type defined as a polygon by the geometry backend. In the example we use the clipper backend and clipper works with integer coordinates.
Ofcourse it is possible to configure the nesting in every possible way. The nest
function can take placer and selection algorithms as
template arguments and their configuration as runtime arguments. It is also possible to pass a progress indication functor and a stop
condition predicate to control the nesting process. For more details see the libnest2d.h
header file.
For the record, Slic3r PE version 2.0 is now known as PrusaSlicer 2.0.
- SVGNest
- An effective heuristic for the two-dimensional irregular bin packing problem
- Complete and robust no-fit polygon generation for the irregular stock cutting problem
- Applying Meta-Heuristic Algorithms to the Nesting Problem Utilising the No Fit Polygon
- A comprehensive and robust procedure for obtaining the nofit polygon using Minkowski sums