ccTorus.cpp

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        CloudViewer: www.cloudViewer.org                  -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.cloudViewer.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#include <pybind11/pybind11.h>
#include <pybind11/stl.h>
#include <pybind11/stl_bind.h>
 
#include <ecvTorus.h>
 
#include "../casters.h"
 
namespace py = pybind11;
using namespace pybind11::literals;
 
void define_ccTorus(py::module &m)
{
    py::class_<ccTorus, ccGenericPrimitive>(m, "ccTorus", R"doc(
    ccTorus
 
    Parameters
    ----------
    insideRadius : PointCoordinateType
    outsideRadius : PointCoordinateType
    angleRad : float
        subtended angle (in radians)
    rectangularSection : bool
        whether section is rectangular or round
    rectSectionHeight : PointCoordinateType
        section height (if rectangular torus)
    transMat : , optional
        optional 3D transformation (can be set afterwards with ccDrawableObject::setGLTransformation)
    name : str, default: Sphere
        name of the sphere object
    precision : int, default: 24
        drawing precision (angular step = 360/precision)
    uniqueID : int, optional
        unique ID (handle with care)
 
    Example
    -------
 
    .. code:: Python
 
        torus = pycc.ccTorus(5.0, 10.0)
    )doc")
        .def(
            py::init<PointCoordinateType,
                     PointCoordinateType,
                     double,
                     bool,
                     PointCoordinateType,
                     const ccGLMatrix *,
                     QString,
                     unsigned>(),
            "insideRadius"_a,
            "outsideRadius"_a,
            "angleRad"_a = 2.0 * M_PI,
            "rectangularSection"_a = false,
            "rectSectionHeight"_a = 0,
            "transMat"_a = nullptr,
            "name"_a = QString("Torus"),
            "precision"_a = []() { return ccTorus::DEFAULT_DRAWING_PRECISION; }());
}