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

43
source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_Vec2f/BPy_Normal2DF0D.cpp
View File

@@ -8,8 +8,34 @@ extern "C" {
///////////////////////////////////////////////////////////////////////////////////////////
/*--------------- Python API function prototypes for Normal2DF0D instance -----------*/
static int Normal2DF0D___init__(BPy_Normal2DF0D* self, PyObject *args);
//------------------------INSTANCE METHODS ----------------------------------
static char Normal2DF0D___doc__[] =
".. method:: __init__()\n"
"\n"
" Builds a Normal2DF0D object.\n"
"\n"
".. method:: __call__(it)\n"
"\n"
" Returns a two-dimensional vector giving the normalized 2D normal to\n"
" the 1D element to which the :class:`Interface0D` pointed by the\n"
" Interface0DIterator belongs. The normal is evaluated at the pointed\n"
" Interface0D.\n"
"\n"
" :arg it: An Interface0DIterator object.\n"
" :type it: :class:`Interface0DIterator`\n"
" :return: The 2D normal of the 1D element evaluated at the pointed\n"
" Interface0D.\n"
" :rtype: :class:`Mathutils.Vector`\n";
static int Normal2DF0D___init__( BPy_Normal2DF0D* self, PyObject *args )
{
if( !PyArg_ParseTuple(args, "") )
return -1;
self->py_uf0D_vec2f.uf0D_vec2f = new Functions0D::Normal2DF0D();
self->py_uf0D_vec2f.uf0D_vec2f->py_uf0D = (PyObject *)self;
return 0;
}
/*-----------------------BPy_Normal2DF0D type definition ------------------------------*/
@@ -34,7 +60,7 @@ PyTypeObject Normal2DF0D_Type = {
0, /* tp_setattro */
0, /* tp_as_buffer */
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
"Normal2DF0D objects", /* tp_doc */
Normal2DF0D___doc__, /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */
@@ -54,17 +80,6 @@ PyTypeObject Normal2DF0D_Type = {
0, /* tp_new */
};
//------------------------INSTANCE METHODS ----------------------------------
int Normal2DF0D___init__( BPy_Normal2DF0D* self, PyObject *args )
{
if( !PyArg_ParseTuple(args, "") )
return -1;
self->py_uf0D_vec2f.uf0D_vec2f = new Functions0D::Normal2DF0D();
self->py_uf0D_vec2f.uf0D_vec2f->py_uf0D = (PyObject *)self;
return 0;
}
///////////////////////////////////////////////////////////////////////////////////////////
#ifdef __cplusplus

43
source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_Vec2f/BPy_VertexOrientation2DF0D.cpp
View File

@@ -8,8 +8,34 @@ extern "C" {
///////////////////////////////////////////////////////////////////////////////////////////
/*--------------- Python API function prototypes for VertexOrientation2DF0D instance -----------*/
static int VertexOrientation2DF0D___init__(BPy_VertexOrientation2DF0D* self, PyObject *args);
//------------------------INSTANCE METHODS ----------------------------------
static char VertexOrientation2DF0D___doc__[] =
".. method:: __init__()\n"
"\n"
" Builds a VertexOrientation2DF0D object.\n"
"\n"
".. method:: __call__(it)\n"
"\n"
" Returns a two-dimensional vector giving the 2D oriented tangent to\n"
" the 1D element to which the :class:`Interface0D` pointed by the\n"
" Interface0DIterator belongs. The 2D oriented tangent is evaluated\n"
" at the pointed Interface0D.\n"
"\n"
" :arg it: An Interface0DIterator object.\n"
" :type it: :class:`Interface0DIterator`\n"
" :return: The 2D oriented tangent to the 1D element evaluated at the\n"
" pointed Interface0D.\n"
" :rtype: :class:`Mathutils.Vector`\n";
static int VertexOrientation2DF0D___init__( BPy_VertexOrientation2DF0D* self, PyObject *args )
{
if( !PyArg_ParseTuple(args, "") )
return -1;
self->py_uf0D_vec2f.uf0D_vec2f = new Functions0D::VertexOrientation2DF0D();
self->py_uf0D_vec2f.uf0D_vec2f->py_uf0D = (PyObject *)self;
return 0;
}
/*-----------------------BPy_VertexOrientation2DF0D type definition ------------------------------*/
@@ -34,7 +60,7 @@ PyTypeObject VertexOrientation2DF0D_Type = {
0, /* tp_setattro */
0, /* tp_as_buffer */
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
"VertexOrientation2DF0D objects", /* tp_doc */
VertexOrientation2DF0D___doc__, /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */
@@ -54,17 +80,6 @@ PyTypeObject VertexOrientation2DF0D_Type = {
0, /* tp_new */
};
//------------------------INSTANCE METHODS ----------------------------------
int VertexOrientation2DF0D___init__( BPy_VertexOrientation2DF0D* self, PyObject *args )
{
if( !PyArg_ParseTuple(args, "") )
return -1;
self->py_uf0D_vec2f.uf0D_vec2f = new Functions0D::VertexOrientation2DF0D();
self->py_uf0D_vec2f.uf0D_vec2f->py_uf0D = (PyObject *)self;
return 0;
}
///////////////////////////////////////////////////////////////////////////////////////////
#ifdef __cplusplus