Major API updates were made to address code review comments.
This revision mostly focuses on Python wrappers of C++ 0D and 1D elements (i.e.,
Interface0D and Interface1D, as well as their subclasses).
* Most getter/setter methods were reimplemented as attributes using PyGetSetDef.
Vector attributes are now implemented based on mathutils callbacks. Boolean
attributes now only accept boolean values.
* The __getitem__ method was removed and the Sequence protocol was used instead.
* The naming of methods and attributes was fixed to follow the naming conventions
of the Blender Python API (i.e., lower case + underscores for methods and attributes,
and CamelCase for classes). Some naming inconsistency within the Freestyle Python
API was also addressed.
* The Freestyle API had a number of method names including prefix/suffix "A" and
"B", and their meanings were inconsistent (i.e., referring to different things
depending on the classes). The names with these two letters were replaced with
more straightforward names. Also some attribute names were changed so as to indicate
the type of the value (e.g., FEdge.next_fedge instead of FEdge.next_edge) in line
with other names explicitly indicating what the value is (e.g., SVertex.viewvertex).
* In addition, some code clean-up was done in both C++ and Python.
Notes:
In summary, the following irregular naming changes were made through this revision
(those resulting from regular changes of naming conventions are not listed):
- CurvePoint: {A,B} --> {first,second}_svertex
- FEdge: vertex{A,B} --> {first,second}_svertex
- FEdge: {next,previous}Edge --> {next,previous}_fedge
- FEdgeSharp: normal{A,B} --> normal_{right,left}
- FEdgeSharp: {a,b}FaceMark --> face_mark_{right,left}
- FEdgeSharp: {a,b}Material --> material_{right,left}
- FEdgeSharp: {a,b}MaterialIndex --> material_index_{right,left}
- FrsCurve: empty --> is_empty
- FrsCurve: nSegments --> segments_size
- TVertex: mate() --> get_mate()
- ViewEdge: fedge{A,B} --> {first,last}_fedge
- ViewEdge: setaShape, aShape --> occlude
- ViewEdge: {A,B} --> {first,last}_viewvertex
- ViewMap: getScene3dBBox --> scene_bbox
247 lines
8.1 KiB
C++
247 lines
8.1 KiB
C++
#include "BPy_CurvePoint.h"
|
|
|
|
#include "../BPy_Convert.h"
|
|
#include "../Interface0D/BPy_SVertex.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
/*----------------------CurvePoint methods----------------------------*/
|
|
|
|
PyDoc_STRVAR(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"
|
|
"\n"
|
|
" Defult constructor.\n"
|
|
"\n"
|
|
".. method:: __init__(iBrother)\n"
|
|
"\n"
|
|
" Copy constructor.\n"
|
|
"\n"
|
|
" :arg iBrother: A CurvePoint object.\n"
|
|
" :type iBrother: :class:`CurvePoint`\n"
|
|
"\n"
|
|
".. method:: __init__(iA, iB, t2d)\n"
|
|
"\n"
|
|
" Builds a CurvePoint from two SVertex and an interpolation parameter.\n"
|
|
"\n"
|
|
" :arg iA: The first SVertex.\n"
|
|
" :type iA: :class:`SVertex`\n"
|
|
" :arg iB: The second SVertex.\n"
|
|
" :type iB: :class:`SVertex`\n"
|
|
" :arg t2d: A 2D interpolation parameter used to linearly interpolate\n"
|
|
" iA and iB.\n"
|
|
" :type t2d: float\n"
|
|
"\n"
|
|
".. method:: __init__(iA, iB, t2d)\n"
|
|
"\n"
|
|
" Builds a CurvePoint from two CurvePoint and an interpolation\n"
|
|
" parameter.\n"
|
|
"\n"
|
|
" :arg iA: The first CurvePoint.\n"
|
|
" :type iA: :class:`CurvePoint`\n"
|
|
" :arg iB: The second CurvePoint.\n"
|
|
" :type iB: :class:`CurvePoint`\n"
|
|
" :arg t2d: The 2D interpolation parameter used to linearly\n"
|
|
" interpolate iA and iB.\n"
|
|
" :type t2d: float");
|
|
|
|
static int CurvePoint_init(BPy_CurvePoint *self, PyObject *args, PyObject *kwds)
|
|
{
|
|
|
|
PyObject *obj1 = 0, *obj2 = 0 , *obj3 = 0;
|
|
|
|
if (! PyArg_ParseTuple(args, "|OOO!", &obj1, &obj2, &PyFloat_Type, &obj3) )
|
|
return -1;
|
|
|
|
if( !obj1 ){
|
|
self->cp = new CurvePoint();
|
|
|
|
} else if( !obj2 && BPy_CurvePoint_Check(obj1) ) {
|
|
self->cp = new CurvePoint( *(((BPy_CurvePoint *) obj1)->cp) );
|
|
|
|
} else if( obj3 && BPy_SVertex_Check(obj1) && BPy_SVertex_Check(obj2) ) {
|
|
self->cp = new CurvePoint( ((BPy_SVertex *) obj1)->sv,
|
|
((BPy_SVertex *) obj2)->sv,
|
|
PyFloat_AsDouble( obj3 ) );
|
|
|
|
} else if( obj3 && BPy_CurvePoint_Check(obj1) && BPy_CurvePoint_Check(obj2) ) {
|
|
CurvePoint *cp1 = ((BPy_CurvePoint *) obj1)->cp;
|
|
CurvePoint *cp2 = ((BPy_CurvePoint *) obj2)->cp;
|
|
if( !cp1 || cp1->A() == 0 || cp1->B() == 0 ) {
|
|
PyErr_SetString(PyExc_TypeError, "argument 1 is an invalid CurvePoint object");
|
|
return -1;
|
|
}
|
|
if( !cp2 || cp2->A() == 0 || cp2->B() == 0 ) {
|
|
PyErr_SetString(PyExc_TypeError, "argument 2 is an invalid CurvePoint object");
|
|
return -1;
|
|
}
|
|
self->cp = new CurvePoint( cp1, cp2, PyFloat_AsDouble( obj3 ) );
|
|
|
|
} else {
|
|
PyErr_SetString(PyExc_TypeError, "invalid argument(s)");
|
|
return -1;
|
|
}
|
|
|
|
self->py_if0D.if0D = self->cp;
|
|
self->py_if0D.borrowed = 0;
|
|
|
|
return 0;
|
|
}
|
|
|
|
///bool operator== (const CurvePoint &b)
|
|
|
|
static PyMethodDef BPy_CurvePoint_methods[] = {
|
|
{NULL, NULL, 0, NULL}
|
|
};
|
|
|
|
/*----------------------CurvePoint get/setters ----------------------------*/
|
|
|
|
PyDoc_STRVAR(CurvePoint_first_svertex_doc,
|
|
"The first SVertex upon which the CurvePoint is built.\n"
|
|
"\n"
|
|
":type: int");
|
|
|
|
static PyObject *CurvePoint_first_svertex_get(BPy_CurvePoint *self, void *UNUSED(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 *UNUSED(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(CurvePoint_second_svertex_doc,
|
|
"The second SVertex upon which the CurvePoint is built.\n"
|
|
"\n"
|
|
":type: int");
|
|
|
|
static PyObject *CurvePoint_second_svertex_get(BPy_CurvePoint *self, void *UNUSED(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 *UNUSED(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(CurvePoint_t2d_doc,
|
|
"The 2D interpolation parameter.\n"
|
|
"\n"
|
|
":type: float");
|
|
|
|
static PyObject *CurvePoint_t2d_get(BPy_CurvePoint *self, void *UNUSED(closure))
|
|
{
|
|
return PyFloat_FromDouble(self->cp->t2d());
|
|
}
|
|
|
|
static int CurvePoint_t2d_set(BPy_CurvePoint *self, PyObject *value, void *UNUSED(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;
|
|
}
|
|
|
|
PyDoc_STRVAR(CurvePoint_curvature_fredo_doc,
|
|
"The angle (Fredo's curvature) in radians.\n"
|
|
"\n"
|
|
":type: float");
|
|
|
|
static PyObject *CurvePoint_curvature_fredo_get(BPy_CurvePoint *self, void *UNUSED(closure))
|
|
{
|
|
return PyFloat_FromDouble(self->cp->curvatureFredo());
|
|
}
|
|
|
|
// todo - CurvePoint.directionFredo()
|
|
|
|
static PyGetSetDef BPy_CurvePoint_getseters[] = {
|
|
{(char *)"first_svertex", (getter)CurvePoint_first_svertex_get, (setter)CurvePoint_first_svertex_set, (char *)CurvePoint_first_svertex_doc, NULL},
|
|
{(char *)"second_svertex", (getter)CurvePoint_second_svertex_get, (setter)CurvePoint_second_svertex_set, (char *)CurvePoint_second_svertex_doc, NULL},
|
|
{(char *)"t2d", (getter)CurvePoint_t2d_get, (setter)CurvePoint_t2d_set, (char *)CurvePoint_t2d_doc, NULL},
|
|
{(char *)"curvature_fredo", (getter)CurvePoint_curvature_fredo_get, (setter)NULL, (char *)CurvePoint_curvature_fredo_doc, NULL},
|
|
{NULL, NULL, NULL, NULL, NULL} /* Sentinel */
|
|
};
|
|
|
|
/*-----------------------BPy_CurvePoint type definition ------------------------------*/
|
|
PyTypeObject CurvePoint_Type = {
|
|
PyVarObject_HEAD_INIT(NULL, 0)
|
|
"CurvePoint", /* tp_name */
|
|
sizeof(BPy_CurvePoint), /* tp_basicsize */
|
|
0, /* tp_itemsize */
|
|
0, /* tp_dealloc */
|
|
0, /* tp_print */
|
|
0, /* tp_getattr */
|
|
0, /* tp_setattr */
|
|
0, /* tp_reserved */
|
|
0, /* tp_repr */
|
|
0, /* tp_as_number */
|
|
0, /* tp_as_sequence */
|
|
0, /* tp_as_mapping */
|
|
0, /* tp_hash */
|
|
0, /* tp_call */
|
|
0, /* tp_str */
|
|
0, /* tp_getattro */
|
|
0, /* tp_setattro */
|
|
0, /* tp_as_buffer */
|
|
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
|
|
CurvePoint_doc, /* tp_doc */
|
|
0, /* tp_traverse */
|
|
0, /* tp_clear */
|
|
0, /* tp_richcompare */
|
|
0, /* tp_weaklistoffset */
|
|
0, /* tp_iter */
|
|
0, /* tp_iternext */
|
|
BPy_CurvePoint_methods, /* tp_methods */
|
|
0, /* tp_members */
|
|
BPy_CurvePoint_getseters, /* tp_getset */
|
|
&Interface0D_Type, /* tp_base */
|
|
0, /* tp_dict */
|
|
0, /* tp_descr_get */
|
|
0, /* tp_descr_set */
|
|
0, /* tp_dictoffset */
|
|
(initproc)CurvePoint_init, /* tp_init */
|
|
0, /* tp_alloc */
|
|
0, /* tp_new */
|
|
};
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|