Freestyle Python API improvements - part 3.

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

1 files changed, 62 insertions, 72 deletions

diff --git a/source/blender/freestyle/intern/python/BPy_ViewMap.cpp b/source/blender/freestyle/intern/python/BPy_ViewMap.cpp
index c9667103e5a..985e6408e1b 100644
--- a/source/blender/freestyle/intern/python/BPy_ViewMap.cpp
+++ b/source/blender/freestyle/intern/python/BPy_ViewMap.cpp
@@ -12,48 +12,48 @@ extern "C" {
 ///////////////////////////////////////////////////////////////////////////////////////////
 
 //-------------------MODULE INITIALIZATION--------------------------------
-int ViewMap_Init( PyObject *module )
+int ViewMap_Init(PyObject *module)
 {
-	if( module == NULL )
+	if (module == NULL)
 		return -1;
 
-	if( PyType_Ready( &ViewMap_Type ) < 0 )
+	if (PyType_Ready( &ViewMap_Type ) < 0)
 		return -1;
-
-	Py_INCREF( &ViewMap_Type );
+	Py_INCREF(&ViewMap_Type);
 	PyModule_AddObject(module, "ViewMap", (PyObject *)&ViewMap_Type);
+
 	return 0;
 }
 
-//------------------------INSTANCE METHODS ----------------------------------
+/*----------------------ViewMap methods----------------------------*/
 
-static char ViewMap___doc__[] =
+PyDoc_STRVAR(ViewMap_doc,
 "Class defining the ViewMap.\n"
 "\n"
 ".. method:: __init__()\n"
 "\n"
-"   Default constructor.\n";
+"   Default constructor.");
 
-static int ViewMap___init__(BPy_ViewMap *self, PyObject *args, PyObject *kwds)
+static int ViewMap_init(BPy_ViewMap *self, PyObject *args, PyObject *kwds)
 {
 	self->vm = new ViewMap();
-    return 0;
+	return 0;
 }
 
-static void ViewMap___dealloc__(BPy_ViewMap *self)
+static void ViewMap_dealloc(BPy_ViewMap *self)
 {
-	if( self->vm )
+	if (self->vm)
 		delete self->vm;
-    Py_TYPE(self)->tp_free((PyObject*)self);
+	Py_TYPE(self)->tp_free((PyObject*)self);
 }
 
-static PyObject * ViewMap___repr__(BPy_ViewMap *self)
+static PyObject * ViewMap_repr(BPy_ViewMap *self)
 {
-    return PyUnicode_FromFormat("ViewMap - address: %p", self->vm );
+	return PyUnicode_FromFormat("ViewMap - address: %p", self->vm);
 }
 
-static char ViewMap_getClosestViewEdge___doc__[] =
-".. method:: getClosestViewEdge(x, y)\n"
+PyDoc_STRVAR(ViewMap_get_closest_viewedge_doc,
+".. method:: get_closest_viewedge(x, y)\n"
 "\n"
 "   Gets the ViewEdge nearest to the 2D point specified as arguments.\n"
 "\n"
@@ -62,23 +62,22 @@ static char ViewMap_getClosestViewEdge___doc__[] =
 "   :arg y: Y coordinate of a 2D point.\n"
 "   :type y: float\n"
 "   :return: The ViewEdge nearest to the specified 2D point.\n"
-"   :rtype: :class:`ViewEdge`\n";
+"   :rtype: :class:`ViewEdge`");
 
-static PyObject * ViewMap_getClosestViewEdge( BPy_ViewMap *self , PyObject *args) {
+static PyObject * ViewMap_get_closest_viewedge(BPy_ViewMap *self , PyObject *args)
+{
 	double x, y;
 
-	if(!( PyArg_ParseTuple(args, "dd", &x, &y) ))
+	if (!PyArg_ParseTuple(args, "dd", &x, &y))
 		return NULL;
-
-	ViewEdge *ve = const_cast<ViewEdge *>( self->vm->getClosestViewEdge(x,y) );
-	if( ve )
+	ViewEdge *ve = const_cast<ViewEdge *>(self->vm->getClosestViewEdge(x,y));
+	if (ve)
 		return BPy_ViewEdge_from_ViewEdge(*ve);
-
 	Py_RETURN_NONE;
 }
 
-static char ViewMap_getClosestFEdge___doc__[] =
-".. method:: getClosestFEdge(x, y)\n"
+PyDoc_STRVAR(ViewMap_get_closest_fedge_doc,
+".. method:: get_closest_fedge(x, y)\n"
 "\n"
 "   Gets the FEdge nearest to the 2D point specified as arguments.\n"
 "\n"
@@ -87,62 +86,53 @@ static char ViewMap_getClosestFEdge___doc__[] =
 "   :arg y: Y coordinate of a 2D point.\n"
 "   :type y: float\n"
 "   :return: The FEdge nearest to the specified 2D point.\n"
-"   :rtype: :class:`FEdge`\n";
+"   :rtype: :class:`FEdge`");
 
-static PyObject * ViewMap_getClosestFEdge( BPy_ViewMap *self , PyObject *args) {
+static PyObject * ViewMap_get_closest_fedge(BPy_ViewMap *self , PyObject *args)
+{
 	double x, y;
 
-	if(!( PyArg_ParseTuple(args, "dd", &x, &y) ))
+	if (!PyArg_ParseTuple(args, "dd", &x, &y))
 		return NULL;
-
-	FEdge *fe = const_cast<FEdge *>( self->vm->getClosestFEdge(x,y) );
-	if( fe )
+	FEdge *fe = const_cast<FEdge *>(self->vm->getClosestFEdge(x,y));
+	if (fe)
 		return Any_BPy_FEdge_from_FEdge(*fe);
-
 	Py_RETURN_NONE;
 }
 
-static char ViewMap_getScene3dBBox___doc__[] =
-".. method:: getScene3dBBox()\n"
-"\n"
-"   Returns the scene 3D bounding box.\n"
-"\n"
-"   :return: The scene 3D bounding box.\n"
-"   :rtype: :class:`BBox`\n";
-
-static PyObject * ViewMap_getScene3dBBox( BPy_ViewMap *self , PyObject *args) {
-	BBox<Vec3r> bb( self->vm->getScene3dBBox() );
-	return BPy_BBox_from_BBox( bb );
-}
-
-static char ViewMap_setScene3dBBox___doc__[] =
-".. method:: setScene3dBBox(bbox)\n"
-"\n"
-"   Sets the scene 3D bounding box.\n"
-"\n"
-"   :arg bbox: The scene 3D bounding box.\n"
-"   :type bbox: :class:`BBox`\n";
+// static ViewMap *getInstance ();
 
-static PyObject * ViewMap_setScene3dBBox( BPy_ViewMap *self , PyObject *args) {
-	PyObject *py_bb = 0;
+static PyMethodDef BPy_ViewMap_methods[] = {
+	{"get_closest_viewedge", (PyCFunction)ViewMap_get_closest_viewedge, METH_VARARGS, ViewMap_get_closest_viewedge_doc},
+	{"get_closest_fedge", (PyCFunction)ViewMap_get_closest_fedge, METH_VARARGS, ViewMap_get_closest_fedge_doc},
+	{NULL, NULL, 0, NULL}
+};
 
-	if(!( PyArg_ParseTuple(args, "O!", &BBox_Type, &py_bb) ))
-		return NULL;
+/*----------------------ViewMap get/setters ----------------------------*/
 
-	self->vm->setScene3dBBox(*( ((BPy_BBox *) py_bb)->bb ));
+PyDoc_STRVAR(ViewMap_scene_bbox_doc,
+"The 3D bounding box of the scene.\n"
+"\n"
+":type: :class:`BBox`");
 
-	Py_RETURN_NONE;
+static PyObject *ViewMap_scene_bbox_get(BPy_ViewMap *self, void *UNUSED(closure))
+{
+	return BPy_BBox_from_BBox(self->vm->getScene3dBBox());
 }
 
-// static ViewMap *getInstance ();
+static int ViewMap_scene_bbox_set(BPy_ViewMap *self, PyObject *value, void *UNUSED(closure))
+{
+	if (!BPy_BBox_Check(value)) {
+		PyErr_SetString(PyExc_TypeError, "value must be a BBox");
+		return -1;
+	}
+	self->vm->setScene3dBBox(*(((BPy_BBox *)value)->bb));
+	return 0;
+}
 
-/*---------------------- BPy_ViewShape instance definitions ----------------------------*/
-static PyMethodDef BPy_ViewMap_methods[] = {
-	{"getClosestViewEdge", ( PyCFunction ) ViewMap_getClosestViewEdge, METH_VARARGS, ViewMap_getClosestViewEdge___doc__},
-	{"getClosestFEdge", ( PyCFunction ) ViewMap_getClosestFEdge, METH_VARARGS, ViewMap_getClosestFEdge___doc__},
-	{"getScene3dBBox", ( PyCFunction ) ViewMap_getScene3dBBox, METH_NOARGS, ViewMap_getScene3dBBox___doc__},
-	{"setScene3dBBox", ( PyCFunction ) ViewMap_setScene3dBBox, METH_VARARGS, ViewMap_setScene3dBBox___doc__},
-	{NULL, NULL, 0, NULL}
+static PyGetSetDef BPy_ViewMap_getseters[] = {
+	{(char *)"scene_bbox", (getter)ViewMap_scene_bbox_get, (setter)ViewMap_scene_bbox_set, (char *)ViewMap_scene_bbox_doc, NULL},
+	{NULL, NULL, NULL, NULL, NULL}  /* Sentinel */
 };
 
 /*-----------------------BPy_ViewMap type definition ------------------------------*/
@@ -152,12 +142,12 @@ PyTypeObject ViewMap_Type = {
 	"ViewMap",                      /* tp_name */
 	sizeof(BPy_ViewMap),            /* tp_basicsize */
 	0,                              /* tp_itemsize */
-	(destructor)ViewMap___dealloc__, /* tp_dealloc */
+	(destructor)ViewMap_dealloc,    /* tp_dealloc */
 	0,                              /* tp_print */
 	0,                              /* tp_getattr */
 	0,                              /* tp_setattr */
 	0,                              /* tp_reserved */
-	(reprfunc)ViewMap___repr__,     /* tp_repr */
+	(reprfunc)ViewMap_repr,         /* tp_repr */
 	0,                              /* tp_as_number */
 	0,                              /* tp_as_sequence */
 	0,                              /* tp_as_mapping */
@@ -168,7 +158,7 @@ PyTypeObject ViewMap_Type = {
 	0,                              /* tp_setattro */
 	0,                              /* tp_as_buffer */
 	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
-	ViewMap___doc__,                /* tp_doc */
+	ViewMap_doc,                    /* tp_doc */
 	0,                              /* tp_traverse */
 	0,                              /* tp_clear */
 	0,                              /* tp_richcompare */
@@ -177,13 +167,13 @@ PyTypeObject ViewMap_Type = {
 	0,                              /* tp_iternext */
 	BPy_ViewMap_methods,            /* tp_methods */
 	0,                              /* tp_members */
-	0,                              /* tp_getset */
+	BPy_ViewMap_getseters,          /* tp_getset */
 	0,                              /* tp_base */
 	0,                              /* tp_dict */
 	0,                              /* tp_descr_get */
 	0,                              /* tp_descr_set */
 	0,                              /* tp_dictoffset */
-	(initproc)ViewMap___init__,     /* tp_init */
+	(initproc)ViewMap_init,         /* tp_init */
 	0,                              /* tp_alloc */
 	PyType_GenericNew,              /* tp_new */
 };