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
315 lines
9.1 KiB
C++
315 lines
9.1 KiB
C++
#include "BPy_ViewShape.h"
|
|
|
|
#include "BPy_Convert.h"
|
|
#include "Interface0D/BPy_ViewVertex.h"
|
|
#include "Interface1D/BPy_ViewEdge.h"
|
|
#include "BPy_SShape.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
//-------------------MODULE INITIALIZATION--------------------------------
|
|
|
|
int ViewShape_Init(PyObject *module)
|
|
{
|
|
if (module == NULL)
|
|
return -1;
|
|
|
|
if (PyType_Ready(&ViewShape_Type) < 0)
|
|
return -1;
|
|
Py_INCREF(&ViewShape_Type);
|
|
PyModule_AddObject(module, "ViewShape", (PyObject *)&ViewShape_Type);
|
|
|
|
return 0;
|
|
}
|
|
|
|
/*----------------------ViewShape methods ----------------------------*/
|
|
|
|
PyDoc_STRVAR(ViewShape_doc,
|
|
"Class gathering the elements of the ViewMap (i.e., :class:`ViewVertex`\n"
|
|
"and :class:`ViewEdge`) that are issued from the same input shape.\n"
|
|
"\n"
|
|
".. method:: __init__()\n"
|
|
"\n"
|
|
" Default constructor.\n"
|
|
"\n"
|
|
".. method:: __init__(iBrother)\n"
|
|
"\n"
|
|
" Copy constructor.\n"
|
|
"\n"
|
|
" :arg iBrother: A ViewShape object.\n"
|
|
" :type iBrother: :class:`ViewShape`\n"
|
|
"\n"
|
|
".. method:: __init__(iSShape)\n"
|
|
"\n"
|
|
" Builds a ViewShape from an SShape.\n"
|
|
"\n"
|
|
" :arg iSShape: An SShape object.\n"
|
|
" :type iSShape: :class:`SShape`");
|
|
|
|
static int ViewShape_init(BPy_ViewShape *self, PyObject *args, PyObject *kwds)
|
|
{
|
|
PyObject *obj;
|
|
|
|
if (!PyArg_ParseTuple(args, "|O", &obj))
|
|
return -1;
|
|
|
|
if (!obj) {
|
|
self->vs = new ViewShape();
|
|
|
|
} else if (BPy_SShape_Check(obj)) {
|
|
self->vs = new ViewShape(((BPy_SShape *)obj)->ss);
|
|
|
|
} else if (BPy_ViewShape_Check(obj)) {
|
|
self->vs = new ViewShape(*(((BPy_ViewShape *)obj)->vs));
|
|
|
|
} else {
|
|
PyErr_SetString(PyExc_TypeError, "invalid argument");
|
|
return -1;
|
|
}
|
|
self->borrowed = 0;
|
|
|
|
return 0;
|
|
}
|
|
|
|
static void ViewShape_dealloc(BPy_ViewShape *self)
|
|
{
|
|
if (self->vs && !self->borrowed)
|
|
delete self->vs;
|
|
Py_TYPE(self)->tp_free((PyObject*)self);
|
|
}
|
|
|
|
static PyObject * ViewShape_repr(BPy_ViewShape *self)
|
|
{
|
|
return PyUnicode_FromFormat("ViewShape - address: %p", self->vs );
|
|
}
|
|
|
|
PyDoc_STRVAR(ViewShape_add_edge_doc,
|
|
".. method:: add_edge(iEdge)\n"
|
|
"\n"
|
|
" Adds a ViewEdge to the list of ViewEdge objects.\n"
|
|
"\n"
|
|
" :arg iEdge: A ViewEdge object.\n"
|
|
" :type iEdge: :class:`ViewEdge`\n");
|
|
|
|
static PyObject * ViewShape_add_edge(BPy_ViewShape *self , PyObject *args)
|
|
{
|
|
PyObject *py_ve = 0;
|
|
|
|
if (!PyArg_ParseTuple(args, "O!", &ViewEdge_Type, &py_ve))
|
|
return NULL;
|
|
self->vs->AddEdge(((BPy_ViewEdge *)py_ve)->ve);
|
|
Py_RETURN_NONE;
|
|
}
|
|
|
|
PyDoc_STRVAR(ViewShape_add_vertex_doc,
|
|
".. method:: add_vertex(iVertex)\n"
|
|
"\n"
|
|
" Adds a ViewVertex to the list of the ViewVertex objects.\n"
|
|
"\n"
|
|
" :arg iVertex: A ViewVertex object.\n"
|
|
" :type iVertex: :class:`ViewVertex`");
|
|
|
|
static PyObject * ViewShape_add_vertex(BPy_ViewShape *self , PyObject *args)
|
|
{
|
|
PyObject *py_vv = 0;
|
|
|
|
if (!PyArg_ParseTuple(args, "O!", &ViewVertex_Type, &py_vv))
|
|
return NULL;
|
|
self->vs->AddVertex(((BPy_ViewVertex *)py_vv)->vv);
|
|
Py_RETURN_NONE;
|
|
}
|
|
|
|
// virtual ViewShape *duplicate()
|
|
|
|
static PyMethodDef BPy_ViewShape_methods[] = {
|
|
{"add_edge", (PyCFunction)ViewShape_add_edge, METH_VARARGS, ViewShape_add_edge_doc},
|
|
{"add_vertex", (PyCFunction)ViewShape_add_vertex, METH_VARARGS, ViewShape_add_vertex_doc},
|
|
{NULL, NULL, 0, NULL}
|
|
};
|
|
|
|
/*----------------------ViewShape get/setters ----------------------------*/
|
|
|
|
PyDoc_STRVAR(ViewShape_sshape_doc,
|
|
"The SShape on top of which this ViewShape is built.\n"
|
|
"\n"
|
|
":type: :class:`SShape`");
|
|
|
|
static PyObject *ViewShape_sshape_get(BPy_ViewShape *self, void *UNUSED(closure))
|
|
{
|
|
return BPy_SShape_from_SShape(*(self->vs->sshape()));
|
|
}
|
|
|
|
static int ViewShape_sshape_set(BPy_ViewShape *self, PyObject *value, void *UNUSED(closure))
|
|
{
|
|
if (!BPy_SShape_Check(value)) {
|
|
PyErr_SetString(PyExc_TypeError, "value must be an SShape");
|
|
return -1;
|
|
}
|
|
self->vs->setSShape(((BPy_SShape *)value)->ss);
|
|
return 0;
|
|
}
|
|
|
|
PyDoc_STRVAR(ViewShape_vertices_doc,
|
|
"The list of ViewVertex objects contained in this ViewShape.\n"
|
|
"\n"
|
|
":type: List of :class:`ViewVertex` objects");
|
|
|
|
static PyObject *ViewShape_vertices_get(BPy_ViewShape *self, void *UNUSED(closure))
|
|
{
|
|
PyObject *py_vertices = PyList_New(0);
|
|
|
|
vector< ViewVertex * > vertices = self->vs->vertices();
|
|
vector< ViewVertex * >::iterator it;
|
|
for (it = vertices.begin(); it != vertices.end(); it++) {
|
|
PyList_Append( py_vertices, Any_BPy_ViewVertex_from_ViewVertex(*(*it)));
|
|
}
|
|
return py_vertices;
|
|
}
|
|
|
|
static int ViewShape_vertices_set(BPy_ViewShape *self, PyObject *value, void *UNUSED(closure))
|
|
{
|
|
PyObject *list = 0;
|
|
PyObject *item;
|
|
vector< ViewVertex *> v;
|
|
|
|
if (!PyList_Check(value)) {
|
|
PyErr_SetString(PyExc_TypeError, "value must be a list of ViewVertex objects");
|
|
return -1;
|
|
}
|
|
for (int i = 0; i < PyList_Size(list); i++) {
|
|
item = PyList_GetItem(list, i);
|
|
if (BPy_ViewVertex_Check(item)) {
|
|
v.push_back(((BPy_ViewVertex *)item)->vv);
|
|
} else {
|
|
PyErr_SetString(PyExc_TypeError, "value must be a list of ViewVertex objects");
|
|
return -1;
|
|
}
|
|
}
|
|
self->vs->setVertices(v);
|
|
return 0;
|
|
}
|
|
|
|
PyDoc_STRVAR(ViewShape_edges_doc,
|
|
"The list of ViewEdge objects contained in this ViewShape.\n"
|
|
"\n"
|
|
":type: List of :class:`ViewEdge` objects");
|
|
|
|
static PyObject *ViewShape_edges_get(BPy_ViewShape *self, void *UNUSED(closure))
|
|
{
|
|
PyObject *py_edges = PyList_New(0);
|
|
|
|
vector< ViewEdge * > edges = self->vs->edges();
|
|
vector< ViewEdge * >::iterator it;
|
|
|
|
for (it = edges.begin(); it != edges.end(); it++) {
|
|
PyList_Append(py_edges, BPy_ViewEdge_from_ViewEdge(*(*it)));
|
|
}
|
|
return py_edges;
|
|
}
|
|
|
|
static int ViewShape_edges_set(BPy_ViewShape *self, PyObject *value, void *UNUSED(closure))
|
|
{
|
|
PyObject *list = 0;
|
|
PyObject *item;
|
|
vector<ViewEdge *> v;
|
|
|
|
if (!PyList_Check(value)) {
|
|
PyErr_SetString(PyExc_TypeError, "value must be a list of ViewEdge objects");
|
|
return -1;
|
|
}
|
|
for (int i = 0; i < PyList_Size(list); i++) {
|
|
item = PyList_GetItem(list, i);
|
|
if (BPy_ViewEdge_Check(item)) {
|
|
v.push_back(((BPy_ViewEdge *)item)->ve);
|
|
} else {
|
|
PyErr_SetString(PyExc_TypeError, "argument must be list of ViewEdge objects");
|
|
return -1;
|
|
}
|
|
}
|
|
self->vs->setEdges(v);
|
|
return 0;
|
|
}
|
|
|
|
PyDoc_STRVAR(ViewShape_name_doc,
|
|
"The name of the ViewShape.\n"
|
|
"\n"
|
|
":type: str");
|
|
|
|
static PyObject *ViewShape_name_get(BPy_ViewShape *self, void *UNUSED(closure))
|
|
{
|
|
return PyUnicode_FromString(self->vs->getName().c_str());
|
|
}
|
|
|
|
PyDoc_STRVAR(ViewShape_id_doc,
|
|
"The Id of this ViewShape.\n"
|
|
"\n"
|
|
":type: :class:`Id`");
|
|
|
|
static PyObject *ViewShape_id_get(BPy_ViewShape *self, void *UNUSED(closure))
|
|
{
|
|
Id id(self->vs->getId());
|
|
return BPy_Id_from_Id(id); // return a copy
|
|
}
|
|
|
|
static PyGetSetDef BPy_ViewShape_getseters[] = {
|
|
{(char *)"sshape", (getter)ViewShape_sshape_get, (setter)ViewShape_sshape_set, (char *)ViewShape_sshape_doc, NULL},
|
|
{(char *)"vertices", (getter)ViewShape_vertices_get, (setter)ViewShape_vertices_set, (char *)ViewShape_vertices_doc, NULL},
|
|
{(char *)"edges", (getter)ViewShape_edges_get, (setter)ViewShape_edges_set, (char *)ViewShape_edges_doc, NULL},
|
|
{(char *)"name", (getter)ViewShape_name_get, (setter)NULL, (char *)ViewShape_name_doc, NULL},
|
|
{(char *)"id", (getter)ViewShape_id_get, (setter)NULL, (char *)ViewShape_id_doc, NULL},
|
|
{NULL, NULL, NULL, NULL, NULL} /* Sentinel */
|
|
};
|
|
|
|
/*-----------------------BPy_ViewShape type definition ------------------------------*/
|
|
|
|
PyTypeObject ViewShape_Type = {
|
|
PyVarObject_HEAD_INIT(NULL, 0)
|
|
"ViewShape", /* tp_name */
|
|
sizeof(BPy_ViewShape), /* tp_basicsize */
|
|
0, /* tp_itemsize */
|
|
(destructor)ViewShape_dealloc, /* tp_dealloc */
|
|
0, /* tp_print */
|
|
0, /* tp_getattr */
|
|
0, /* tp_setattr */
|
|
0, /* tp_reserved */
|
|
(reprfunc)ViewShape_repr, /* 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 */
|
|
ViewShape_doc, /* tp_doc */
|
|
0, /* tp_traverse */
|
|
0, /* tp_clear */
|
|
0, /* tp_richcompare */
|
|
0, /* tp_weaklistoffset */
|
|
0, /* tp_iter */
|
|
0, /* tp_iternext */
|
|
BPy_ViewShape_methods, /* tp_methods */
|
|
0, /* tp_members */
|
|
BPy_ViewShape_getseters, /* tp_getset */
|
|
0, /* tp_base */
|
|
0, /* tp_dict */
|
|
0, /* tp_descr_get */
|
|
0, /* tp_descr_set */
|
|
0, /* tp_dictoffset */
|
|
(initproc)ViewShape_init, /* tp_init */
|
|
0, /* tp_alloc */
|
|
PyType_GenericNew, /* tp_new */
|
|
};
|
|
|
|
///////////////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|