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

46
source/blender/freestyle/intern/python/StrokeShader/BPy_fstreamShader.cpp
View File

@@ -8,8 +8,35 @@ extern "C" {
///////////////////////////////////////////////////////////////////////////////////////////
/*--------------- Python API function prototypes for fstreamShader instance -----------*/
static int fstreamShader___init__( BPy_fstreamShader* self, PyObject *args);
//------------------------INSTANCE METHODS ----------------------------------
static char fstreamShader___doc__[] =
"[Output shader]\n"
"\n"
".. method:: __init__(iFileName)\n"
"\n"
" Builds a fstreamShader object.\n"
"\n"
" :arg iFileName: The output file name.\n"
" :type iFileName: string\n"
"\n"
".. method:: shade(s)\n"
"\n"
" Streams the Stroke in a file.\n"
"\n"
" :arg s: A Stroke object.\n"
" :type s: :class:`Stroke`\n";
static int fstreamShader___init__( BPy_fstreamShader* self, PyObject *args)
{
const char *s;
if(!( PyArg_ParseTuple(args, "s", &s) ))
return -1;
self->py_ss.ss = new StrokeShaders::fstreamShader(s);
return 0;
}
/*-----------------------BPy_fstreamShader type definition ------------------------------*/
@@ -34,7 +61,7 @@ PyTypeObject fstreamShader_Type = {
0, /* tp_setattro */
0, /* tp_as_buffer */
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
"fstreamShader objects", /* tp_doc */
fstreamShader___doc__, /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */
@@ -54,19 +81,6 @@ PyTypeObject fstreamShader_Type = {
0, /* tp_new */
};
//------------------------INSTANCE METHODS ----------------------------------
int fstreamShader___init__( BPy_fstreamShader* self, PyObject *args)
{
const char *s;
if(!( PyArg_ParseTuple(args, "s", &s) ))
return -1;
self->py_ss.ss = new StrokeShaders::fstreamShader(s);
return 0;
}
///////////////////////////////////////////////////////////////////////////////////////////
#ifdef __cplusplus