Major documentation updates. The original Freestyle API reference
(http://freestyle.sourceforge.net/doc/html/index.html) has been incorporated into the Blender/Freestyle Python API implementation in the form of Sphinx-based embedded docstrings. Some C++-specific descriptions of classes and functions were revised so that they are suitable for Python programmers. Missing docstrings were filled, and sparse descriptions were extended. By means of the new documentation system for Blender, an up-to-date Freestyle Python API reference will be part of the Blender 2.5 documentation.
This commit is contained in:
Tamito Kajiyama
@@ -8,23 +8,167 @@ extern "C" {
|
||||
|
||||
///////////////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/*--------------- Python API function prototypes for Id instance -----------*/
|
||||
static int Id___init__(BPy_Id *self, PyObject *args, PyObject *kwds);
|
||||
static void Id___dealloc__(BPy_Id *self);
|
||||
static PyObject * Id___repr__(BPy_Id* self);
|
||||
static PyObject * Id_RichCompare(BPy_Id *o1, BPy_Id *o2, int opid);
|
||||
//-------------------MODULE INITIALIZATION--------------------------------
|
||||
int Id_Init( PyObject *module )
|
||||
{
|
||||
if( module == NULL )
|
||||
return -1;
|
||||
|
||||
static PyObject * Id_getFirst( BPy_Id *self );
|
||||
static PyObject * Id_getSecond( BPy_Id *self);
|
||||
static PyObject * Id_setFirst( BPy_Id *self , PyObject *args);
|
||||
static PyObject * Id_setSecond( BPy_Id *self , PyObject *args);
|
||||
if( PyType_Ready( &Id_Type ) < 0 )
|
||||
return -1;
|
||||
|
||||
Py_INCREF( &Id_Type );
|
||||
PyModule_AddObject(module, "Id", (PyObject *)&Id_Type);
|
||||
return 0;
|
||||
}
|
||||
|
||||
//------------------------INSTANCE METHODS ----------------------------------
|
||||
|
||||
static char Id___doc__[] =
|
||||
".. method:: __init__()\n"
|
||||
"\n"
|
||||
" Default constructor.\n"
|
||||
"\n"
|
||||
".. method:: __init__(iBrother)\n"
|
||||
"\n"
|
||||
" Copy constructor.\n"
|
||||
"\n"
|
||||
" :arg iBrother: An Id object.\n"
|
||||
" :type iBrother: :class:`Id`\n"
|
||||
"\n"
|
||||
".. method:: __init__(iFirst)\n"
|
||||
"\n"
|
||||
" Builds an Id from an integer. The second number is set to 0.\n"
|
||||
"\n"
|
||||
" :arg iFirst: The first Id number.\n"
|
||||
" :type iFirst: int\n"
|
||||
"\n"
|
||||
".. method:: __init__(iFirst, iSecond)\n"
|
||||
"\n"
|
||||
" Builds the Id from the two numbers.\n"
|
||||
"\n"
|
||||
" :arg iFirst: The first Id number.\n"
|
||||
" :type iFirst: int\n"
|
||||
" :arg iSecond: The second Id number.\n"
|
||||
" :type iSecond: int\n";
|
||||
|
||||
static int Id___init__(BPy_Id *self, PyObject *args, PyObject *kwds)
|
||||
{
|
||||
int first = 0, second = 0;
|
||||
static char *kwlist[] = {"first", "second", NULL};
|
||||
|
||||
if (! PyArg_ParseTupleAndKeywords(args, kwds, "|ii", kwlist, &first, &second) )
|
||||
return -1;
|
||||
|
||||
self->id = new Id( first, second );
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
static void Id___dealloc__(BPy_Id* self)
|
||||
{
|
||||
delete self->id;
|
||||
Py_TYPE(self)->tp_free((PyObject*)self);
|
||||
}
|
||||
|
||||
static PyObject * Id___repr__(BPy_Id* self)
|
||||
{
|
||||
return PyUnicode_FromFormat("[ first: %i, second: %i ](BPy_Id)", self->id->getFirst(), self->id->getSecond() );
|
||||
}
|
||||
|
||||
static char Id_getFirst___doc__[] =
|
||||
".. method:: getFirst()\n"
|
||||
"\n"
|
||||
" Returns the first Id number.\n"
|
||||
"\n"
|
||||
" :return: The first Id number.\n"
|
||||
" :rtype: int\n";
|
||||
|
||||
static PyObject *Id_getFirst( BPy_Id *self ) {
|
||||
return PyLong_FromLong( self->id->getFirst() );
|
||||
}
|
||||
|
||||
static char Id_getSecond___doc__[] =
|
||||
".. method:: getSecond()\n"
|
||||
"\n"
|
||||
" Returns the second Id number.\n"
|
||||
"\n"
|
||||
" :return: The second Id number.\n"
|
||||
" :rtype: int\n";
|
||||
|
||||
static PyObject *Id_getSecond( BPy_Id *self) {
|
||||
return PyLong_FromLong( self->id->getSecond() );
|
||||
}
|
||||
|
||||
static char Id_setFirst___doc__[] =
|
||||
".. method:: setFirst(iFirst)\n"
|
||||
"\n"
|
||||
" Sets the first number constituting the Id.\n"
|
||||
"\n"
|
||||
" :arg iFirst: The first number constituting the Id.\n"
|
||||
" :type iFirst: int\n";
|
||||
|
||||
static PyObject *Id_setFirst( BPy_Id *self , PyObject *args) {
|
||||
unsigned int i;
|
||||
|
||||
if( !PyArg_ParseTuple(args, "i", &i) )
|
||||
return NULL;
|
||||
|
||||
self->id->setFirst( i );
|
||||
|
||||
Py_RETURN_NONE;
|
||||
}
|
||||
|
||||
static char Id_setSecond___doc__[] =
|
||||
".. method:: setSecond(iSecond)\n"
|
||||
"\n"
|
||||
" Sets the second number constituting the Id.\n"
|
||||
"\n"
|
||||
" :arg iSecond: The second number constituting the Id.\n"
|
||||
" :type iSecond: int\n";
|
||||
|
||||
static PyObject *Id_setSecond( BPy_Id *self , PyObject *args) {
|
||||
unsigned int i;
|
||||
|
||||
if( !PyArg_ParseTuple(args, "i", &i) )
|
||||
return NULL;
|
||||
|
||||
self->id->setSecond( i );
|
||||
|
||||
Py_RETURN_NONE;
|
||||
}
|
||||
|
||||
static PyObject * Id_RichCompare(BPy_Id *o1, BPy_Id *o2, int opid) {
|
||||
switch(opid){
|
||||
case Py_LT:
|
||||
return PyBool_from_bool( o1->id->operator<(*(o2->id)) );
|
||||
break;
|
||||
case Py_LE:
|
||||
return PyBool_from_bool( o1->id->operator<(*(o2->id)) || o1->id->operator<(*(o2->id)) );
|
||||
break;
|
||||
case Py_EQ:
|
||||
return PyBool_from_bool( o1->id->operator==(*(o2->id)) );
|
||||
break;
|
||||
case Py_NE:
|
||||
return PyBool_from_bool( o1->id->operator!=(*(o2->id)) );
|
||||
break;
|
||||
case Py_GT:
|
||||
return PyBool_from_bool(!( o1->id->operator<(*(o2->id)) || o1->id->operator<(*(o2->id)) ));
|
||||
break;
|
||||
case Py_GE:
|
||||
return PyBool_from_bool(!( o1->id->operator<(*(o2->id)) ));
|
||||
break;
|
||||
}
|
||||
|
||||
Py_RETURN_NONE;
|
||||
}
|
||||
|
||||
/*----------------------Id instance definitions ----------------------------*/
|
||||
static PyMethodDef BPy_Id_methods[] = {
|
||||
{"getFirst", ( PyCFunction ) Id_getFirst, METH_NOARGS, "Returns the first Id number"},
|
||||
{"getSecond", ( PyCFunction ) Id_getSecond, METH_NOARGS, "Returns the second Id number" },
|
||||
{"setFirst", ( PyCFunction ) Id_setFirst, METH_VARARGS, "Sets the first number constituing the Id" },
|
||||
{"setSecond", ( PyCFunction ) Id_setSecond, METH_VARARGS, "Sets the second number constituing the Id" },
|
||||
{"getFirst", ( PyCFunction ) Id_getFirst, METH_NOARGS, Id_getFirst___doc__},
|
||||
{"getSecond", ( PyCFunction ) Id_getSecond, METH_NOARGS, Id_getSecond___doc__},
|
||||
{"setFirst", ( PyCFunction ) Id_setFirst, METH_VARARGS, Id_setFirst___doc__},
|
||||
{"setSecond", ( PyCFunction ) Id_setSecond, METH_VARARGS, Id_setSecond___doc__},
|
||||
{NULL, NULL, 0, NULL}
|
||||
};
|
||||
|
||||
@@ -51,7 +195,7 @@ PyTypeObject Id_Type = {
|
||||
0, /* tp_setattro */
|
||||
0, /* tp_as_buffer */
|
||||
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
|
||||
"Id objects", /* tp_doc */
|
||||
Id___doc__, /* tp_doc */
|
||||
0, /* tp_traverse */
|
||||
0, /* tp_clear */
|
||||
(richcmpfunc)Id_RichCompare, /* tp_richcompare */
|
||||
@@ -71,105 +215,6 @@ PyTypeObject Id_Type = {
|
||||
PyType_GenericNew, /* tp_new */
|
||||
};
|
||||
|
||||
//-------------------MODULE INITIALIZATION--------------------------------
|
||||
int Id_Init( PyObject *module )
|
||||
{
|
||||
if( module == NULL )
|
||||
return -1;
|
||||
|
||||
if( PyType_Ready( &Id_Type ) < 0 )
|
||||
return -1;
|
||||
|
||||
Py_INCREF( &Id_Type );
|
||||
PyModule_AddObject(module, "Id", (PyObject *)&Id_Type);
|
||||
return 0;
|
||||
}
|
||||
|
||||
//------------------------INSTANCE METHODS ----------------------------------
|
||||
|
||||
int Id___init__(BPy_Id *self, PyObject *args, PyObject *kwds)
|
||||
{
|
||||
int first = 0, second = 0;
|
||||
static char *kwlist[] = {"first", "second", NULL};
|
||||
|
||||
if (! PyArg_ParseTupleAndKeywords(args, kwds, "|ii", kwlist, &first, &second) )
|
||||
return -1;
|
||||
|
||||
self->id = new Id( first, second );
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
void Id___dealloc__(BPy_Id* self)
|
||||
{
|
||||
delete self->id;
|
||||
Py_TYPE(self)->tp_free((PyObject*)self);
|
||||
}
|
||||
|
||||
PyObject * Id___repr__(BPy_Id* self)
|
||||
{
|
||||
return PyUnicode_FromFormat("[ first: %i, second: %i ](BPy_Id)", self->id->getFirst(), self->id->getSecond() );
|
||||
}
|
||||
|
||||
PyObject *Id_getFirst( BPy_Id *self ) {
|
||||
return PyLong_FromLong( self->id->getFirst() );
|
||||
}
|
||||
|
||||
|
||||
PyObject *Id_getSecond( BPy_Id *self) {
|
||||
return PyLong_FromLong( self->id->getSecond() );
|
||||
}
|
||||
|
||||
|
||||
PyObject *Id_setFirst( BPy_Id *self , PyObject *args) {
|
||||
unsigned int i;
|
||||
|
||||
if( !PyArg_ParseTuple(args, "i", &i) )
|
||||
return NULL;
|
||||
|
||||
self->id->setFirst( i );
|
||||
|
||||
Py_RETURN_NONE;
|
||||
}
|
||||
|
||||
|
||||
PyObject *Id_setSecond( BPy_Id *self , PyObject *args) {
|
||||
unsigned int i;
|
||||
|
||||
if( !PyArg_ParseTuple(args, "i", &i) )
|
||||
return NULL;
|
||||
|
||||
self->id->setSecond( i );
|
||||
|
||||
Py_RETURN_NONE;
|
||||
}
|
||||
|
||||
PyObject * Id_RichCompare(BPy_Id *o1, BPy_Id *o2, int opid) {
|
||||
switch(opid){
|
||||
case Py_LT:
|
||||
return PyBool_from_bool( o1->id->operator<(*(o2->id)) );
|
||||
break;
|
||||
case Py_LE:
|
||||
return PyBool_from_bool( o1->id->operator<(*(o2->id)) || o1->id->operator<(*(o2->id)) );
|
||||
break;
|
||||
case Py_EQ:
|
||||
return PyBool_from_bool( o1->id->operator==(*(o2->id)) );
|
||||
break;
|
||||
case Py_NE:
|
||||
return PyBool_from_bool( o1->id->operator!=(*(o2->id)) );
|
||||
break;
|
||||
case Py_GT:
|
||||
return PyBool_from_bool(!( o1->id->operator<(*(o2->id)) || o1->id->operator<(*(o2->id)) ));
|
||||
break;
|
||||
case Py_GE:
|
||||
return PyBool_from_bool(!( o1->id->operator<(*(o2->id)) ));
|
||||
break;
|
||||
}
|
||||
|
||||
Py_RETURN_NONE;
|
||||
}
|
||||
|
||||
|
||||
///////////////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
#ifdef __cplusplus
|
||||
|
||||
Reference in New Issue
Block a user