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:
2010-04-17 23:47:47 +00:00
parent 11fc330f7e
commit d7e08f2d33
154 changed files with 11542 additions and 6746 deletions

View File

@@ -16,63 +16,6 @@ extern "C" {
///////////////////////////////////////////////////////////////////////////////////////////
/*--------------- Python API function prototypes for UnaryFunction0DFloat instance -----------*/
static int UnaryFunction0DFloat___init__(BPy_UnaryFunction0DFloat* self, PyObject *args, PyObject *kwds);
static void UnaryFunction0DFloat___dealloc__(BPy_UnaryFunction0DFloat* self);
static PyObject * UnaryFunction0DFloat___repr__(BPy_UnaryFunction0DFloat* self);
static PyObject * UnaryFunction0DFloat_getName( BPy_UnaryFunction0DFloat *self);
static PyObject * UnaryFunction0DFloat___call__( BPy_UnaryFunction0DFloat *self, PyObject *args, PyObject *kwds);
/*----------------------UnaryFunction0DFloat instance definitions ----------------------------*/
static PyMethodDef BPy_UnaryFunction0DFloat_methods[] = {
{"getName", ( PyCFunction ) UnaryFunction0DFloat_getName, METH_NOARGS, "() Returns the string of the name of the unary 0D function."},
{NULL, NULL, 0, NULL}
};
/*-----------------------BPy_UnaryFunction0DFloat type definition ------------------------------*/
PyTypeObject UnaryFunction0DFloat_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
"UnaryFunction0DFloat", /* tp_name */
sizeof(BPy_UnaryFunction0DFloat), /* tp_basicsize */
0, /* tp_itemsize */
(destructor)UnaryFunction0DFloat___dealloc__, /* tp_dealloc */
0, /* tp_print */
0, /* tp_getattr */
0, /* tp_setattr */
0, /* tp_reserved */
(reprfunc)UnaryFunction0DFloat___repr__, /* tp_repr */
0, /* tp_as_number */
0, /* tp_as_sequence */
0, /* tp_as_mapping */
0, /* tp_hash */
(ternaryfunc)UnaryFunction0DFloat___call__, /* tp_call */
0, /* tp_str */
0, /* tp_getattro */
0, /* tp_setattro */
0, /* tp_as_buffer */
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
"UnaryFunction0DFloat objects", /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */
0, /* tp_weaklistoffset */
0, /* tp_iter */
0, /* tp_iternext */
BPy_UnaryFunction0DFloat_methods, /* tp_methods */
0, /* tp_members */
0, /* tp_getset */
&UnaryFunction0D_Type, /* tp_base */
0, /* tp_dict */
0, /* tp_descr_get */
0, /* tp_descr_set */
0, /* tp_dictoffset */
(initproc)UnaryFunction0DFloat___init__, /* tp_init */
0, /* tp_alloc */
0, /* tp_new */
};
//-------------------MODULE INITIALIZATION--------------------------------
int UnaryFunction0DFloat_Init( PyObject *module ) {
@@ -120,7 +63,15 @@ int UnaryFunction0DFloat_Init( PyObject *module ) {
//------------------------INSTANCE METHODS ----------------------------------
int UnaryFunction0DFloat___init__(BPy_UnaryFunction0DFloat* self, PyObject *args, PyObject *kwds)
static char UnaryFunction0DFloat___doc__[] =
"Base class for unary functions (functors) that work on\n"
":class:`Interface0DIterator` and return a float value.\n"
"\n"
".. method:: __init__()\n"
"\n"
" Default constructor.\n";
static int UnaryFunction0DFloat___init__(BPy_UnaryFunction0DFloat* self, PyObject *args, PyObject *kwds)
{
if ( !PyArg_ParseTuple(args, "") )
return -1;
@@ -129,25 +80,32 @@ int UnaryFunction0DFloat___init__(BPy_UnaryFunction0DFloat* self, PyObject *args
return 0;
}
void UnaryFunction0DFloat___dealloc__(BPy_UnaryFunction0DFloat* self)
static void UnaryFunction0DFloat___dealloc__(BPy_UnaryFunction0DFloat* self)
{
if (self->uf0D_float)
delete self->uf0D_float;
UnaryFunction0D_Type.tp_dealloc((PyObject*)self);
}
PyObject * UnaryFunction0DFloat___repr__(BPy_UnaryFunction0DFloat* self)
static PyObject * UnaryFunction0DFloat___repr__(BPy_UnaryFunction0DFloat* self)
{
return PyUnicode_FromFormat("type: %s - address: %p", self->uf0D_float->getName().c_str(), self->uf0D_float );
}
PyObject * UnaryFunction0DFloat_getName( BPy_UnaryFunction0DFloat *self )
static char UnaryFunction0DFloat_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 * UnaryFunction0DFloat_getName( BPy_UnaryFunction0DFloat *self )
{
return PyUnicode_FromFormat( self->uf0D_float->getName().c_str() );
}
PyObject * UnaryFunction0DFloat___call__( BPy_UnaryFunction0DFloat *self, PyObject *args, PyObject *kwds)
static PyObject * UnaryFunction0DFloat___call__( BPy_UnaryFunction0DFloat *self, PyObject *args, PyObject *kwds)
{
PyObject *obj;
@@ -173,6 +131,55 @@ PyObject * UnaryFunction0DFloat___call__( BPy_UnaryFunction0DFloat *self, PyObje
}
/*----------------------UnaryFunction0DFloat instance definitions ----------------------------*/
static PyMethodDef BPy_UnaryFunction0DFloat_methods[] = {
{"getName", ( PyCFunction ) UnaryFunction0DFloat_getName, METH_NOARGS, UnaryFunction0DFloat_getName___doc__},
{NULL, NULL, 0, NULL}
};
/*-----------------------BPy_UnaryFunction0DFloat type definition ------------------------------*/
PyTypeObject UnaryFunction0DFloat_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
"UnaryFunction0DFloat", /* tp_name */
sizeof(BPy_UnaryFunction0DFloat), /* tp_basicsize */
0, /* tp_itemsize */
(destructor)UnaryFunction0DFloat___dealloc__, /* tp_dealloc */
0, /* tp_print */
0, /* tp_getattr */
0, /* tp_setattr */
0, /* tp_reserved */
(reprfunc)UnaryFunction0DFloat___repr__, /* tp_repr */
0, /* tp_as_number */
0, /* tp_as_sequence */
0, /* tp_as_mapping */
0, /* tp_hash */
(ternaryfunc)UnaryFunction0DFloat___call__, /* tp_call */
0, /* tp_str */
0, /* tp_getattro */
0, /* tp_setattro */
0, /* tp_as_buffer */
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
UnaryFunction0DFloat___doc__, /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */
0, /* tp_weaklistoffset */
0, /* tp_iter */
0, /* tp_iternext */
BPy_UnaryFunction0DFloat_methods, /* tp_methods */
0, /* tp_members */
0, /* tp_getset */
&UnaryFunction0D_Type, /* tp_base */
0, /* tp_dict */
0, /* tp_descr_get */
0, /* tp_descr_set */
0, /* tp_dictoffset */
(initproc)UnaryFunction0DFloat___init__, /* tp_init */
0, /* tp_alloc */
0, /* tp_new */
};
///////////////////////////////////////////////////////////////////////////////////////////
#ifdef __cplusplus