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
@@ -11,17 +11,99 @@ extern "C" {
|
||||
|
||||
///////////////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/*--------------- Python API function prototypes for UnaryFunction0DUnsigned instance -----------*/
|
||||
static int UnaryFunction0DUnsigned___init__(BPy_UnaryFunction0DUnsigned* self, PyObject *args, PyObject *kwds);
|
||||
static void UnaryFunction0DUnsigned___dealloc__(BPy_UnaryFunction0DUnsigned* self);
|
||||
static PyObject * UnaryFunction0DUnsigned___repr__(BPy_UnaryFunction0DUnsigned* self);
|
||||
//-------------------MODULE INITIALIZATION--------------------------------
|
||||
|
||||
static PyObject * UnaryFunction0DUnsigned_getName( BPy_UnaryFunction0DUnsigned *self);
|
||||
static PyObject * UnaryFunction0DUnsigned___call__( BPy_UnaryFunction0DUnsigned *self, PyObject *args, PyObject *kwds);
|
||||
int UnaryFunction0DUnsigned_Init( PyObject *module ) {
|
||||
|
||||
if( module == NULL )
|
||||
return -1;
|
||||
|
||||
if( PyType_Ready( &UnaryFunction0DUnsigned_Type ) < 0 )
|
||||
return -1;
|
||||
Py_INCREF( &UnaryFunction0DUnsigned_Type );
|
||||
PyModule_AddObject(module, "UnaryFunction0DUnsigned", (PyObject *)&UnaryFunction0DUnsigned_Type);
|
||||
|
||||
if( PyType_Ready( &QuantitativeInvisibilityF0D_Type ) < 0 )
|
||||
return -1;
|
||||
Py_INCREF( &QuantitativeInvisibilityF0D_Type );
|
||||
PyModule_AddObject(module, "QuantitativeInvisibilityF0D", (PyObject *)&QuantitativeInvisibilityF0D_Type);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
//------------------------INSTANCE METHODS ----------------------------------
|
||||
|
||||
static char UnaryFunction0DUnsigned___doc__[] =
|
||||
"Base class for unary functions (functors) that work on\n"
|
||||
":class:`Interface0DIterator` and return an int value.\n"
|
||||
"\n"
|
||||
".. method:: __init__()\n"
|
||||
"\n"
|
||||
" Default constructor.\n";
|
||||
|
||||
static int UnaryFunction0DUnsigned___init__(BPy_UnaryFunction0DUnsigned* self, PyObject *args, PyObject *kwds)
|
||||
{
|
||||
if ( !PyArg_ParseTuple(args, "") )
|
||||
return -1;
|
||||
self->uf0D_unsigned = new UnaryFunction0D<unsigned int>();
|
||||
self->uf0D_unsigned->py_uf0D = (PyObject *)self;
|
||||
return 0;
|
||||
}
|
||||
|
||||
static void UnaryFunction0DUnsigned___dealloc__(BPy_UnaryFunction0DUnsigned* self)
|
||||
{
|
||||
if (self->uf0D_unsigned)
|
||||
delete self->uf0D_unsigned;
|
||||
UnaryFunction0D_Type.tp_dealloc((PyObject*)self);
|
||||
}
|
||||
|
||||
static PyObject * UnaryFunction0DUnsigned___repr__(BPy_UnaryFunction0DUnsigned* self)
|
||||
{
|
||||
return PyUnicode_FromFormat("type: %s - address: %p", self->uf0D_unsigned->getName().c_str(), self->uf0D_unsigned );
|
||||
}
|
||||
|
||||
static char UnaryFunction0DUnsigned_getName___doc__[] =
|
||||
".. method:: getName()\n"
|
||||
"\n"
|
||||
" Returns the name of the unary 0D predicate.\n"
|
||||
"\n"
|
||||
" :return: The name of the unary 0D predicate.\n"
|
||||
" :rtype: string\n";
|
||||
|
||||
static PyObject * UnaryFunction0DUnsigned_getName( BPy_UnaryFunction0DUnsigned *self )
|
||||
{
|
||||
return PyUnicode_FromFormat( self->uf0D_unsigned->getName().c_str() );
|
||||
}
|
||||
|
||||
static PyObject * UnaryFunction0DUnsigned___call__( BPy_UnaryFunction0DUnsigned *self, PyObject *args, PyObject *kwds)
|
||||
{
|
||||
PyObject *obj;
|
||||
|
||||
if( kwds != NULL ) {
|
||||
PyErr_SetString(PyExc_TypeError, "keyword argument(s) not supported");
|
||||
return NULL;
|
||||
}
|
||||
if(!PyArg_ParseTuple(args, "O!", &Interface0DIterator_Type, &obj))
|
||||
return NULL;
|
||||
|
||||
if( typeid(*(self->uf0D_unsigned)) == typeid(UnaryFunction0D<unsigned int>) ) {
|
||||
PyErr_SetString(PyExc_TypeError, "__call__ method not properly overridden");
|
||||
return NULL;
|
||||
}
|
||||
if (self->uf0D_unsigned->operator()(*( ((BPy_Interface0DIterator *) obj)->if0D_it )) < 0) {
|
||||
if (!PyErr_Occurred()) {
|
||||
string msg(self->uf0D_unsigned->getName() + " __call__ method failed");
|
||||
PyErr_SetString(PyExc_RuntimeError, msg.c_str());
|
||||
}
|
||||
return NULL;
|
||||
}
|
||||
return PyLong_FromLong( self->uf0D_unsigned->result );
|
||||
|
||||
}
|
||||
|
||||
/*----------------------UnaryFunction0DUnsigned instance definitions ----------------------------*/
|
||||
static PyMethodDef BPy_UnaryFunction0DUnsigned_methods[] = {
|
||||
{"getName", ( PyCFunction ) UnaryFunction0DUnsigned_getName, METH_NOARGS, "() Returns the string of the name of the unary 0D function."},
|
||||
{"getName", ( PyCFunction ) UnaryFunction0DUnsigned_getName, METH_NOARGS, UnaryFunction0DUnsigned_getName___doc__},
|
||||
{NULL, NULL, 0, NULL}
|
||||
};
|
||||
|
||||
@@ -48,7 +130,7 @@ PyTypeObject UnaryFunction0DUnsigned_Type = {
|
||||
0, /* tp_setattro */
|
||||
0, /* tp_as_buffer */
|
||||
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
|
||||
"UnaryFunction0DUnsigned objects", /* tp_doc */
|
||||
UnaryFunction0DUnsigned___doc__, /* tp_doc */
|
||||
0, /* tp_traverse */
|
||||
0, /* tp_clear */
|
||||
0, /* tp_richcompare */
|
||||
@@ -68,81 +150,6 @@ PyTypeObject UnaryFunction0DUnsigned_Type = {
|
||||
0, /* tp_new */
|
||||
};
|
||||
|
||||
//-------------------MODULE INITIALIZATION--------------------------------
|
||||
|
||||
int UnaryFunction0DUnsigned_Init( PyObject *module ) {
|
||||
|
||||
if( module == NULL )
|
||||
return -1;
|
||||
|
||||
if( PyType_Ready( &UnaryFunction0DUnsigned_Type ) < 0 )
|
||||
return -1;
|
||||
Py_INCREF( &UnaryFunction0DUnsigned_Type );
|
||||
PyModule_AddObject(module, "UnaryFunction0DUnsigned", (PyObject *)&UnaryFunction0DUnsigned_Type);
|
||||
|
||||
if( PyType_Ready( &QuantitativeInvisibilityF0D_Type ) < 0 )
|
||||
return -1;
|
||||
Py_INCREF( &QuantitativeInvisibilityF0D_Type );
|
||||
PyModule_AddObject(module, "QuantitativeInvisibilityF0D", (PyObject *)&QuantitativeInvisibilityF0D_Type);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
//------------------------INSTANCE METHODS ----------------------------------
|
||||
|
||||
int UnaryFunction0DUnsigned___init__(BPy_UnaryFunction0DUnsigned* self, PyObject *args, PyObject *kwds)
|
||||
{
|
||||
if ( !PyArg_ParseTuple(args, "") )
|
||||
return -1;
|
||||
self->uf0D_unsigned = new UnaryFunction0D<unsigned int>();
|
||||
self->uf0D_unsigned->py_uf0D = (PyObject *)self;
|
||||
return 0;
|
||||
}
|
||||
|
||||
void UnaryFunction0DUnsigned___dealloc__(BPy_UnaryFunction0DUnsigned* self)
|
||||
{
|
||||
if (self->uf0D_unsigned)
|
||||
delete self->uf0D_unsigned;
|
||||
UnaryFunction0D_Type.tp_dealloc((PyObject*)self);
|
||||
}
|
||||
|
||||
|
||||
PyObject * UnaryFunction0DUnsigned___repr__(BPy_UnaryFunction0DUnsigned* self)
|
||||
{
|
||||
return PyUnicode_FromFormat("type: %s - address: %p", self->uf0D_unsigned->getName().c_str(), self->uf0D_unsigned );
|
||||
}
|
||||
|
||||
PyObject * UnaryFunction0DUnsigned_getName( BPy_UnaryFunction0DUnsigned *self )
|
||||
{
|
||||
return PyUnicode_FromFormat( self->uf0D_unsigned->getName().c_str() );
|
||||
}
|
||||
|
||||
PyObject * UnaryFunction0DUnsigned___call__( BPy_UnaryFunction0DUnsigned *self, PyObject *args, PyObject *kwds)
|
||||
{
|
||||
PyObject *obj;
|
||||
|
||||
if( kwds != NULL ) {
|
||||
PyErr_SetString(PyExc_TypeError, "keyword argument(s) not supported");
|
||||
return NULL;
|
||||
}
|
||||
if(!PyArg_ParseTuple(args, "O!", &Interface0DIterator_Type, &obj))
|
||||
return NULL;
|
||||
|
||||
if( typeid(*(self->uf0D_unsigned)) == typeid(UnaryFunction0D<unsigned int>) ) {
|
||||
PyErr_SetString(PyExc_TypeError, "__call__ method not properly overridden");
|
||||
return NULL;
|
||||
}
|
||||
if (self->uf0D_unsigned->operator()(*( ((BPy_Interface0DIterator *) obj)->if0D_it )) < 0) {
|
||||
if (!PyErr_Occurred()) {
|
||||
string msg(self->uf0D_unsigned->getName() + " __call__ method failed");
|
||||
PyErr_SetString(PyExc_RuntimeError, msg.c_str());
|
||||
}
|
||||
return NULL;
|
||||
}
|
||||
return PyLong_FromLong( self->uf0D_unsigned->result );
|
||||
|
||||
}
|
||||
|
||||
///////////////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
#ifdef __cplusplus
|
||||
|
||||
Reference in New Issue
Block a user