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

115
source/blender/freestyle/intern/python/BPy_UnaryFunction0D.cpp
View File

@@ -18,54 +18,6 @@ extern "C" {
///////////////////////////////////////////////////////////////////////////////////////////
/*--------------- Python API function prototypes for UnaryFunction0D instance -----------*/
static void UnaryFunction0D___dealloc__(BPy_UnaryFunction0D *self);
static PyObject * UnaryFunction0D___repr__(BPy_UnaryFunction0D *self);
/*-----------------------BPy_UnaryFunction0D type definition ------------------------------*/
PyTypeObject UnaryFunction0D_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
"UnaryFunction0D", /* tp_name */
sizeof(BPy_UnaryFunction0D), /* tp_basicsize */
0, /* tp_itemsize */
(destructor)UnaryFunction0D___dealloc__, /* tp_dealloc */
0, /* tp_print */
0, /* tp_getattr */
0, /* tp_setattr */
0, /* tp_reserved */
(reprfunc)UnaryFunction0D___repr__, /* tp_repr */
0, /* tp_as_number */
0, /* tp_as_sequence */
0, /* tp_as_mapping */
0, /* tp_hash */
0, /* tp_call */
0, /* tp_str */
0, /* tp_getattro */
0, /* tp_setattro */
0, /* tp_as_buffer */
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
"UnaryFunction0D objects", /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */
0, /* tp_weaklistoffset */
0, /* tp_iter */
0, /* tp_iternext */
0, /* tp_methods */
0, /* tp_members */
0, /* tp_getset */
0, /* tp_base */
0, /* tp_dict */
0, /* tp_descr_get */
0, /* tp_descr_set */
0, /* tp_dictoffset */
0, /* tp_init */
0, /* tp_alloc */
PyType_GenericNew, /* tp_new */
};
//-------------------MODULE INITIALIZATION--------------------------------
int UnaryFunction0D_Init( PyObject *module )
{
@@ -93,17 +45,80 @@ int UnaryFunction0D_Init( PyObject *module )
//------------------------INSTANCE METHODS ----------------------------------
void UnaryFunction0D___dealloc__(BPy_UnaryFunction0D* self)
static char UnaryFunction0D___doc__[] =
"Base class for Unary Functions (functors) working on\n"
":class:`Interface0DIterator`. A unary function will be used by\n"
"invoking __call__() on an Interface0DIterator. In Python, several\n"
"different subclasses of UnaryFunction0D are used depending on the\n"
"types of functors' return values. For example, you would inherit from\n"
"a :class:`UnaryFunction0DDouble` if you wish to define a function that\n"
"returns a double value. Available UnaryFunction0D subclasses are:\n"
"\n"
"* :class:`UnaryFunction0DDouble`\n"
"* :class:`UnaryFunction0DEdgeNature`\n"
"* :class:`UnaryFunction0DFloat`\n"
"* :class:`UnaryFunction0DId`\n"
"* :class:`UnaryFunction0DMaterial`\n"
"* :class:`UnaryFunction0DUnsigned`\n"
"* :class:`UnaryFunction0DVec2f`\n"
"* :class:`UnaryFunction0DVec3f`\n"
"* :class:`UnaryFunction0DVectorViewShape`\n"
"* :class:`UnaryFunction0DViewShape`\n";
static void UnaryFunction0D___dealloc__(BPy_UnaryFunction0D* self)
{
Py_TYPE(self)->tp_free((PyObject*)self);
}
PyObject * UnaryFunction0D___repr__(BPy_UnaryFunction0D* self)
static PyObject * UnaryFunction0D___repr__(BPy_UnaryFunction0D* self)
{
return PyUnicode_FromFormat("UnaryFunction0D");
}
/*-----------------------BPy_UnaryFunction0D type definition ------------------------------*/
PyTypeObject UnaryFunction0D_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
"UnaryFunction0D", /* tp_name */
sizeof(BPy_UnaryFunction0D), /* tp_basicsize */
0, /* tp_itemsize */
(destructor)UnaryFunction0D___dealloc__, /* tp_dealloc */
0, /* tp_print */
0, /* tp_getattr */
0, /* tp_setattr */
0, /* tp_reserved */
(reprfunc)UnaryFunction0D___repr__, /* tp_repr */
0, /* tp_as_number */
0, /* tp_as_sequence */
0, /* tp_as_mapping */
0, /* tp_hash */
0, /* tp_call */
0, /* tp_str */
0, /* tp_getattro */
0, /* tp_setattro */
0, /* tp_as_buffer */
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
UnaryFunction0D___doc__, /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */
0, /* tp_weaklistoffset */
0, /* tp_iter */
0, /* tp_iternext */
0, /* tp_methods */
0, /* tp_members */
0, /* tp_getset */
0, /* tp_base */
0, /* tp_dict */
0, /* tp_descr_get */
0, /* tp_descr_set */
0, /* tp_dictoffset */
0, /* tp_init */
0, /* tp_alloc */
PyType_GenericNew, /* tp_new */
};
///////////////////////////////////////////////////////////////////////////////////////////
#ifdef __cplusplus