magnum-bindings/src/python/magnum/primitives.cpp

/*
    This file is part of Magnum.

    Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
                2020, 2021, 2022, 2023, 2024, 2025
              Vladimír Vondruš <mosra@centrum.cz>

    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included
    in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/

#include <pybind11/pybind11.h>
#include <Magnum/Math/Color.h>
#include <Magnum/Primitives/Axis.h>
#include <Magnum/Primitives/Capsule.h>
#include <Magnum/Primitives/Circle.h>
#include <Magnum/Primitives/Cone.h>
#include <Magnum/Primitives/Crosshair.h>
#include <Magnum/Primitives/Cube.h>
#include <Magnum/Primitives/Cylinder.h>
#include <Magnum/Primitives/Gradient.h>
#include <Magnum/Primitives/Grid.h>
#include <Magnum/Primitives/Icosphere.h>
#include <Magnum/Primitives/Line.h>
#include <Magnum/Primitives/Plane.h>
#include <Magnum/Primitives/Square.h>
#include <Magnum/Primitives/UVSphere.h>
#include <Magnum/Trade/MeshData.h>

#include "corrade/EnumOperators.h"
#include "magnum/bootstrap.h"

namespace magnum {

void primitives(py::module_& m) {
    m.doc() = "Primitive library";

    #ifndef MAGNUM_BUILD_STATIC
    /* These are a part of the same module in the static build, no need to
       import (also can't import because there it's _magnum.*) */
    py::module_::import("magnum.trade");
    #endif

    py::enum_<Primitives::CapsuleFlag> capsuleFlags{m, "CapsuleFlags", "Capsule flags"};
    capsuleFlags.value("TEXTURE_COORDINATES", Primitives::CapsuleFlag::TextureCoordinates)
        .value("TANGENTS", Primitives::CapsuleFlag::Tangents)
        .value("NONE", Primitives::CapsuleFlag{});
    corrade::enumOperators(capsuleFlags);

    py::enum_<Primitives::Circle2DFlag> circle2DFlags{m, "Circle2DFlags", "2D circle flags"};
    circle2DFlags.value("TEXTURE_COORDINATES", Primitives::Circle2DFlag::TextureCoordinates)
        .value("NONE", Primitives::Circle2DFlag{});
    corrade::enumOperators(circle2DFlags);

    py::enum_<Primitives::Circle3DFlag> circle3DFlags{m, "Circle3DFlags", "3D circle flags"};
    circle3DFlags.value("TEXTURE_COORDINATES", Primitives::Circle3DFlag::TextureCoordinates)
        .value("TANGENTS", Primitives::Circle3DFlag::Tangents)
        .value("NONE", Primitives::Circle3DFlag{});
    corrade::enumOperators(circle3DFlags);

    py::enum_<Primitives::ConeFlag> coneFlags{m, "ConeFlags", "Cone flags"};
    coneFlags.value("TEXTURE_COORDINATES", Primitives::ConeFlag::TextureCoordinates)
        .value("TANGENTS", Primitives::ConeFlag::Tangents)
        .value("CAP_END", Primitives::ConeFlag::CapEnd)
        .value("NONE", Primitives::ConeFlag{});
    corrade::enumOperators(coneFlags);

    py::enum_<Primitives::CubeFlag> cubeFlags{m, "CubeFlags", "Cube flags"};
    cubeFlags.value("TEXTURE_COORDINATES_ALL_SAME", Primitives::CubeFlag::TextureCoordinatesAllSame)
        .value("TEXTURE_COORDINATES_POSITIVE_UP_NEGATIVE_DOWN", Primitives::CubeFlag::TextureCoordinatesPositiveUpNegativeDown)
        .value("TEXTURE_COORDINATES_NEGATIVE_X_UP_NEGATIVE_X_DOWN", Primitives::CubeFlag::TextureCoordinatesNegativeXUpNegativeXDown)
        .value("TEXTURE_COORDINATES_NEGATIVE_X_UP_POSITIVE_Z_DOWN", Primitives::CubeFlag::TextureCoordinatesNegativeXUpPositiveZDown)
        .value("TEXTURE_COORDINATES_NEGATIVE_X_UP_POSITIVE_X_DOWN", Primitives::CubeFlag::TextureCoordinatesNegativeXUpPositiveXDown)
        .value("TEXTURE_COORDINATES_NEGATIVE_X_UP_NEGATIVE_Z_DOWN", Primitives::CubeFlag::TextureCoordinatesNegativeXUpNegativeZDown)
        .value("TEXTURE_COORDINATES_POSITIVE_Z_UP_POSITIVE_Z_DOWN", Primitives::CubeFlag::TextureCoordinatesPositiveZUpPositiveZDown)
        .value("TEXTURE_COORDINATES_POSITIVE_Z_UP_POSITIVE_X_DOWN", Primitives::CubeFlag::TextureCoordinatesPositiveZUpPositiveXDown)
        .value("TANGENTS", Primitives::CubeFlag::Tangents)
        .value("NONE", Primitives::CubeFlag{});
    corrade::enumOperators(cubeFlags);

    py::enum_<Primitives::CylinderFlag> cylinderFlags{m, "CylinderFlags", "Cylinder flags"};
    cylinderFlags.value("TEXTURE_COORDINATES", Primitives::CylinderFlag::TextureCoordinates)
        .value("CAP_ENDS", Primitives::CylinderFlag::CapEnds)
        .value("NONE", Primitives::CylinderFlag{});
    corrade::enumOperators(cylinderFlags);

    py::enum_<Primitives::GridFlag> gridFlags{m, "GridFlags", "Grid flags"};
    gridFlags.value("TEXTURE_COORDINATES", Primitives::GridFlag::TextureCoordinates)
        .value("NORMALS", Primitives::GridFlag::Normals)
        .value("TANGENTS", Primitives::GridFlag::Tangents)
        .value("NONE", Primitives::GridFlag{});
    corrade::enumOperators(gridFlags);

    py::enum_<Primitives::PlaneFlag> planeFlags{m, "PlaneFlags", "Plane flags"};
    planeFlags.value("TEXTURE_COORDINATES", Primitives::PlaneFlag::TextureCoordinates)
        .value("TANGENTS", Primitives::PlaneFlag::Tangents)
        .value("NONE", Primitives::PlaneFlag{});
    corrade::enumOperators(planeFlags);

    py::enum_<Primitives::SquareFlag> squareFlags{m, "SquareFlags", "Square flags"};
    squareFlags.value("TEXTURE_COORDINATES", Primitives::SquareFlag::TextureCoordinates)
        .value("NONE", Primitives::SquareFlag{});
    corrade::enumOperators(squareFlags);

    py::enum_<Primitives::UVSphereFlag> uvSphereFlags{m, "UVSphereFlags", "UV sphere flags"};
    uvSphereFlags.value("TEXTURE_COORDINATES", Primitives::UVSphereFlag::TextureCoordinates)
        .value("TANGENTS", Primitives::UVSphereFlag::Tangents)
        .value("NONE", Primitives::UVSphereFlag{});
    corrade::enumOperators(uvSphereFlags);

    m
        .def("axis2d", Primitives::axis2D, "2D axis")
        .def("axis3d", Primitives::axis3D, "3D axis")

        .def("capsule2d_wireframe", [](UnsignedInt hemisphereRings, UnsignedInt cylinderRings, Float halfLength) {
            if(hemisphereRings < 1 || cylinderRings < 1) {
                PyErr_Format(PyExc_AssertionError, "expected at least one hemisphere ring and one cylinder ring but got %u and %u", hemisphereRings, cylinderRings);
                throw py::error_already_set{};
            }

            return Primitives::capsule2DWireframe(hemisphereRings, cylinderRings, halfLength);
        }, "Wireframe 2D capsule", py::arg("hemisphere_rings"), py::arg("cylinder_rings"), py::arg("half_length"))
        .def("capsule3d_solid", [](UnsignedInt hemisphereRings, UnsignedInt cylinderRings, UnsignedInt segments, Float halfLength, Primitives::CapsuleFlag flags) {
            if(hemisphereRings < 1 || cylinderRings < 1 || segments < 3) {
                PyErr_Format(PyExc_AssertionError, "expected at least one hemisphere ring, one cylinder ring and three segments but got %u, %u and %u", hemisphereRings, cylinderRings, segments);
                throw py::error_already_set{};
            }

            return Primitives::capsule3DSolid(hemisphereRings, cylinderRings, segments, halfLength, flags);
        }, "Solid 3D capsule", py::arg("hemisphere_rings"), py::arg("cylinder_rings"), py::arg("segments"), py::arg("half_length"), py::arg("flags") = Primitives::CapsuleFlag{})
        .def("capsule3d_wireframe", [](UnsignedInt hemisphereRings, UnsignedInt cylinderRings, UnsignedInt segments, Float halfLength) {
            if(hemisphereRings < 1 || cylinderRings < 1 || segments % 4 != 0 || !segments) {
                PyErr_Format(PyExc_AssertionError, "expected at least one hemisphere ring, one cylinder ring and multiples of 4 segments but got %u, %u and %u", hemisphereRings, cylinderRings, segments);
                throw py::error_already_set{};
            }

            return Primitives::capsule3DWireframe(hemisphereRings, cylinderRings, segments, halfLength);
        }, "Wireframe 3D capsule", py::arg("hemisphere_rings"), py::arg("cylinder_rings"), py::arg("segments"), py::arg("half_length"))

        .def("circle2d_solid", [](UnsignedInt segments, Primitives::Circle2DFlag flags) {
            if(segments < 3) {
                PyErr_Format(PyExc_AssertionError, "expected at least three segments but got %u", segments);
                throw py::error_already_set{};
            }

            return Primitives::circle2DSolid(segments, flags);
        }, "Solid 2D circle", py::arg("segments"), py::arg("flags") = Primitives::Circle2DFlag{})
        .def("circle2d_wireframe", [](UnsignedInt segments) {
            if(segments < 3) {
                PyErr_Format(PyExc_AssertionError, "expected at least three segments but got %u", segments);
                throw py::error_already_set{};
            }

            return Primitives::circle2DWireframe(segments);
        }, "Wireframe 2D circle", py::arg("segments"))
        .def("circle3d_solid", [](UnsignedInt segments, Primitives::Circle3DFlag flags) {
            if(segments < 3) {
                PyErr_Format(PyExc_AssertionError, "expected at least three segments but got %u", segments);
                throw py::error_already_set{};
            }

            return Primitives::circle3DSolid(segments, flags);
        }, "Solid 3D circle", py::arg("segments"), py::arg("flags") = Primitives::Circle3DFlag{})
        .def("circle3d_wireframe", [](UnsignedInt segments) {
            if(segments < 3) {
                PyErr_Format(PyExc_AssertionError, "expected at least three segments but got %u", segments);
                throw py::error_already_set{};
            }

            return Primitives::circle3DWireframe(segments);
        }, "Wireframe 3D circle", py::arg("segments"))

        .def("cone_solid", [](UnsignedInt rings, UnsignedInt segments, Float halfLength, Primitives::ConeFlag flags) {
            if(rings < 1 || segments < 3) {
                PyErr_Format(PyExc_AssertionError, "expected at least one ring and three segments but got %u and %u", rings, segments);
                throw py::error_already_set{};
            }

            return Primitives::coneSolid(rings, segments, halfLength, flags);
        }, "Solid 3D cone", py::arg("rings"), py::arg("segments"), py::arg("half_length"), py::arg("flags") = Primitives::ConeFlag{})
        .def("cone_wireframe", [](UnsignedInt segments, Float halfLength) {
            if(segments % 4 != 0 || !segments) {
                PyErr_Format(PyExc_AssertionError, "expected multiples of 4 segments but got %u", segments);
                throw py::error_already_set{};
            }

            return Primitives::coneWireframe(segments, halfLength);
        }, "Wireframe 3D cone", py::arg("segments"), py::arg("half_length"))

        .def("crosshair2d", Primitives::crosshair2D, "2D crosshair")
        .def("crosshair3d", Primitives::crosshair3D, "3D crosshair")

        .def("cube_solid", [](Primitives::CubeFlag flags) {
            const UnsignedInt textureCoordinateVariant = UnsignedByte(flags) >> 1;
            /** @todo don't hardcode this, how? */
            if(textureCoordinateVariant > 8) {
                PyErr_Format(PyExc_AssertionError, "unrecognized texture coordinate option 0x%x", UnsignedInt(UnsignedByte(flags & ~Primitives::CubeFlag::Tangents)));
                throw py::error_already_set{};
            }
            if((flags & Primitives::CubeFlag::Tangents) && !textureCoordinateVariant) {
                PyErr_SetString(PyExc_AssertionError, "a texture coordinate option has to be picked if tangents are enabled");
                throw py::error_already_set{};
            }

            return Primitives::cubeSolid(flags);
        }, "Solid 3D cube", py::arg("flags") = Primitives::CubeFlag{})
        .def("cube_solid_strip", Primitives::cubeSolidStrip, "Solid 3D cube as a single strip")
        .def("cube_wireframe", Primitives::cubeWireframe, "Wireframe 3D cube")

        .def("cylinder_solid", [](UnsignedInt rings, UnsignedInt segments, Float halfLength, Primitives::CylinderFlag flags) {
            if(rings < 1 || segments < 3) {
                PyErr_Format(PyExc_AssertionError, "expected at least one ring and three segments but got %u and %u", rings, segments);
                throw py::error_already_set{};
            }

            return Primitives::cylinderSolid(rings, segments, halfLength, flags);
        }, "Solid 3D cylinder", py::arg("rings"), py::arg("segments"), py::arg("half_length"), py::arg("flags") = Primitives::CylinderFlag{})
        .def("cylinder_wireframe", [](UnsignedInt rings, UnsignedInt segments, Float halfLength) {
            if(rings < 1 || segments % 4 != 0 || !segments) {
                PyErr_Format(PyExc_AssertionError, "expected at least one ring and multiples of 4 segments but got %u and %u", rings, segments);
                throw py::error_already_set{};
            }

            return Primitives::cylinderWireframe(rings, segments, halfLength);
        }, "Wireframe 3D cylinder", py::arg("rings"), py::arg("segments"), py::arg("half_length"))

        .def("gradient2d", Primitives::gradient2D, "2D square with a gradient", py::arg("a"), py::arg("color_a"), py::arg("b"), py::arg("color_b"))
        .def("gradient2d_horizontal", Primitives::gradient2DHorizontal, "2D square with a horizontal gradient", py::arg("color_left"), py::arg("color_right"))
        .def("gradient2d_vertical", Primitives::gradient2DVertical, "2D square with a vertical gradient", py::arg("color_bottom"), py::arg("color_top"))
        .def("gradient3d", Primitives::gradient3D, "3D plane with a gradient", py::arg("a"), py::arg("color_a"), py::arg("b"), py::arg("color_b"))
        .def("gradient3d_horizontal", Primitives::gradient3DHorizontal, "3D plane with a horizontal gradient", py::arg("color_left"), py::arg("color_right"))
        .def("gradient3d_vertical", Primitives::gradient3DVertical, "3D plane with a vertical gradient", py::arg("color_bottom"), py::arg("color_top"))

        .def("grid3d_solid", [](const Vector2i& subdivisions, Primitives::GridFlag flags) {
            return Primitives::grid3DSolid(subdivisions, flags);
        }, "Solid 3D grid", py::arg("subdivisions"), py::arg("flags") = Primitives::GridFlag::Normals)
        .def("grid3d_wireframe", Primitives::grid3DWireframe, "Wireframe 3D grid")

        .def("icosphere_solid", Primitives::icosphereSolid, py::arg("subdivisions"))

        .def("line2d", static_cast<Trade::MeshData(*)(const Vector2&, const Vector2&)>(Primitives::line2D), "2D line", py::arg("a"), py::arg("b"))
        .def("line2d", static_cast<Trade::MeshData(*)()>(Primitives::line2D), "2D line in an identity transformation")
        .def("line3d", static_cast<Trade::MeshData(*)(const Vector3&, const Vector3&)>(Primitives::line3D), "3D line", py::arg("a"), py::arg("b"))
        .def("line3d", static_cast<Trade::MeshData(*)()>(Primitives::line3D), "3D line in an identity transformation")

        .def("plane_solid", [](Primitives::PlaneFlag flags) {
            return Primitives::planeSolid(flags);
        }, "Solid 3D plane", py::arg("flags") = Primitives::PlaneFlag{})
        .def("plane_wireframe", Primitives::planeWireframe, "Wireframe 3D plane")

        .def("square_solid", [](Primitives::SquareFlag flags) {
            return Primitives::squareSolid(flags);
        }, "Solid 2D square", py::arg("flags") = Primitives::SquareFlag{})
        .def("square_wireframe", Primitives::squareWireframe, "Wireframe 2D square")

        .def("uv_sphere_solid", [](UnsignedInt rings, UnsignedInt segments, Primitives::UVSphereFlag flags) {
            if(rings < 2 || segments < 3) {
                PyErr_Format(PyExc_AssertionError, "expected at least two rings and three segments but got %u and %u", rings, segments);
                throw py::error_already_set{};
            }

            return Primitives::uvSphereSolid(rings, segments, flags);
        }, "Solid 3D UV sphere", py::arg("rings"), py::arg("segments"), py::arg("flags") = Primitives::UVSphereFlag{})
        .def("uv_sphere_wireframe", [](UnsignedInt rings, UnsignedInt segments) {
            if(rings % 2 != 0 || !rings || segments % 4 != 0 || !segments) {
                PyErr_Format(PyExc_AssertionError, "expected multiples of 2 rings and multiples of 4 segments but got %u and %u", rings, segments);
                throw py::error_already_set{};
            }

            return Primitives::uvSphereWireframe(rings, segments);
        }, "Wireframe 3D UV sphere", py::arg("rings"), py::arg("segments"));
}

}

#ifndef MAGNUM_BUILD_STATIC
/* TODO: remove declaration when https://github.com/pybind/pybind11/pull/1863
   is released */
extern "C" PYBIND11_EXPORT PyObject* PyInit_primitives();
PYBIND11_MODULE(primitives, m) {
    magnum::primitives(m);
}
#endif