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:
@@ -12,21 +12,149 @@ extern "C" {
|
||||
|
||||
///////////////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/*--------------- Python API function prototypes for UnaryFunction1DUnsigned instance -----------*/
|
||||
static int UnaryFunction1DUnsigned___init__(BPy_UnaryFunction1DUnsigned* self, PyObject *args);
|
||||
static void UnaryFunction1DUnsigned___dealloc__(BPy_UnaryFunction1DUnsigned* self);
|
||||
static PyObject * UnaryFunction1DUnsigned___repr__(BPy_UnaryFunction1DUnsigned* self);
|
||||
//-------------------MODULE INITIALIZATION--------------------------------
|
||||
|
||||
static PyObject * UnaryFunction1DUnsigned_getName( BPy_UnaryFunction1DUnsigned *self);
|
||||
static PyObject * UnaryFunction1DUnsigned___call__( BPy_UnaryFunction1DUnsigned *self, PyObject *args, PyObject *kwds);
|
||||
static PyObject * UnaryFunction1DUnsigned_setIntegrationType(BPy_UnaryFunction1DUnsigned* self, PyObject *args);
|
||||
static PyObject * UnaryFunction1DUnsigned_getIntegrationType(BPy_UnaryFunction1DUnsigned* self);
|
||||
int UnaryFunction1DUnsigned_Init( PyObject *module ) {
|
||||
|
||||
if( module == NULL )
|
||||
return -1;
|
||||
|
||||
if( PyType_Ready( &UnaryFunction1DUnsigned_Type ) < 0 )
|
||||
return -1;
|
||||
Py_INCREF( &UnaryFunction1DUnsigned_Type );
|
||||
PyModule_AddObject(module, "UnaryFunction1DUnsigned", (PyObject *)&UnaryFunction1DUnsigned_Type);
|
||||
|
||||
if( PyType_Ready( &QuantitativeInvisibilityF1D_Type ) < 0 )
|
||||
return -1;
|
||||
Py_INCREF( &QuantitativeInvisibilityF1D_Type );
|
||||
PyModule_AddObject(module, "QuantitativeInvisibilityF1D", (PyObject *)&QuantitativeInvisibilityF1D_Type);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
//------------------------INSTANCE METHODS ----------------------------------
|
||||
|
||||
static char UnaryFunction1DUnsigned___doc__[] =
|
||||
"Base class for unary functions (functors) that work on\n"
|
||||
":class:`Interface1D` and return an int value.\n"
|
||||
"\n"
|
||||
".. method:: __init__()\n"
|
||||
"\n"
|
||||
" Default constructor.\n"
|
||||
"\n"
|
||||
".. method:: __init__(integration)\n"
|
||||
"\n"
|
||||
" Builds a unary 1D function using the integration method given as\n"
|
||||
" argument.\n"
|
||||
"\n"
|
||||
" :arg integration: An integration method.\n"
|
||||
" :type integration: :class:`IntegrationType`\n";
|
||||
|
||||
static int UnaryFunction1DUnsigned___init__(BPy_UnaryFunction1DUnsigned* self, PyObject *args)
|
||||
{
|
||||
PyObject *obj = 0;
|
||||
|
||||
if( !PyArg_ParseTuple(args, "|O!", &IntegrationType_Type, &obj) )
|
||||
return -1;
|
||||
|
||||
if( !obj )
|
||||
self->uf1D_unsigned = new UnaryFunction1D<unsigned int>();
|
||||
else {
|
||||
self->uf1D_unsigned = new UnaryFunction1D<unsigned int>( IntegrationType_from_BPy_IntegrationType(obj) );
|
||||
}
|
||||
|
||||
self->uf1D_unsigned->py_uf1D = (PyObject *)self;
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
static void UnaryFunction1DUnsigned___dealloc__(BPy_UnaryFunction1DUnsigned* self)
|
||||
{
|
||||
if (self->uf1D_unsigned)
|
||||
delete self->uf1D_unsigned;
|
||||
UnaryFunction1D_Type.tp_dealloc((PyObject*)self);
|
||||
}
|
||||
|
||||
static PyObject * UnaryFunction1DUnsigned___repr__(BPy_UnaryFunction1DUnsigned* self)
|
||||
{
|
||||
return PyUnicode_FromFormat("type: %s - address: %p", self->uf1D_unsigned->getName().c_str(), self->uf1D_unsigned );
|
||||
}
|
||||
|
||||
static char UnaryFunction1DUnsigned_getName___doc__[] =
|
||||
".. method:: getName()\n"
|
||||
"\n"
|
||||
" Returns the name of the unary 1D function.\n"
|
||||
"\n"
|
||||
" :return: The name of the unary 1D function.\n"
|
||||
" :rtype: string\n";
|
||||
|
||||
static PyObject * UnaryFunction1DUnsigned_getName( BPy_UnaryFunction1DUnsigned *self )
|
||||
{
|
||||
return PyUnicode_FromFormat( self->uf1D_unsigned->getName().c_str() );
|
||||
}
|
||||
|
||||
static PyObject * UnaryFunction1DUnsigned___call__( BPy_UnaryFunction1DUnsigned *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!", &Interface1D_Type, &obj) )
|
||||
return NULL;
|
||||
|
||||
if( typeid(*(self->uf1D_unsigned)) == typeid(UnaryFunction1D<unsigned int>) ) {
|
||||
PyErr_SetString(PyExc_TypeError, "__call__ method not properly overridden");
|
||||
return NULL;
|
||||
}
|
||||
if (self->uf1D_unsigned->operator()(*( ((BPy_Interface1D *) obj)->if1D )) < 0) {
|
||||
if (!PyErr_Occurred()) {
|
||||
string msg(self->uf1D_unsigned->getName() + " __call__ method failed");
|
||||
PyErr_SetString(PyExc_RuntimeError, msg.c_str());
|
||||
}
|
||||
return NULL;
|
||||
}
|
||||
return PyLong_FromLong( self->uf1D_unsigned->result );
|
||||
|
||||
}
|
||||
|
||||
static char UnaryFunction1DUnsigned_setIntegrationType___doc__[] =
|
||||
".. method:: setIntegrationType(integration)\n"
|
||||
"\n"
|
||||
" Sets the integration method.\n"
|
||||
"\n"
|
||||
" :arg integration: An integration method.\n"
|
||||
" :type integration: :class:`IntegrationType`\n";
|
||||
|
||||
static PyObject * UnaryFunction1DUnsigned_setIntegrationType(BPy_UnaryFunction1DUnsigned* self, PyObject *args)
|
||||
{
|
||||
PyObject *obj;
|
||||
|
||||
if( !PyArg_ParseTuple(args, "O!", &IntegrationType_Type, &obj) )
|
||||
return NULL;
|
||||
|
||||
self->uf1D_unsigned->setIntegrationType( IntegrationType_from_BPy_IntegrationType(obj) );
|
||||
Py_RETURN_NONE;
|
||||
}
|
||||
|
||||
static char UnaryFunction1DUnsigned_getIntegrationType___doc__[] =
|
||||
".. method:: getIntegrationType(integration)\n"
|
||||
"\n"
|
||||
" Returns the integration method.\n"
|
||||
"\n"
|
||||
" :return: The integration method.\n"
|
||||
" :rtype: :class:`IntegrationType`\n";
|
||||
|
||||
static PyObject * UnaryFunction1DUnsigned_getIntegrationType(BPy_UnaryFunction1DUnsigned* self) {
|
||||
return BPy_IntegrationType_from_IntegrationType( self->uf1D_unsigned->getIntegrationType() );
|
||||
}
|
||||
|
||||
/*----------------------UnaryFunction1DUnsigned instance definitions ----------------------------*/
|
||||
static PyMethodDef BPy_UnaryFunction1DUnsigned_methods[] = {
|
||||
{"getName", ( PyCFunction ) UnaryFunction1DUnsigned_getName, METH_NOARGS, "() Returns the string of the name of the unary 1D function."},
|
||||
{"setIntegrationType", ( PyCFunction ) UnaryFunction1DUnsigned_setIntegrationType, METH_VARARGS, "(IntegrationType i) Sets the integration method" },
|
||||
{"getIntegrationType", ( PyCFunction ) UnaryFunction1DUnsigned_getIntegrationType, METH_NOARGS, "() Returns the integration method." },
|
||||
{"getName", ( PyCFunction ) UnaryFunction1DUnsigned_getName, METH_NOARGS, UnaryFunction1DUnsigned_getName___doc__},
|
||||
{"setIntegrationType", ( PyCFunction ) UnaryFunction1DUnsigned_setIntegrationType, METH_VARARGS, UnaryFunction1DUnsigned_setIntegrationType___doc__},
|
||||
{"getIntegrationType", ( PyCFunction ) UnaryFunction1DUnsigned_getIntegrationType, METH_NOARGS, UnaryFunction1DUnsigned_getIntegrationType___doc__},
|
||||
{NULL, NULL, 0, NULL}
|
||||
};
|
||||
|
||||
@@ -53,7 +181,7 @@ PyTypeObject UnaryFunction1DUnsigned_Type = {
|
||||
0, /* tp_setattro */
|
||||
0, /* tp_as_buffer */
|
||||
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
|
||||
"UnaryFunction1DUnsigned objects", /* tp_doc */
|
||||
UnaryFunction1DUnsigned___doc__, /* tp_doc */
|
||||
0, /* tp_traverse */
|
||||
0, /* tp_clear */
|
||||
0, /* tp_richcompare */
|
||||
@@ -73,104 +201,6 @@ PyTypeObject UnaryFunction1DUnsigned_Type = {
|
||||
0, /* tp_new */
|
||||
};
|
||||
|
||||
//-------------------MODULE INITIALIZATION--------------------------------
|
||||
|
||||
int UnaryFunction1DUnsigned_Init( PyObject *module ) {
|
||||
|
||||
if( module == NULL )
|
||||
return -1;
|
||||
|
||||
if( PyType_Ready( &UnaryFunction1DUnsigned_Type ) < 0 )
|
||||
return -1;
|
||||
Py_INCREF( &UnaryFunction1DUnsigned_Type );
|
||||
PyModule_AddObject(module, "UnaryFunction1DUnsigned", (PyObject *)&UnaryFunction1DUnsigned_Type);
|
||||
|
||||
if( PyType_Ready( &QuantitativeInvisibilityF1D_Type ) < 0 )
|
||||
return -1;
|
||||
Py_INCREF( &QuantitativeInvisibilityF1D_Type );
|
||||
PyModule_AddObject(module, "QuantitativeInvisibilityF1D", (PyObject *)&QuantitativeInvisibilityF1D_Type);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
//------------------------INSTANCE METHODS ----------------------------------
|
||||
|
||||
int UnaryFunction1DUnsigned___init__(BPy_UnaryFunction1DUnsigned* self, PyObject *args)
|
||||
{
|
||||
PyObject *obj = 0;
|
||||
|
||||
if( !PyArg_ParseTuple(args, "|O!", &IntegrationType_Type, &obj) )
|
||||
return -1;
|
||||
|
||||
if( !obj )
|
||||
self->uf1D_unsigned = new UnaryFunction1D<unsigned int>();
|
||||
else {
|
||||
self->uf1D_unsigned = new UnaryFunction1D<unsigned int>( IntegrationType_from_BPy_IntegrationType(obj) );
|
||||
}
|
||||
|
||||
self->uf1D_unsigned->py_uf1D = (PyObject *)self;
|
||||
|
||||
return 0;
|
||||
}
|
||||
void UnaryFunction1DUnsigned___dealloc__(BPy_UnaryFunction1DUnsigned* self)
|
||||
{
|
||||
if (self->uf1D_unsigned)
|
||||
delete self->uf1D_unsigned;
|
||||
UnaryFunction1D_Type.tp_dealloc((PyObject*)self);
|
||||
}
|
||||
|
||||
|
||||
PyObject * UnaryFunction1DUnsigned___repr__(BPy_UnaryFunction1DUnsigned* self)
|
||||
{
|
||||
return PyUnicode_FromFormat("type: %s - address: %p", self->uf1D_unsigned->getName().c_str(), self->uf1D_unsigned );
|
||||
}
|
||||
|
||||
PyObject * UnaryFunction1DUnsigned_getName( BPy_UnaryFunction1DUnsigned *self )
|
||||
{
|
||||
return PyUnicode_FromFormat( self->uf1D_unsigned->getName().c_str() );
|
||||
}
|
||||
|
||||
PyObject * UnaryFunction1DUnsigned___call__( BPy_UnaryFunction1DUnsigned *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!", &Interface1D_Type, &obj) )
|
||||
return NULL;
|
||||
|
||||
if( typeid(*(self->uf1D_unsigned)) == typeid(UnaryFunction1D<unsigned int>) ) {
|
||||
PyErr_SetString(PyExc_TypeError, "__call__ method not properly overridden");
|
||||
return NULL;
|
||||
}
|
||||
if (self->uf1D_unsigned->operator()(*( ((BPy_Interface1D *) obj)->if1D )) < 0) {
|
||||
if (!PyErr_Occurred()) {
|
||||
string msg(self->uf1D_unsigned->getName() + " __call__ method failed");
|
||||
PyErr_SetString(PyExc_RuntimeError, msg.c_str());
|
||||
}
|
||||
return NULL;
|
||||
}
|
||||
return PyLong_FromLong( self->uf1D_unsigned->result );
|
||||
|
||||
}
|
||||
|
||||
PyObject * UnaryFunction1DUnsigned_setIntegrationType(BPy_UnaryFunction1DUnsigned* self, PyObject *args)
|
||||
{
|
||||
PyObject *obj;
|
||||
|
||||
if( !PyArg_ParseTuple(args, "O!", &IntegrationType_Type, &obj) )
|
||||
return NULL;
|
||||
|
||||
self->uf1D_unsigned->setIntegrationType( IntegrationType_from_BPy_IntegrationType(obj) );
|
||||
Py_RETURN_NONE;
|
||||
}
|
||||
|
||||
PyObject * UnaryFunction1DUnsigned_getIntegrationType(BPy_UnaryFunction1DUnsigned* self) {
|
||||
return BPy_IntegrationType_from_IntegrationType( self->uf1D_unsigned->getIntegrationType() );
|
||||
}
|
||||
|
||||
///////////////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
#ifdef __cplusplus
|
||||
|
||||
Reference in New Issue
Block a user