griefith/test2
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Freestyle Python API improvements - part 3.

Browse Source 
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
This commit is contained in:
Tamito Kajiyama
2013-02-14 23:48:34 +00:00
parent 9e3bf44011
commit 731d08d497
27 changed files with 3149 additions and 3551 deletions
Download Patch File Download Diff File Expand all files Collapse all files

368
source/blender/freestyle/intern/python/BPy_Interface0D.cpp
View File

@@ -17,215 +17,84 @@ extern "C" {
///////////////////////////////////////////////////////////////////////////////////////////
//-------------------MODULE INITIALIZATION--------------------------------
int Interface0D_Init( PyObject *module )
int Interface0D_Init(PyObject *module)
{
if( module == NULL )
if (module == NULL)
return -1;
if( PyType_Ready( &Interface0D_Type ) < 0 )
if (PyType_Ready(&Interface0D_Type) < 0)
return -1;
Py_INCREF( &Interface0D_Type );
Py_INCREF(&Interface0D_Type);
PyModule_AddObject(module, "Interface0D", (PyObject *)&Interface0D_Type);
if( PyType_Ready( &CurvePoint_Type ) < 0 )
if (PyType_Ready(&CurvePoint_Type) < 0)
return -1;
Py_INCREF( &CurvePoint_Type );
Py_INCREF(&CurvePoint_Type);
PyModule_AddObject(module, "CurvePoint", (PyObject *)&CurvePoint_Type);
if( PyType_Ready( &SVertex_Type ) < 0 )
if (PyType_Ready(&SVertex_Type) < 0)
return -1;
Py_INCREF( &SVertex_Type );
Py_INCREF(&SVertex_Type);
PyModule_AddObject(module, "SVertex", (PyObject *)&SVertex_Type);
if( PyType_Ready( &ViewVertex_Type ) < 0 )
if (PyType_Ready(&ViewVertex_Type) < 0)
return -1;
Py_INCREF( &ViewVertex_Type );
Py_INCREF(&ViewVertex_Type);
PyModule_AddObject(module, "ViewVertex", (PyObject *)&ViewVertex_Type);
if( PyType_Ready( &StrokeVertex_Type ) < 0 )
if (PyType_Ready(&StrokeVertex_Type) < 0)
return -1;
Py_INCREF( &StrokeVertex_Type );
Py_INCREF(&StrokeVertex_Type);
PyModule_AddObject(module, "StrokeVertex", (PyObject *)&StrokeVertex_Type);
if( PyType_Ready( &NonTVertex_Type ) < 0 )
if (PyType_Ready(&NonTVertex_Type) < 0)
return -1;
Py_INCREF( &NonTVertex_Type );
Py_INCREF(&NonTVertex_Type);
PyModule_AddObject(module, "NonTVertex", (PyObject *)&NonTVertex_Type);
if( PyType_Ready( &TVertex_Type ) < 0 )
if (PyType_Ready(&TVertex_Type) < 0)
return -1;
Py_INCREF( &TVertex_Type );
Py_INCREF(&TVertex_Type);
PyModule_AddObject(module, "TVertex", (PyObject *)&TVertex_Type);
SVertex_mathutils_register_callback();
StrokeVertex_mathutils_register_callback();
return 0;
}
//------------------------INSTANCE METHODS ----------------------------------
/*----------------------Interface1D methods ----------------------------*/
static char Interface0D___doc__[] =
PyDoc_STRVAR(Interface0D_doc,
"Base class for any 0D element.\n"
"\n"
".. method:: __init__()\n"
"\n"
" Default constructor.\n";
" Default constructor.");
static int Interface0D___init__(BPy_Interface0D *self, PyObject *args, PyObject *kwds)
static int Interface0D_init(BPy_Interface0D *self, PyObject *args, PyObject *kwds)
{
if ( !PyArg_ParseTuple(args, "") )
return -1;
if (!PyArg_ParseTuple(args, ""))
return -1;
self->if0D = new Interface0D();
self->borrowed = 0;
return 0;
}
static void Interface0D___dealloc__(BPy_Interface0D* self)
static void Interface0D_dealloc(BPy_Interface0D* self)
{
if( self->if0D && !self->borrowed )
if (self->if0D && !self->borrowed)
delete self->if0D;
Py_TYPE(self)->tp_free((PyObject*)self);
Py_TYPE(self)->tp_free((PyObject*)self);
}
static PyObject * Interface0D___repr__(BPy_Interface0D* self)
static PyObject * Interface0D_repr(BPy_Interface0D* self)
{
return PyUnicode_FromFormat("type: %s - address: %p", self->if0D->getExactTypeName().c_str(), self->if0D );
return PyUnicode_FromFormat("type: %s - address: %p", self->if0D->getExactTypeName().c_str(), self->if0D);
}
static char Interface0D_getExactTypeName___doc__[] =
".. method:: getExactTypeName()\n"
"\n"
" Returns the name of the 0D element.\n"
"\n"
" :return: Name of the interface.\n"
" :rtype: str\n";
static PyObject *Interface0D_getExactTypeName( BPy_Interface0D *self ) {
return PyUnicode_FromString( self->if0D->getExactTypeName().c_str() );
}
static char Interface0D_getX___doc__[] =
".. method:: getX()\n"
"\n"
" Returns the X coordinate of the 3D point of the 0D element.\n"
"\n"
" :return: The X coordinate of the 3D point.\n"
" :rtype: float\n";
static PyObject *Interface0D_getX( BPy_Interface0D *self ) {
double x = self->if0D->getX();
if (PyErr_Occurred())
return NULL;
return PyFloat_FromDouble( x );
}
static char Interface0D_getY___doc__[] =
".. method:: getY()\n"
"\n"
" Returns the Y coordinate of the 3D point of the 0D element.\n"
"\n"
" :return: The Y coordinate of the 3D point.\n"
" :rtype: float\n";
static PyObject *Interface0D_getY( BPy_Interface0D *self ) {
double y = self->if0D->getY();
if (PyErr_Occurred())
return NULL;
return PyFloat_FromDouble( y );
}
static char Interface0D_getZ___doc__[] =
".. method:: getZ()\n"
"\n"
" Returns the Z coordinate of the 3D point of the 0D element.\n"
"\n"
" :return: The Z coordinate of the 3D point.\n"
" :rtype: float\n";
static PyObject *Interface0D_getZ( BPy_Interface0D *self ) {
double z = self->if0D->getZ();
if (PyErr_Occurred())
return NULL;
return PyFloat_FromDouble( z );
}
static char Interface0D_getPoint3D___doc__[] =
".. method:: getPoint3D()\n"
"\n"
" Returns the location of the 0D element in the 3D space.\n"
"\n"
" :return: The 3D point of the 0D element.\n"
" :rtype: :class:`mathutils.Vector`\n";
static PyObject *Interface0D_getPoint3D( BPy_Interface0D *self ) {
Vec3f v( self->if0D->getPoint3D() );
if (PyErr_Occurred())
return NULL;
return Vector_from_Vec3f( v );
}
static char Interface0D_getProjectedX___doc__[] =
".. method:: getProjectedX()\n"
"\n"
" Returns the X coordinate of the 2D point of the 0D element.\n"
"\n"
" :return: The X coordinate of the 2D point.\n"
" :rtype: float\n";
static PyObject *Interface0D_getProjectedX( BPy_Interface0D *self ) {
double x = self->if0D->getProjectedX();
if (PyErr_Occurred())
return NULL;
return PyFloat_FromDouble( x );
}
static char Interface0D_getProjectedY___doc__[] =
".. method:: getProjectedY()\n"
"\n"
" Returns the Y coordinate of the 2D point of the 0D element.\n"
"\n"
" :return: The Y coordinate of the 2D point.\n"
" :rtype: float\n";
static PyObject *Interface0D_getProjectedY( BPy_Interface0D *self ) {
double y = self->if0D->getProjectedY();
if (PyErr_Occurred())
return NULL;
return PyFloat_FromDouble( y );
}
static char Interface0D_getProjectedZ___doc__[] =
".. method:: getProjectedZ()\n"
"\n"
" Returns the Z coordinate of the 2D point of the 0D element.\n"
"\n"
" :return: The Z coordinate of the 2D point.\n"
" :rtype: float\n";
static PyObject *Interface0D_getProjectedZ( BPy_Interface0D *self ) {
double z = self->if0D->getProjectedZ();
if (PyErr_Occurred())
return NULL;
return PyFloat_FromDouble( z );
}
static char Interface0D_getPoint2D___doc__[] =
".. method:: getPoint2D()\n"
"\n"
" Returns the location of the 0D element in the 2D space.\n"
"\n"
" :return: The 2D point of the 0D element.\n"
" :rtype: :class:`mathutils.Vector`\n";
static PyObject *Interface0D_getPoint2D( BPy_Interface0D *self ) {
Vec2f v( self->if0D->getPoint2D() );
if (PyErr_Occurred())
return NULL;
return Vector_from_Vec2f( v );
}
static char Interface0D_getFEdge___doc__[] =
".. method:: getFEdge(inter)\n"
PyDoc_STRVAR(Interface0D_get_fedge_doc,
".. method:: get_fedge(inter)\n"
"\n"
" Returns the FEdge that lies between this 0D element and the 0D\n"
" element given as the argument.\n"
@@ -233,68 +102,140 @@ static char Interface0D_getFEdge___doc__[] =
" :arg inter: A 0D element.\n"
" :type inter: :class:`Interface0D`\n"
" :return: The FEdge lying between the two 0D elements.\n"
" :rtype: :class:`FEdge`\n";
" :rtype: :class:`FEdge`");
static PyObject *Interface0D_getFEdge( BPy_Interface0D *self, PyObject *args ) {
static PyObject *Interface0D_get_fedge(BPy_Interface0D *self, PyObject *args)
{
PyObject *py_if0D;
if(!( PyArg_ParseTuple(args, "O!", &Interface0D_Type, &py_if0D) ))
if (!PyArg_ParseTuple(args, "O!", &Interface0D_Type, &py_if0D))
return NULL;
FEdge *fe = self->if0D->getFEdge(*( ((BPy_Interface0D *) py_if0D)->if0D ));
FEdge *fe = self->if0D->getFEdge(*(((BPy_Interface0D *)py_if0D)->if0D));
if (PyErr_Occurred())
return NULL;
if( fe )
return Any_BPy_FEdge_from_FEdge( *fe );
if (fe)
return Any_BPy_FEdge_from_FEdge(*fe);
Py_RETURN_NONE;
}
static char Interface0D_getId___doc__[] =
".. method:: getId()\n"
"\n"
" Returns the identifier of the 0D element.\n"
"\n"
" :return: The identifier of the 0D element.\n"
" :rtype: :class:`Id`\n";
static PyMethodDef BPy_Interface0D_methods[] = {
{"get_fedge", (PyCFunction)Interface0D_get_fedge, METH_VARARGS, Interface0D_get_fedge_doc},
{NULL, NULL, 0, NULL}
};
static PyObject *Interface0D_getId( BPy_Interface0D *self ) {
Id id( self->if0D->getId() );
if (PyErr_Occurred())
return NULL;
return BPy_Id_from_Id( id );
/*----------------------Interface1D get/setters ----------------------------*/
PyDoc_STRVAR(Interface0D_exact_type_name_doc,
"The string of the the name of this 0D element.\n"
"\n"
":type: str");
static PyObject *Interface0D_exact_type_name_get(BPy_Interface0D *self, void *UNUSED(closure))
{
return PyUnicode_FromString(self->if0D->getExactTypeName().c_str());
}
static char Interface0D_getNature___doc__[] =
".. method:: getNature()\n"
PyDoc_STRVAR(Interface0D_point_3d_doc,
"The 3D point of this 0D element.\n"
"\n"
" Returns the nature of the 0D element.\n"
"\n"
" :return: The nature of the 0D element.\n"
" :rtype: :class:`Nature`\n";
":type: mathutils.Vector");
static PyObject *Interface0D_getNature( BPy_Interface0D *self ) {
static PyObject *Interface0D_point_3d_get(BPy_Interface0D *self, void *UNUSED(closure))
{
Vec3f p(self->if0D->getPoint3D());
if (PyErr_Occurred())
return NULL;
return Vector_from_Vec3f(p);
}
PyDoc_STRVAR(Interface0D_projected_x_doc,
"The X coordinate of the projected 3D point of this 0D element.\n"
"\n"
":type: float");
static PyObject *Interface0D_projected_x_get(BPy_Interface0D *self, void *UNUSED(closure))
{
real x = self->if0D->getProjectedX();
if (PyErr_Occurred())
return NULL;
return PyFloat_FromDouble(x);
}
PyDoc_STRVAR(Interface0D_projected_y_doc,
"The Y coordinate of the projected 3D point of this 0D element.\n"
"\n"
":type: float");
static PyObject *Interface0D_projected_y_get(BPy_Interface0D *self, void *UNUSED(closure))
{
real y = self->if0D->getProjectedY();
if (PyErr_Occurred())
return NULL;
return PyFloat_FromDouble(y);
}
PyDoc_STRVAR(Interface0D_projected_z_doc,
"The Z coordinate of the projected 3D point of this 0D element.\n"
"\n"
":type: float");
static PyObject *Interface0D_projected_z_get(BPy_Interface0D *self, void *UNUSED(closure))
{
real z = self->if0D->getProjectedZ();
if (PyErr_Occurred())
return NULL;
return PyFloat_FromDouble(z);
}
PyDoc_STRVAR(Interface0D_point_2d_doc,
"The 2D point of this 0D element.\n"
"\n"
":type: mathutils.Vector");
static PyObject *Interface0D_point_2d_get(BPy_Interface0D *self, void *UNUSED(closure))
{
Vec2f p(self->if0D->getPoint2D());
if (PyErr_Occurred())
return NULL;
return Vector_from_Vec2f(p);
}
PyDoc_STRVAR(Interface0D_id_doc,
"The Id of this 0D element.\n"
"\n"
":type: :class:`Id`");
static PyObject *Interface0D_id_get(BPy_Interface0D *self, void *UNUSED(closure))
{
Id id(self->if0D->getId());
if (PyErr_Occurred())
return NULL;
return BPy_Id_from_Id(id); // return a copy
}
PyDoc_STRVAR(Interface0D_nature_doc,
"The nature of this 0D element.\n"
"\n"
":type: :class:`Nature`");
static PyObject *Interface0D_nature_get(BPy_Interface0D *self, void *UNUSED(closure))
{
Nature::VertexNature nature = self->if0D->getNature();
if (PyErr_Occurred())
return NULL;
return BPy_Nature_from_Nature( nature );
return BPy_Nature_from_Nature(nature);
}
/*----------------------Interface0D instance definitions ----------------------------*/
static PyMethodDef BPy_Interface0D_methods[] = {
{"getExactTypeName", ( PyCFunction ) Interface0D_getExactTypeName, METH_NOARGS, Interface0D_getExactTypeName___doc__},
{"getX", ( PyCFunction ) Interface0D_getX, METH_NOARGS, Interface0D_getX___doc__},
{"getY", ( PyCFunction ) Interface0D_getY, METH_NOARGS, Interface0D_getY___doc__},
{"getZ", ( PyCFunction ) Interface0D_getZ, METH_NOARGS, Interface0D_getZ___doc__},
{"getPoint3D", ( PyCFunction ) Interface0D_getPoint3D, METH_NOARGS, Interface0D_getPoint3D___doc__},
{"getProjectedX", ( PyCFunction ) Interface0D_getProjectedX, METH_NOARGS, Interface0D_getProjectedX___doc__},
{"getProjectedY", ( PyCFunction ) Interface0D_getProjectedY, METH_NOARGS, Interface0D_getProjectedY___doc__},
{"getProjectedZ", ( PyCFunction ) Interface0D_getProjectedZ, METH_NOARGS, Interface0D_getProjectedZ___doc__},
{"getPoint2D", ( PyCFunction ) Interface0D_getPoint2D, METH_NOARGS, Interface0D_getPoint2D___doc__},
{"getFEdge", ( PyCFunction ) Interface0D_getFEdge, METH_VARARGS, Interface0D_getFEdge___doc__},
{"getId", ( PyCFunction ) Interface0D_getId, METH_NOARGS, Interface0D_getId___doc__},
{"getNature", ( PyCFunction ) Interface0D_getNature, METH_NOARGS, Interface0D_getNature___doc__},
{NULL, NULL, 0, NULL}
static PyGetSetDef BPy_Interface0D_getseters[] = {
{(char *)"exact_type_name", (getter)Interface0D_exact_type_name_get, (setter)NULL, (char *)Interface0D_exact_type_name_doc, NULL},
{(char *)"point_3d", (getter)Interface0D_point_3d_get, (setter)NULL, (char *)Interface0D_point_3d_doc, NULL},
{(char *)"projected_x", (getter)Interface0D_projected_x_get, (setter)NULL, (char *)Interface0D_projected_x_doc, NULL},
{(char *)"projected_y", (getter)Interface0D_projected_y_get, (setter)NULL, (char *)Interface0D_projected_y_doc, NULL},
{(char *)"projected_z", (getter)Interface0D_projected_z_get, (setter)NULL, (char *)Interface0D_projected_z_doc, NULL},
{(char *)"point_2d", (getter)Interface0D_point_2d_get, (setter)NULL, (char *)Interface0D_point_2d_doc, NULL},
{(char *)"id", (getter)Interface0D_id_get, (setter)NULL, (char *)Interface0D_id_doc, NULL},
{(char *)"nature", (getter)Interface0D_nature_get, (setter)NULL, (char *)Interface0D_nature_doc, NULL},
{NULL, NULL, NULL, NULL, NULL} /* Sentinel */
};
/*-----------------------BPy_Interface0D type definition ------------------------------*/
@@ -304,12 +245,12 @@ PyTypeObject Interface0D_Type = {
"Interface0D", /* tp_name */
sizeof(BPy_Interface0D), /* tp_basicsize */
0, /* tp_itemsize */
(destructor)Interface0D___dealloc__, /* tp_dealloc */
(destructor)Interface0D_dealloc, /* tp_dealloc */
0, /* tp_print */
0, /* tp_getattr */
0, /* tp_setattr */
0, /* tp_reserved */
(reprfunc)Interface0D___repr__, /* tp_repr */
(reprfunc)Interface0D_repr, /* tp_repr */
0, /* tp_as_number */
0, /* tp_as_sequence */
0, /* tp_as_mapping */
@@ -320,7 +261,7 @@ PyTypeObject Interface0D_Type = {
0, /* tp_setattro */
0, /* tp_as_buffer */
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Interface0D___doc__, /* tp_doc */
Interface0D_doc, /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */
@@ -329,23 +270,15 @@ PyTypeObject Interface0D_Type = {
0, /* tp_iternext */
BPy_Interface0D_methods, /* tp_methods */
0, /* tp_members */
0, /* tp_getset */
BPy_Interface0D_getseters, /* tp_getset */
0, /* tp_base */
0, /* tp_dict */
0, /* tp_descr_get */
0, /* tp_descr_set */
0, /* tp_dictoffset */
(initproc)Interface0D___init__, /* tp_init */
(initproc)Interface0D_init, /* tp_init */
0, /* tp_alloc */
PyType_GenericNew, /* tp_new */
0, /* tp_free */
0, /* tp_is_gc */
0, /* tp_bases */
0, /* tp_mro */
0, /* tp_cache */
0, /* tp_subclasses */
0, /* tp_weaklist */
0 /* tp_del */
};
///////////////////////////////////////////////////////////////////////////////////////////
@@ -353,4 +286,3 @@ PyTypeObject Interface0D_Type = {
#ifdef __cplusplus
}
#endif