BPy_CurvePoint.cpp

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2004-2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#include "BPy_CurvePoint.h"
 
#include "../BPy_Convert.h"
#include "../Interface0D/BPy_SVertex.h"
 
using namespace Freestyle;

 
/*----------------------CurvePoint methods----------------------------*/
 
PyDoc_STRVAR(
    /* Wrap. */
    CurvePoint_doc,
    "Class hierarchy: :class:`Interface0D` > :class:`CurvePoint`\n"
    "\n"
    "Class to represent a point of a curve. A CurvePoint can be any point\n"
    "of a 1D curve (it doesn't have to be a vertex of the curve). Any\n"
    ":class:`Interface1D` is built upon ViewEdges, themselves built upon\n"
    "FEdges. Therefore, a curve is basically a polyline made of a list of\n"
    ":class:`SVertex` objects. Thus, a CurvePoint is built by linearly\n"
    "interpolating two :class:`SVertex` instances. CurvePoint can be used\n"
    "as virtual points while querying 0D information along a curve at a\n"
    "given resolution.\n"
    "\n"
    ".. method:: __init__()\n"
    "            __init__(brother)\n"
    "            __init__(first_vertex, second_vertex, t2d)\n"
    "            __init__(first_point, second_point, t2d)\n"
    "\n"
    "   Builds a CurvePoint using the default constructor, copy constructor,\n"
    "   or one of the overloaded constructors. The over loaded constructors\n"
    "   can either take two :class:`SVertex` or two :class:`CurvePoint`\n"
    "   objects and an interpolation parameter\n"
    "\n"
    "   :arg brother: A CurvePoint object.\n"
    "   :type brother: :class:`CurvePoint`\n"
    "   :arg first_vertex: The first SVertex.\n"
    "   :type first_vertex: :class:`SVertex`\n"
    "   :arg second_vertex: The second SVertex.\n"
    "   :type second_vertex: :class:`SVertex`\n"
    "   :arg first_point: The first CurvePoint.\n"
    "   :type first_point: :class:`CurvePoint`\n"
    "   :arg second_point: The second CurvePoint.\n"
    "   :type second_point: :class:`CurvePoint`\n"
    "   :arg t2d: A 2D interpolation parameter used to linearly interpolate\n"
    "             first_vertex and second_vertex or first_point and second_point.\n"
    "   :type t2d: float\n");
 
static int CurvePoint_init(BPy_CurvePoint *self, PyObject *args, PyObject *kwds)
{
  static const char *kwlist_1[] = {"brother", nullptr};
  static const char *kwlist_2[] = {"first_vertex", "second_vertex", "t2d", nullptr};
  static const char *kwlist_3[] = {"first_point", "second_point", "t2d", nullptr};
  PyObject *obj1 = nullptr, *obj2 = nullptr;
  float t2d;
 
  if (PyArg_ParseTupleAndKeywords(args, kwds, "|O!", (char **)kwlist_1, &CurvePoint_Type, &obj1)) {
    if (!obj1) {
      self->cp = new CurvePoint();
    }
    else {
      self->cp = new CurvePoint(*(((BPy_CurvePoint *)obj1)->cp));
    }
  }
  else if ((void)PyErr_Clear(),
           PyArg_ParseTupleAndKeywords(args,
                                       kwds,
                                       "O!O!f",
                                       (char **)kwlist_2,
                                       &SVertex_Type,
                                       &obj1,
                                       &SVertex_Type,
                                       &obj2,
                                       &t2d))
  {
    self->cp = new CurvePoint(((BPy_SVertex *)obj1)->sv, ((BPy_SVertex *)obj2)->sv, t2d);
  }
  else if ((void)PyErr_Clear(),
           PyArg_ParseTupleAndKeywords(args,
                                       kwds,
                                       "O!O!f",
                                       (char **)kwlist_3,
                                       &CurvePoint_Type,
                                       &obj1,
                                       &CurvePoint_Type,
                                       &obj2,
                                       &t2d))
  {
    CurvePoint *cp1 = ((BPy_CurvePoint *)obj1)->cp;
    CurvePoint *cp2 = ((BPy_CurvePoint *)obj2)->cp;
    if (!cp1 || cp1->A() == nullptr || cp1->B() == nullptr) {
      PyErr_SetString(PyExc_TypeError, "argument 1 is an invalid CurvePoint object");
      return -1;
    }
    if (!cp2 || cp2->A() == nullptr || cp2->B() == nullptr) {
      PyErr_SetString(PyExc_TypeError, "argument 2 is an invalid CurvePoint object");
      return -1;
    }
    self->cp = new CurvePoint(cp1, cp2, t2d);
  }
  else {
    PyErr_SetString(PyExc_TypeError, "invalid argument(s)");
    return -1;
  }
  self->py_if0D.if0D = self->cp;
  self->py_if0D.borrowed = false;
  return 0;
}

 
/*----------------------CurvePoint get/setters ----------------------------*/
 
PyDoc_STRVAR(
    /* Wrap. */
    CurvePoint_first_svertex_doc,
    "The first SVertex upon which the CurvePoint is built.\n"
    "\n"
    ":type: :class:`SVertex`");
 
static PyObject *CurvePoint_first_svertex_get(BPy_CurvePoint *self, void * /*closure*/)
{
  SVertex *A = self->cp->A();
  if (A) {
    return BPy_SVertex_from_SVertex(*A);
  }
  Py_RETURN_NONE;
}
 
static int CurvePoint_first_svertex_set(BPy_CurvePoint *self, PyObject *value, void * /*closure*/)
{
  if (!BPy_SVertex_Check(value)) {
    PyErr_SetString(PyExc_TypeError, "value must be an SVertex");
    return -1;
  }
  self->cp->setA(((BPy_SVertex *)value)->sv);
  return 0;
}
 
PyDoc_STRVAR(
    /* Wrap. */
    CurvePoint_second_svertex_doc,
    "The second SVertex upon which the CurvePoint is built.\n"
    "\n"
    ":type: :class:`SVertex`");
 
static PyObject *CurvePoint_second_svertex_get(BPy_CurvePoint *self, void * /*closure*/)
{
  SVertex *B = self->cp->B();
  if (B) {
    return BPy_SVertex_from_SVertex(*B);
  }
  Py_RETURN_NONE;
}
 
static int CurvePoint_second_svertex_set(BPy_CurvePoint *self, PyObject *value, void * /*closure*/)
{
  if (!BPy_SVertex_Check(value)) {
    PyErr_SetString(PyExc_TypeError, "value must be an SVertex");
    return -1;
  }
  self->cp->setB(((BPy_SVertex *)value)->sv);
  return 0;
}
 
PyDoc_STRVAR(
    /* Wrap. */
    CurvePoint_fedge_doc,
    "Gets the FEdge for the two SVertices that given CurvePoints consists out of.\n"
    "A shortcut for CurvePoint.first_svertex.get_fedge(CurvePoint.second_svertex).\n"
    "\n"
    ":type: :class:`FEdge`");
 
static PyObject *CurvePoint_fedge_get(BPy_CurvePoint *self, void * /*closure*/)
{
  SVertex *A = self->cp->A();
  Interface0D *B = (Interface0D *)self->cp->B();
  // B can be nullptr under certain circumstances
  if (B) {
    return Any_BPy_Interface1D_from_Interface1D(*(A->getFEdge(*B)));
  }
  Py_RETURN_NONE;
}
 
PyDoc_STRVAR(
    /* Wrap. */
    CurvePoint_t2d_doc,
    "The 2D interpolation parameter.\n"
    "\n"
    ":type: float");
 
static PyObject *CurvePoint_t2d_get(BPy_CurvePoint *self, void * /*closure*/)
{
  return PyFloat_FromDouble(self->cp->t2d());
}
 
static int CurvePoint_t2d_set(BPy_CurvePoint *self, PyObject *value, void * /*closure*/)
{
  float scalar;
  if ((scalar = PyFloat_AsDouble(value)) == -1.0f && PyErr_Occurred()) {
    PyErr_SetString(PyExc_TypeError, "value must be a number");
    return -1;
  }
  self->cp->setT2d(scalar);
  return 0;
}
 
static PyGetSetDef BPy_CurvePoint_getseters[] = {
    {"first_svertex",
     (getter)CurvePoint_first_svertex_get,
     (setter)CurvePoint_first_svertex_set,
     CurvePoint_first_svertex_doc,
     nullptr},
    {"second_svertex",
     (getter)CurvePoint_second_svertex_get,
     (setter)CurvePoint_second_svertex_set,
     CurvePoint_second_svertex_doc,
     nullptr},
    {"fedge", (getter)CurvePoint_fedge_get, nullptr, CurvePoint_fedge_doc, nullptr},
    {"t2d", (getter)CurvePoint_t2d_get, (setter)CurvePoint_t2d_set, CurvePoint_t2d_doc, nullptr},
    {nullptr, nullptr, nullptr, nullptr, nullptr} /* Sentinel */
};
 
/*-----------------------BPy_CurvePoint type definition ------------------------------*/
 
PyTypeObject CurvePoint_Type = {
    /*ob_base*/ PyVarObject_HEAD_INIT(nullptr, 0)
    /*tp_name*/ "CurvePoint",
    /*tp_basicsize*/ sizeof(BPy_CurvePoint),
    /*tp_itemsize*/ 0,
    /*tp_dealloc*/ nullptr,
    /*tp_vectorcall_offset*/ 0,
    /*tp_getattr*/ nullptr,
    /*tp_setattr*/ nullptr,
    /*tp_as_async*/ nullptr,
    /*tp_repr*/ nullptr,
    /*tp_as_number*/ nullptr,
    /*tp_as_sequence*/ nullptr,
    /*tp_as_mapping*/ nullptr,
    /*tp_hash*/ nullptr,
    /*tp_call*/ nullptr,
    /*tp_str*/ nullptr,
    /*tp_getattro*/ nullptr,
    /*tp_setattro*/ nullptr,
    /*tp_as_buffer*/ nullptr,
    /*tp_flags*/ Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
    /*tp_doc*/ CurvePoint_doc,
    /*tp_traverse*/ nullptr,
    /*tp_clear*/ nullptr,
    /*tp_richcompare*/ nullptr,
    /*tp_weaklistoffset*/ 0,
    /*tp_iter*/ nullptr,
    /*tp_iternext*/ nullptr,
    /*tp_methods*/ nullptr,
    /*tp_members*/ nullptr,
    /*tp_getset*/ BPy_CurvePoint_getseters,
    /*tp_base*/ &Interface0D_Type,
    /*tp_dict*/ nullptr,
    /*tp_descr_get*/ nullptr,
    /*tp_descr_set*/ nullptr,
    /*tp_dictoffset*/ 0,
    /*tp_init*/ (initproc)CurvePoint_init,
    /*tp_alloc*/ nullptr,
    /*tp_new*/ nullptr,
};