diff options
author | Willian Padovani Germano <wpgermano@gmail.com> | 2003-06-24 11:21:17 +0400 |
---|---|---|
committer | Willian Padovani Germano <wpgermano@gmail.com> | 2003-06-24 11:21:17 +0400 |
commit | 06ee04fb05ff58e6e0a781b64100825ba7358f19 (patch) | |
tree | c90b1415ebb106090c6f94b4ee782146245bc67d /source/blender/python/api2_2x/Camera.h | |
parent | a0ea4df1ba0367657ba4e093ca0d1288d6258ba4 (diff) |
* Added more doc files for epydoc and a test for the camera module.
* Moved public declarations in camera and lamp to a new file: bpy_types.h.
* Fixed minor bugs in material, rgbTuple and Lamp + other minor changes.
* Made part of the changes to conform to decided naming conventions.
Diffstat (limited to 'source/blender/python/api2_2x/Camera.h')
-rw-r--r-- | source/blender/python/api2_2x/Camera.h | 149 |
1 files changed, 134 insertions, 15 deletions
diff --git a/source/blender/python/api2_2x/Camera.h b/source/blender/python/api2_2x/Camera.h index 26e7fdfb889..d2257f6d28b 100644 --- a/source/blender/python/api2_2x/Camera.h +++ b/source/blender/python/api2_2x/Camera.h @@ -36,30 +36,149 @@ #include <DNA_camera_types.h> #include "constant.h" #include "gen_utils.h" +#include "modules.h" +#include "bpy_types.h" /* where the BPy_Camera struct is declared */ -/* The Camera PyType Object defined in Camera.c */ -extern PyTypeObject Camera_Type; +/*****************************************************************************/ +/* Python BPy_Camera defaults: */ +/*****************************************************************************/ + +/* Camera types */ + +#define EXPP_CAM_TYPE_PERSP 0 +#define EXPP_CAM_TYPE_ORTHO 1 + +/* Camera mode flags */ + +#define EXPP_CAM_MODE_SHOWLIMITS 1 +#define EXPP_CAM_MODE_SHOWMIST 2 + +/* Camera MIN, MAX values */ + +#define EXPP_CAM_LENS_MIN 1.0 +#define EXPP_CAM_LENS_MAX 250.0 +#define EXPP_CAM_CLIPSTART_MIN 0.0 +#define EXPP_CAM_CLIPSTART_MAX 100.0 +#define EXPP_CAM_CLIPEND_MIN 1.0 +#define EXPP_CAM_CLIPEND_MAX 5000.0 +#define EXPP_CAM_DRAWSIZE_MIN 0.1 +#define EXPP_CAM_DRAWSIZE_MAX 10.0 + +/*****************************************************************************/ +/* Python API function prototypes for the Camera module. */ +/*****************************************************************************/ +static PyObject *M_Camera_New (PyObject *self, PyObject *args, + PyObject *keywords); +static PyObject *M_Camera_Get (PyObject *self, PyObject *args); + +/*****************************************************************************/ +/* The following string definitions are used for documentation strings. */ +/* In Python these will be written to the console when doing a */ +/* Blender.Camera.__doc__ */ +/*****************************************************************************/ +static char M_Camera_doc[] = +"The Blender Camera module\n\ +\n\ +This module provides access to **Camera Data** objects in Blender\n\ +\n\ +Example::\n\ +\n\ + from Blender import Camera, Object, Scene\n\ + c = Camera.New('ortho') # create new ortho camera data\n\ + c.lens = 35.0 # set lens value\n\ + cur = Scene.getCurrent() # get current Scene\n\ + ob = Object.New('Camera') # make camera object\n\ + ob.link(c) # link camera data with this object\n\ + cur.link(ob) # link object into scene\n\ + cur.setCurrentCamera(ob) # make this camera the active"; + +static char M_Camera_New_doc[] = +"Camera.New (type = 'persp', name = 'CamData'):\n\ + Return a new Camera Data object with the given type and name."; -#define BPy_Camera_Check(v) \ - ((v)->ob_type == &Camera_Type) /* for type checking */ +static char M_Camera_Get_doc[] = +"Camera.Get (name = None):\n\ + Return the camera data with the given 'name', None if not found, or\n\ + Return a list with all Camera Data objects in the current scene,\n\ + if no argument was given."; /*****************************************************************************/ -/* Python BPy_Camera structure definition: */ +/* Python method structure definition for Blender.Camera module: */ /*****************************************************************************/ -typedef struct { - PyObject_HEAD - Camera *camera; +struct PyMethodDef M_Camera_methods[] = { + {"New",(PyCFunction)M_Camera_New, METH_VARARGS|METH_KEYWORDS, + M_Camera_New_doc}, + {"Get", M_Camera_Get, METH_VARARGS, M_Camera_Get_doc}, + {"get", M_Camera_Get, METH_VARARGS, M_Camera_Get_doc}, + {NULL, NULL, 0, NULL} +}; -} BPy_Camera; +/*****************************************************************************/ +/* Python BPy_Camera methods declarations: */ +/*****************************************************************************/ +static PyObject *Camera_getName(BPy_Camera *self); +static PyObject *Camera_getType(BPy_Camera *self); +static PyObject *Camera_getMode(BPy_Camera *self); +static PyObject *Camera_getLens(BPy_Camera *self); +static PyObject *Camera_getClipStart(BPy_Camera *self); +static PyObject *Camera_getClipEnd(BPy_Camera *self); +static PyObject *Camera_getDrawSize(BPy_Camera *self); +static PyObject *Camera_setName(BPy_Camera *self, PyObject *args); +static PyObject *Camera_setType(BPy_Camera *self, PyObject *args); +static PyObject *Camera_setIntType(BPy_Camera *self, PyObject *args); +static PyObject *Camera_setMode(BPy_Camera *self, PyObject *args); +static PyObject *Camera_setIntMode(BPy_Camera *self, PyObject *args); +static PyObject *Camera_setLens(BPy_Camera *self, PyObject *args); +static PyObject *Camera_setClipStart(BPy_Camera *self, PyObject *args); +static PyObject *Camera_setClipEnd(BPy_Camera *self, PyObject *args); +static PyObject *Camera_setDrawSize(BPy_Camera *self, PyObject *args); + +/*****************************************************************************/ +/* Python BPy_Camera methods table: */ +/*****************************************************************************/ +static PyMethodDef BPy_Camera_methods[] = { + /* name, method, flags, doc */ + {"getName", (PyCFunction)Camera_getName, METH_NOARGS, + "() - Return Camera Data name"}, + {"getType", (PyCFunction)Camera_getType, METH_NOARGS, + "() - Return Camera type - 'persp':0, 'ortho':1"}, + {"getMode", (PyCFunction)Camera_getMode, METH_NOARGS, + "() - Return Camera mode flags (or'ed value) -\n" + " 'showLimits':1, 'showMist':2"}, + {"getLens", (PyCFunction)Camera_getLens, METH_NOARGS, + "() - Return Camera lens value"}, + {"getClipStart", (PyCFunction)Camera_getClipStart, METH_NOARGS, + "() - Return Camera clip start value"}, + {"getClipEnd", (PyCFunction)Camera_getClipEnd, METH_NOARGS, + "() - Return Camera clip end value"}, + {"getDrawSize", (PyCFunction)Camera_getDrawSize, METH_NOARGS, + "() - Return Camera draw size value"}, + {"setName", (PyCFunction)Camera_setName, METH_VARARGS, + "(s) - Set Camera Data name"}, + {"setType", (PyCFunction)Camera_setType, METH_VARARGS, + "(s) - Set Camera type, which can be 'persp' or 'ortho'"}, + {"setMode", (PyCFunction)Camera_setMode, METH_VARARGS, + "(<s<,s>>) - Set Camera mode flag(s): 'showLimits' and 'showMist'"}, + {"setLens", (PyCFunction)Camera_setLens, METH_VARARGS, + "(f) - Set Camera lens value"}, + {"setClipStart", (PyCFunction)Camera_setClipStart, METH_VARARGS, + "(f) - Set Camera clip start value"}, + {"setClipEnd", (PyCFunction)Camera_setClipEnd, METH_VARARGS, + "(f) - Set Camera clip end value"}, + {"setDrawSize", (PyCFunction)Camera_setDrawSize, METH_VARARGS, + "(f) - Set Camera draw size value"}, + {0} +}; /*****************************************************************************/ -/* Python Camera_Type helper functions needed by Blender (the Init function) */ -/* and Object modules. */ +/* Python Camera_Type callback function prototypes: */ /*****************************************************************************/ -PyObject *M_Camera_Init (void); -PyObject *Camera_CreatePyObject (Camera *cam); -Camera *Camera_FromPyObject (PyObject *pyobj); -int Camera_CheckPyObject (PyObject *pyobj); +static void Camera_DeAlloc (BPy_Camera *self); +static int Camera_Print (BPy_Camera *self, FILE *fp, int flags); +static int Camera_SetAttr (BPy_Camera *self, char *name, PyObject *v); +static int Camera_Compare (BPy_Camera *a, BPy_Camera *b); +static PyObject *Camera_GetAttr (BPy_Camera *self, char *name); +static PyObject *Camera_Repr (BPy_Camera *self); #endif /* EXPP_CAMERA_H */ |