archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity

Major documentation updates. The original Freestyle API reference

Browse Source 
(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
2010-04-17 23:47:47 +00:00
parent 11fc330f7e
commit d7e08f2d33
154 changed files with 11542 additions and 6746 deletions
Download Patch File Download Diff File Expand all files Collapse all files

171
source/blender/freestyle/intern/python/UnaryFunction0D/BPy_UnaryFunction0DId.cpp
View File

@@ -11,17 +11,98 @@ extern "C" {
///////////////////////////////////////////////////////////////////////////////////////////
/*--------------- Python API function prototypes for UnaryFunction0DId instance -----------*/
static int UnaryFunction0DId___init__(BPy_UnaryFunction0DId* self, PyObject *args, PyObject *kwds);
static void UnaryFunction0DId___dealloc__(BPy_UnaryFunction0DId* self);
static PyObject * UnaryFunction0DId___repr__(BPy_UnaryFunction0DId* self);
//-------------------MODULE INITIALIZATION--------------------------------
static PyObject * UnaryFunction0DId_getName( BPy_UnaryFunction0DId *self);
static PyObject * UnaryFunction0DId___call__( BPy_UnaryFunction0DId *self, PyObject *args, PyObject *kwds);
int UnaryFunction0DId_Init( PyObject *module ) {
if( module == NULL )
return -1;
if( PyType_Ready( &UnaryFunction0DId_Type ) < 0 )
return -1;
Py_INCREF( &UnaryFunction0DId_Type );
PyModule_AddObject(module, "UnaryFunction0DId", (PyObject *)&UnaryFunction0DId_Type);
if( PyType_Ready( &ShapeIdF0D_Type ) < 0 )
return -1;
Py_INCREF( &ShapeIdF0D_Type );
PyModule_AddObject(module, "ShapeIdF0D", (PyObject *)&ShapeIdF0D_Type);
return 0;
}
//------------------------INSTANCE METHODS ----------------------------------
static char UnaryFunction0DId___doc__[] =
"Base class for unary functions (functors) that work on\n"
":class:`Interface0DIterator` and return an :class:`Id` object.\n"
"\n"
".. method:: __init__()\n"
"\n"
" Default constructor.\n";
static int UnaryFunction0DId___init__(BPy_UnaryFunction0DId* self, PyObject *args, PyObject *kwds)
{
if ( !PyArg_ParseTuple(args, "") )
return -1;
self->uf0D_id = new UnaryFunction0D<Id>();
self->uf0D_id->py_uf0D = (PyObject *)self;
return 0;
}
static void UnaryFunction0DId___dealloc__(BPy_UnaryFunction0DId* self)
{
if (self->uf0D_id)
delete self->uf0D_id;
UnaryFunction0D_Type.tp_dealloc((PyObject*)self);
}
static PyObject * UnaryFunction0DId___repr__(BPy_UnaryFunction0DId* self)
{
return PyUnicode_FromFormat("type: %s - address: %p", self->uf0D_id->getName().c_str(), self->uf0D_id );
}
static char UnaryFunction0DId_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 * UnaryFunction0DId_getName( BPy_UnaryFunction0DId *self )
{
return PyUnicode_FromFormat( self->uf0D_id->getName().c_str() );
}
static PyObject * UnaryFunction0DId___call__( BPy_UnaryFunction0DId *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_id)) == typeid(UnaryFunction0D<Id>) ) {
PyErr_SetString(PyExc_TypeError, "__call__ method not properly overridden");
return NULL;
}
if (self->uf0D_id->operator()(*( ((BPy_Interface0DIterator *) obj)->if0D_it )) < 0) {
if (!PyErr_Occurred()) {
string msg(self->uf0D_id->getName() + " __call__ method failed");
PyErr_SetString(PyExc_RuntimeError, msg.c_str());
}
return NULL;
}
return BPy_Id_from_Id( self->uf0D_id->result );
}
/*----------------------UnaryFunction0DId instance definitions ----------------------------*/
static PyMethodDef BPy_UnaryFunction0DId_methods[] = {
{"getName", ( PyCFunction ) UnaryFunction0DId_getName, METH_NOARGS, "() Returns the string of the name of the unary 0D function."},
{"getName", ( PyCFunction ) UnaryFunction0DId_getName, METH_NOARGS, UnaryFunction0DId_getName___doc__},
{NULL, NULL, 0, NULL}
};
@@ -48,7 +129,7 @@ PyTypeObject UnaryFunction0DId_Type = {
0, /* tp_setattro */
0, /* tp_as_buffer */
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
"UnaryFunction0DId objects", /* tp_doc */
UnaryFunction0DId___doc__, /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */
@@ -68,80 +149,6 @@ PyTypeObject UnaryFunction0DId_Type = {
0, /* tp_new */
};
//-------------------MODULE INITIALIZATION--------------------------------
int UnaryFunction0DId_Init( PyObject *module ) {
if( module == NULL )
return -1;
if( PyType_Ready( &UnaryFunction0DId_Type ) < 0 )
return -1;
Py_INCREF( &UnaryFunction0DId_Type );
PyModule_AddObject(module, "UnaryFunction0DId", (PyObject *)&UnaryFunction0DId_Type);
if( PyType_Ready( &ShapeIdF0D_Type ) < 0 )
return -1;
Py_INCREF( &ShapeIdF0D_Type );
PyModule_AddObject(module, "ShapeIdF0D", (PyObject *)&ShapeIdF0D_Type);
return 0;
}
//------------------------INSTANCE METHODS ----------------------------------
int UnaryFunction0DId___init__(BPy_UnaryFunction0DId* self, PyObject *args, PyObject *kwds)
{
if ( !PyArg_ParseTuple(args, "") )
return -1;
self->uf0D_id = new UnaryFunction0D<Id>();
self->uf0D_id->py_uf0D = (PyObject *)self;
return 0;
}
void UnaryFunction0DId___dealloc__(BPy_UnaryFunction0DId* self)
{
if (self->uf0D_id)
delete self->uf0D_id;
UnaryFunction0D_Type.tp_dealloc((PyObject*)self);
}
PyObject * UnaryFunction0DId___repr__(BPy_UnaryFunction0DId* self)
{
return PyUnicode_FromFormat("type: %s - address: %p", self->uf0D_id->getName().c_str(), self->uf0D_id );
}
PyObject * UnaryFunction0DId_getName( BPy_UnaryFunction0DId *self )
{
return PyUnicode_FromFormat( self->uf0D_id->getName().c_str() );
}
PyObject * UnaryFunction0DId___call__( BPy_UnaryFunction0DId *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_id)) == typeid(UnaryFunction0D<Id>) ) {
PyErr_SetString(PyExc_TypeError, "__call__ method not properly overridden");
return NULL;
}
if (self->uf0D_id->operator()(*( ((BPy_Interface0DIterator *) obj)->if0D_it )) < 0) {
if (!PyErr_Occurred()) {
string msg(self->uf0D_id->getName() + " __call__ method failed");
PyErr_SetString(PyExc_RuntimeError, msg.c_str());
}
return NULL;
}
return BPy_Id_from_Id( self->uf0D_id->result );
}
///////////////////////////////////////////////////////////////////////////////////////////
#ifdef __cplusplus