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

191
source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSmooth.cpp
View File

@@ -9,73 +9,34 @@ extern "C" {
///////////////////////////////////////////////////////////////////////////////////////////
/*--------------- Python API function prototypes for FEdgeSmooth instance -----------*/
static int FEdgeSmooth___init__(BPy_FEdgeSmooth *self, PyObject *args, PyObject *kwds);
static PyObject * FEdgeSmooth_normal( BPy_FEdgeSmooth *self ) ;
static PyObject * FEdgeSmooth_materialIndex( BPy_FEdgeSmooth *self ) ;
static PyObject * FEdgeSmooth_material( BPy_FEdgeSmooth *self );
static PyObject * FEdgeSmooth_setNormal( BPy_FEdgeSmooth *self, PyObject *args );
static PyObject * FEdgeSmooth_setMaterialIndex( BPy_FEdgeSmooth *self, PyObject *args );
/*----------------------FEdgeSmooth instance definitions ----------------------------*/
static PyMethodDef BPy_FEdgeSmooth_methods[] = {
{"normal", ( PyCFunction ) FEdgeSmooth_normal, METH_NOARGS, "() Returns the normal to the Face it is running accross."},
{"materialIndex", ( PyCFunction ) FEdgeSmooth_materialIndex, METH_NOARGS, "() Returns the index of the material of the face it is running accross. "},
{"material", ( PyCFunction ) FEdgeSmooth_material, METH_NOARGS, "() Returns the material of the face it is running accross. "},
{"setNormal", ( PyCFunction ) FEdgeSmooth_setNormal, METH_VARARGS, "([x,y,z]) Sets the normal to the Face it is running accross."},
{"setMaterialIndex", ( PyCFunction ) FEdgeSmooth_setMaterialIndex, METH_VARARGS, "(unsigned int i) Sets the index of the material of the face it is running accross. "},
{NULL, NULL, 0, NULL}
};
/*-----------------------BPy_FEdgeSmooth type definition ------------------------------*/
PyTypeObject FEdgeSmooth_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
"FEdgeSmooth", /* tp_name */
sizeof(BPy_FEdgeSmooth), /* tp_basicsize */
0, /* tp_itemsize */
0, /* tp_dealloc */
0, /* tp_print */
0, /* tp_getattr */
0, /* tp_setattr */
0, /* tp_reserved */
0, /* 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 */
"FEdgeSmooth objects", /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */
0, /* tp_weaklistoffset */
0, /* tp_iter */
0, /* tp_iternext */
BPy_FEdgeSmooth_methods, /* tp_methods */
0, /* tp_members */
0, /* tp_getset */
&FEdge_Type, /* tp_base */
0, /* tp_dict */
0, /* tp_descr_get */
0, /* tp_descr_set */
0, /* tp_dictoffset */
(initproc)FEdgeSmooth___init__, /* tp_init */
0, /* tp_alloc */
0, /* tp_new */
};
//------------------------INSTANCE METHODS ----------------------------------
static char FEdgeSmooth___doc__[] =
"Class defining a smooth edge. This kind of edge typically runs across\n"
"a face of the input mesh. It can be a silhouette, a ridge or valley,\n"
"a suggestive contour.\n"
"\n"
".. method:: __init__()\n"
"\n"
" Default constructor.\n"
"\n"
".. method:: __init__(iBrother)\n"
"\n"
" Copy constructor.\n"
"\n"
" :arg iBrother: An FEdgeSmooth object.\n"
" :type iBrother: :class:`FEdgeSmooth`\n"
"\n"
".. method:: __init__(vA, vB)\n"
"\n"
" Builds an FEdgeSmooth going from vA to vB.\n"
"\n"
" :arg vA: The first SVertex object.\n"
" :type vA: :class:`SVertex`\n"
" :arg vB: The second SVertex object.\n"
" :type vB: :class:`SVertex`\n";
int FEdgeSmooth___init__(BPy_FEdgeSmooth *self, PyObject *args, PyObject *kwds)
static int FEdgeSmooth___init__(BPy_FEdgeSmooth *self, PyObject *args, PyObject *kwds)
{
PyObject *obj1 = 0, *obj2 = 0;
@@ -103,22 +64,53 @@ int FEdgeSmooth___init__(BPy_FEdgeSmooth *self, PyObject *args, PyObject *kwds)
return 0;
}
PyObject * FEdgeSmooth_normal( BPy_FEdgeSmooth *self ) {
static char FEdgeSmooth_normal___doc__[] =
".. method:: normal()\n"
"\n"
" Returns the normal to the Face it is running accross.\n"
"\n"
" :return: The normal to the Face it is running accross.\n"
" :rtype: :class:`Mathutils.Vector`\n";
static PyObject * FEdgeSmooth_normal( BPy_FEdgeSmooth *self ) {
Vec3r v( self->fes->normal() );
return Vector_from_Vec3r( v );
}
PyObject * FEdgeSmooth_materialIndex( BPy_FEdgeSmooth *self ) {
static char FEdgeSmooth_materialIndex___doc__[] =
".. method:: materialIndex()\n"
"\n"
" Returns the index of the material of the face it is running accross.\n"
"\n"
" :return: The index of the material of the face it is running accross.\n"
" :rtype: int\n";
static PyObject * FEdgeSmooth_materialIndex( BPy_FEdgeSmooth *self ) {
return PyLong_FromLong( self->fes->frs_materialIndex() );
}
static char FEdgeSmooth_material___doc__[] =
".. method:: material()\n"
"\n"
" Returns the material of the face it is running accross.\n"
"\n"
" :return: The material of the face it is running accross.\n"
" :rtype: :class:`Material`\n";
PyObject * FEdgeSmooth_material( BPy_FEdgeSmooth *self ) {
static PyObject * FEdgeSmooth_material( BPy_FEdgeSmooth *self ) {
FrsMaterial m( self->fes->frs_material() );
return BPy_FrsMaterial_from_FrsMaterial(m);
}
PyObject * FEdgeSmooth_setNormal( BPy_FEdgeSmooth *self, PyObject *args ) {
static char FEdgeSmooth_setNormal___doc__[] =
".. method:: setNormal(iNormal)\n"
"\n"
" Sets the normal to the Face it is running accross.\n"
"\n"
" :arg iNormal: A three-dimensional vector.\n"
" :type iNormal: :class:`Mathutils.Vector`, list or tuple of 3 real numbers\n";
static PyObject * FEdgeSmooth_setNormal( BPy_FEdgeSmooth *self, PyObject *args ) {
PyObject *obj = 0;
if(!( PyArg_ParseTuple(args, "O", &obj) ))
@@ -134,7 +126,15 @@ PyObject * FEdgeSmooth_setNormal( BPy_FEdgeSmooth *self, PyObject *args ) {
Py_RETURN_NONE;
}
PyObject * FEdgeSmooth_setMaterialIndex( BPy_FEdgeSmooth *self, PyObject *args ) {
static char FEdgeSmooth_setMaterialIndex___doc__[] =
".. method:: setMaterialIndex(i)\n"
"\n"
" Sets the index of the material of the face it is running accross.\n"
"\n"
" :arg i: The index of the material of the face it is running accross.\n"
" :type i: int\n";
static PyObject * FEdgeSmooth_setMaterialIndex( BPy_FEdgeSmooth *self, PyObject *args ) {
unsigned int i;
if(!( PyArg_ParseTuple(args, "I", &i) ))
@@ -145,6 +145,59 @@ PyObject * FEdgeSmooth_setMaterialIndex( BPy_FEdgeSmooth *self, PyObject *args )
Py_RETURN_NONE;
}
/*----------------------FEdgeSmooth instance definitions ----------------------------*/
static PyMethodDef BPy_FEdgeSmooth_methods[] = {
{"normal", ( PyCFunction ) FEdgeSmooth_normal, METH_NOARGS, FEdgeSmooth_normal___doc__},
{"materialIndex", ( PyCFunction ) FEdgeSmooth_materialIndex, METH_NOARGS, FEdgeSmooth_materialIndex___doc__},
{"material", ( PyCFunction ) FEdgeSmooth_material, METH_NOARGS, FEdgeSmooth_material___doc__},
{"setNormal", ( PyCFunction ) FEdgeSmooth_setNormal, METH_VARARGS, FEdgeSmooth_setNormal___doc__},
{"setMaterialIndex", ( PyCFunction ) FEdgeSmooth_setMaterialIndex, METH_VARARGS, FEdgeSmooth_setMaterialIndex___doc__},
{NULL, NULL, 0, NULL}
};
/*-----------------------BPy_FEdgeSmooth type definition ------------------------------*/
PyTypeObject FEdgeSmooth_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
"FEdgeSmooth", /* tp_name */
sizeof(BPy_FEdgeSmooth), /* tp_basicsize */
0, /* tp_itemsize */
0, /* tp_dealloc */
0, /* tp_print */
0, /* tp_getattr */
0, /* tp_setattr */
0, /* tp_reserved */
0, /* 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 */
FEdgeSmooth___doc__, /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */
0, /* tp_weaklistoffset */
0, /* tp_iter */
0, /* tp_iternext */
BPy_FEdgeSmooth_methods, /* tp_methods */
0, /* tp_members */
0, /* tp_getset */
&FEdge_Type, /* tp_base */
0, /* tp_dict */
0, /* tp_descr_get */
0, /* tp_descr_set */
0, /* tp_dictoffset */
(initproc)FEdgeSmooth___init__, /* tp_init */
0, /* tp_alloc */
0, /* tp_new */
};
///////////////////////////////////////////////////////////////////////////////////////////
#ifdef __cplusplus