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

218
source/blender/freestyle/intern/python/BPy_ViewMap.cpp
View File

@@ -11,22 +11,137 @@ extern "C" {
///////////////////////////////////////////////////////////////////////////////////////////
/*--------------- Python API function prototypes for ViewMap instance -----------*/
static int ViewMap___init__(BPy_ViewMap *self, PyObject *args, PyObject *kwds);
static void ViewMap___dealloc__(BPy_ViewMap *self);
static PyObject * ViewMap___repr__(BPy_ViewMap* self);
//-------------------MODULE INITIALIZATION--------------------------------
int ViewMap_Init( PyObject *module )
{
if( module == NULL )
return -1;
static PyObject * ViewMap_getClosestViewEdge( BPy_ViewMap *self , PyObject *args);
static PyObject * ViewMap_getClosestFEdge( BPy_ViewMap *self , PyObject *args);
static PyObject * ViewMap_getScene3dBBox( BPy_ViewMap *self , PyObject *args);
static PyObject * ViewMap_setScene3dBBox( BPy_ViewMap *self , PyObject *args);
if( PyType_Ready( &ViewMap_Type ) < 0 )
return -1;
Py_INCREF( &ViewMap_Type );
PyModule_AddObject(module, "ViewMap", (PyObject *)&ViewMap_Type);
return 0;
}
//------------------------INSTANCE METHODS ----------------------------------
static char ViewMap___doc__[] =
"Class defining the ViewMap.\n"
"\n"
".. method:: __init__()\n"
"\n"
" Default constructor.\n";
static int ViewMap___init__(BPy_ViewMap *self, PyObject *args, PyObject *kwds)
{
self->vm = new ViewMap();
return 0;
}
static void ViewMap___dealloc__(BPy_ViewMap *self)
{
if( self->vm )
delete self->vm;
Py_TYPE(self)->tp_free((PyObject*)self);
}
static PyObject * ViewMap___repr__(BPy_ViewMap *self)
{
return PyUnicode_FromFormat("ViewMap - address: %p", self->vm );
}
static char ViewMap_getClosestViewEdge___doc__[] =
".. method:: getClosestViewEdge(x, y)\n"
"\n"
" Gets the ViewEdge nearest to the 2D point specified as arguments.\n"
"\n"
" :arg x: X coordinate of a 2D point.\n"
" :type x: float\n"
" :arg y: Y coordinate of a 2D point.\n"
" :type y: float\n"
" :return: The ViewEdge nearest to the specified 2D point.\n"
" :rtype: :class:`ViewEdge`\n";
static PyObject * ViewMap_getClosestViewEdge( BPy_ViewMap *self , PyObject *args) {
double x, y;
if(!( PyArg_ParseTuple(args, "dd", &x, &y) ))
return NULL;
ViewEdge *ve = const_cast<ViewEdge *>( self->vm->getClosestViewEdge(x,y) );
if( ve )
return BPy_ViewEdge_from_ViewEdge(*ve);
Py_RETURN_NONE;
}
static char ViewMap_getClosestFEdge___doc__[] =
".. method:: getClosestFEdge(x, y)\n"
"\n"
" Gets the FEdge nearest to the 2D point specified as arguments.\n"
"\n"
" :arg x: X coordinate of a 2D point.\n"
" :type x: float\n"
" :arg y: Y coordinate of a 2D point.\n"
" :type y: float\n"
" :return: The FEdge nearest to the specified 2D point.\n"
" :rtype: :class:`FEdge`\n";
static PyObject * ViewMap_getClosestFEdge( BPy_ViewMap *self , PyObject *args) {
double x, y;
if(!( PyArg_ParseTuple(args, "dd", &x, &y) ))
return NULL;
FEdge *fe = const_cast<FEdge *>( self->vm->getClosestFEdge(x,y) );
if( fe )
return Any_BPy_FEdge_from_FEdge(*fe);
Py_RETURN_NONE;
}
static char ViewMap_getScene3dBBox___doc__[] =
".. method:: getScene3dBBox()\n"
"\n"
" Returns the scene 3D bounding box.\n"
"\n"
" :return: The scene 3D bounding box.\n"
" :rtype: :class:`BBox`\n";
static PyObject * ViewMap_getScene3dBBox( BPy_ViewMap *self , PyObject *args) {
BBox<Vec3r> bb( self->vm->getScene3dBBox() );
return BPy_BBox_from_BBox( bb );
}
static char ViewMap_setScene3dBBox___doc__[] =
".. method:: setScene3dBBox(bbox)\n"
"\n"
" Sets the scene 3D bounding box.\n"
"\n"
" :arg bbox: The scene 3D bounding box.\n"
" :type bbox: :class:`BBox`\n";
static PyObject * ViewMap_setScene3dBBox( BPy_ViewMap *self , PyObject *args) {
PyObject *py_bb = 0;
if(!( PyArg_ParseTuple(args, "O!", &BBox_Type, &py_bb) ))
return NULL;
self->vm->setScene3dBBox(*( ((BPy_BBox *) py_bb)->bb ));
Py_RETURN_NONE;
}
// static ViewMap *getInstance ();
/*---------------------- BPy_ViewShape instance definitions ----------------------------*/
static PyMethodDef BPy_ViewMap_methods[] = {
{"getClosestViewEdge", ( PyCFunction ) ViewMap_getClosestViewEdge, METH_VARARGS, "(double x, double y) Gets the viewedge the nearest to the 2D position specified as argument "},
{"getClosestFEdge", ( PyCFunction ) ViewMap_getClosestFEdge, METH_VARARGS, "(double x, double y) Gets the Fedge the nearest to the 2D position specified as argument "},
{"getScene3dBBox", ( PyCFunction ) ViewMap_getScene3dBBox, METH_NOARGS, "() Returns the scene 3D bounding box. "},
{"setScene3dBBox", ( PyCFunction ) ViewMap_setScene3dBBox, METH_VARARGS, "(BBox bb) Sets the scene 3D bounding box."},
{"getClosestViewEdge", ( PyCFunction ) ViewMap_getClosestViewEdge, METH_VARARGS, ViewMap_getClosestViewEdge___doc__},
{"getClosestFEdge", ( PyCFunction ) ViewMap_getClosestFEdge, METH_VARARGS, ViewMap_getClosestFEdge___doc__},
{"getScene3dBBox", ( PyCFunction ) ViewMap_getScene3dBBox, METH_NOARGS, ViewMap_getScene3dBBox___doc__},
{"setScene3dBBox", ( PyCFunction ) ViewMap_setScene3dBBox, METH_VARARGS, ViewMap_setScene3dBBox___doc__},
{NULL, NULL, 0, NULL}
};
@@ -53,7 +168,7 @@ PyTypeObject ViewMap_Type = {
0, /* tp_setattro */
0, /* tp_as_buffer */
Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
"ViewMap objects", /* tp_doc */
ViewMap___doc__, /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */
@@ -73,83 +188,6 @@ PyTypeObject ViewMap_Type = {
PyType_GenericNew, /* tp_new */
};
//-------------------MODULE INITIALIZATION--------------------------------
int ViewMap_Init( PyObject *module )
{
if( module == NULL )
return -1;
if( PyType_Ready( &ViewMap_Type ) < 0 )
return -1;
Py_INCREF( &ViewMap_Type );
PyModule_AddObject(module, "ViewMap", (PyObject *)&ViewMap_Type);
return 0;
}
//------------------------INSTANCE METHODS ----------------------------------
int ViewMap___init__(BPy_ViewMap *self, PyObject *args, PyObject *kwds)
{
self->vm = new ViewMap();
return 0;
}
void ViewMap___dealloc__(BPy_ViewMap *self)
{
if( self->vm )
delete self->vm;
Py_TYPE(self)->tp_free((PyObject*)self);
}
PyObject * ViewMap___repr__(BPy_ViewMap *self)
{
return PyUnicode_FromFormat("ViewMap - address: %p", self->vm );
}
PyObject * ViewMap_getClosestViewEdge( BPy_ViewMap *self , PyObject *args) {
double x, y;
if(!( PyArg_ParseTuple(args, "dd", &x, &y) ))
return NULL;
ViewEdge *ve = const_cast<ViewEdge *>( self->vm->getClosestViewEdge(x,y) );
if( ve )
return BPy_ViewEdge_from_ViewEdge(*ve);
Py_RETURN_NONE;
}
PyObject * ViewMap_getClosestFEdge( BPy_ViewMap *self , PyObject *args) {
double x, y;
if(!( PyArg_ParseTuple(args, "dd", &x, &y) ))
return NULL;
FEdge *fe = const_cast<FEdge *>( self->vm->getClosestFEdge(x,y) );
if( fe )
return Any_BPy_FEdge_from_FEdge(*fe);
Py_RETURN_NONE;
}
PyObject * ViewMap_getScene3dBBox( BPy_ViewMap *self , PyObject *args) {
BBox<Vec3r> bb( self->vm->getScene3dBBox() );
return BPy_BBox_from_BBox( bb );
}
PyObject * ViewMap_setScene3dBBox( BPy_ViewMap *self , PyObject *args) {
PyObject *py_bb = 0;
if(!( PyArg_ParseTuple(args, "O!", &BBox_Type, &py_bb) ))
return NULL;
self->vm->setScene3dBBox(*( ((BPy_BBox *) py_bb)->bb ));
Py_RETURN_NONE;
}
///////////////////////////////////////////////////////////////////////////////////////////
#ifdef __cplusplus