blender-archive/source/blender/python/api2_2x/Camera.c

/* 
 *
 * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version. The Blender
 * Foundation also sells licenses for use in proprietary software under
 * the Blender License.  See http://www.blender.org/BL/ for information
 * about this.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * This is a new part of Blender.
 *
 * Contributor(s): Willian P. Germano
 *
 * ***** END GPL/BL DUAL LICENSE BLOCK *****
*/

#include <BKE_main.h>
#include <BKE_global.h>
#include <BKE_object.h>
#include <BKE_library.h>
#include <BLI_blenlib.h>

#include "Camera.h"


/*****************************************************************************/
/* Python Camera_Type structure definition:                                  */
/*****************************************************************************/
PyTypeObject Camera_Type =
{
  PyObject_HEAD_INIT(NULL)
  0,                             /* ob_size */
  "Blender Camera",              /* tp_name */
  sizeof (BPy_Camera),           /* tp_basicsize */
  0,                             /* tp_itemsize */
  /* methods */
  (destructor)Camera_dealloc,    /* tp_dealloc */
  0,                             /* tp_print */
	(getattrfunc)Camera_getAttr,   /* tp_getattr */
  (setattrfunc)Camera_setAttr,   /* tp_setattr */
  (cmpfunc)Camera_compare,       /* tp_compare */
  (reprfunc)Camera_repr,         /* tp_repr */
  0,                             /* tp_as_number */
  0,                             /* tp_as_sequence */
  0,                             /* tp_as_mapping */
  0,                             /* tp_as_hash */
  0,0,0,0,0,0,
  0,                             /* tp_doc */ 
  0,0,0,0,0,0,
  BPy_Camera_methods,            /* tp_methods */
  0,                             /* tp_members */
};

static PyObject *M_Camera_New(PyObject *self, PyObject *args, PyObject *kwords)
{
  char        *type_str = "persp"; /* "persp" is type 0, "ortho" is type 1 */
  char        *name_str = "CamData";
  static char *kwlist[] = {"type_str", "name_str", NULL};
  PyObject    *pycam; /* for Camera Data object wrapper in Python */
  Camera      *blcam; /* for actual Camera Data we create in Blender */
  char        buf[21];

  /* Parse the arguments passed in by the Python interpreter */
  if (!PyArg_ParseTupleAndKeywords(args, kwords, "|ss", kwlist,
                                   &type_str, &name_str))
  /* We expected string(s) (or nothing) as argument, but we didn't get that. */
    return EXPP_ReturnPyObjError (PyExc_AttributeError,
            "expected zero, one or two strings as arguments");

  blcam = add_camera(); /* first create the Camera Data in Blender */

  if (blcam) /* now create the wrapper obj in Python */
    pycam = Camera_CreatePyObject (blcam);
  else
    return EXPP_ReturnPyObjError (PyExc_RuntimeError,
                            "couldn't create Camera Data in Blender");

  /* let's return user count to zero, because ... */
  blcam->id.us = 0; /* ... add_camera() incref'ed it */
  /* XXX XXX Do this in other modules, too */

  if (pycam == NULL)
    return EXPP_ReturnPyObjError (PyExc_MemoryError,
                            "couldn't create Camera PyObject");

  if (strcmp (type_str, "persp") == 0) /* default, no need to set, so */
    /*blcam->type = (short)EXPP_CAM_TYPE_PERSP*/; /* we comment this line */
  else if (strcmp (type_str, "ortho") == 0)
    blcam->type = (short)EXPP_CAM_TYPE_ORTHO;
  else
    return EXPP_ReturnPyObjError (PyExc_AttributeError,
            "unknown camera type");

  if (strcmp (name_str, "CamData") == 0)
    return pycam;
  else { /* user gave us a name for the camera, use it */
    PyOS_snprintf (buf, sizeof(buf), "%s", name_str);
    rename_id (&blcam->id, buf); /* proper way in Blender */
  }

  return pycam;
}

static PyObject *M_Camera_Get(PyObject *self, PyObject *args)
{
  char   *name = NULL;
  Camera *cam_iter;

  if (!PyArg_ParseTuple(args, "|s", &name))
    return EXPP_ReturnPyObjError (PyExc_TypeError,
            "expected string argument (or nothing)");

  cam_iter = G.main->camera.first;

  if (name) { /* (name) - Search camera by name */

    PyObject *wanted_cam = NULL;

    while (cam_iter && !wanted_cam) {

      if (strcmp (name, cam_iter->id.name+2) == 0) {
        wanted_cam = Camera_CreatePyObject (cam_iter);
        break;
      }

      cam_iter = cam_iter->id.next;
    }

    if (!wanted_cam) { /* Requested camera doesn't exist */
      char error_msg[64];
      PyOS_snprintf(error_msg, sizeof(error_msg),
                      "Camera \"%s\" not found", name);
      return EXPP_ReturnPyObjError (PyExc_NameError, error_msg);
    }

    return wanted_cam;
  }

  else { /* () - return a list of wrappers for all cameras in the scene */
    int index = 0;
    PyObject *cam_pylist, *pyobj;

    cam_pylist = PyList_New (BLI_countlist (&(G.main->camera)));

    if (!cam_pylist)
      return PythonReturnErrorObject (PyExc_MemoryError,
              "couldn't create PyList");

    while (cam_iter) {
      pyobj = Camera_CreatePyObject (cam_iter);

      if (!pyobj)
        return PythonReturnErrorObject (PyExc_MemoryError,
                  "couldn't create Camera PyObject");

      PyList_SET_ITEM (cam_pylist, index, pyobj);

      cam_iter = cam_iter->id.next;
      index++;
    }

    return cam_pylist;
  }
}

PyObject *Camera_Init (void)
{
  PyObject  *submodule;

  Camera_Type.ob_type = &PyType_Type;

  submodule = Py_InitModule3("Blender.Camera",
                  M_Camera_methods, M_Camera_doc);

  return submodule;
}

/* Three Python Camera_Type helper functions needed by the Object module: */

PyObject *Camera_CreatePyObject (Camera *cam)
{
  BPy_Camera *pycam;

  pycam = (BPy_Camera *)PyObject_NEW (BPy_Camera, &Camera_Type);

  if (!pycam)
    return EXPP_ReturnPyObjError (PyExc_MemoryError,
            "couldn't create BPy_Camera PyObject");

  pycam->camera = cam;

  return (PyObject *)pycam;
}

int Camera_CheckPyObject (PyObject *pyobj)
{
  return (pyobj->ob_type == &Camera_Type);
}

Camera *Camera_FromPyObject (PyObject *pyobj)
{
  return ((BPy_Camera *)pyobj)->camera;
}

/*****************************************************************************/
/* Python BPy_Camera methods:                                                */
/*****************************************************************************/
static PyObject *Camera_getName(BPy_Camera *self)
{
  PyObject *attr = PyString_FromString(self->camera->id.name+2);

  if (attr) return attr;

  return EXPP_ReturnPyObjError (PyExc_RuntimeError,
                                   "couldn't get Camera.name attribute");
}

static PyObject *Camera_getType(BPy_Camera *self)
{
  PyObject *attr = PyInt_FromLong(self->camera->type);

  if (attr) return attr;

  return EXPP_ReturnPyObjError (PyExc_RuntimeError,
                                   "couldn't get Camera.type attribute");
}

static PyObject *Camera_getMode(BPy_Camera *self)
{
  PyObject *attr = PyInt_FromLong(self->camera->flag);

  if (attr) return attr;

  return EXPP_ReturnPyObjError (PyExc_RuntimeError,
                                   "couldn't get Camera.Mode attribute");
}

static PyObject *Camera_getLens(BPy_Camera *self)
{
  PyObject *attr = PyFloat_FromDouble(self->camera->lens);

  if (attr) return attr;

  return EXPP_ReturnPyObjError (PyExc_RuntimeError,
                                   "couldn't get Camera.lens attribute");
}

static PyObject *Camera_getClipStart(BPy_Camera *self)
{
  PyObject *attr = PyFloat_FromDouble(self->camera->clipsta);

  if (attr) return attr;

  return EXPP_ReturnPyObjError (PyExc_RuntimeError,
                                   "couldn't get Camera.clipStart attribute");
}

static PyObject *Camera_getClipEnd(BPy_Camera *self)
{
  PyObject *attr = PyFloat_FromDouble(self->camera->clipend);

  if (attr) return attr;

  return EXPP_ReturnPyObjError (PyExc_RuntimeError,
                                   "couldn't get Camera.clipEnd attribute");
}

static PyObject *Camera_getDrawSize(BPy_Camera *self)
{
  PyObject *attr = PyFloat_FromDouble(self->camera->drawsize);

  if (attr) return attr;

  return EXPP_ReturnPyObjError (PyExc_RuntimeError,
                                   "couldn't get Camera.drawSize attribute");
}

static PyObject *Camera_setName(BPy_Camera *self, PyObject *args)
{
  char *name;
  char buf[21];

  if (!PyArg_ParseTuple(args, "s", &name))
    return EXPP_ReturnPyObjError (PyExc_TypeError,
                                     "expected string argument");

  PyOS_snprintf(buf, sizeof(buf), "%s", name);

  rename_id(&self->camera->id, buf);

  Py_INCREF(Py_None);
  return Py_None;
}

static PyObject *Camera_setType(BPy_Camera *self, PyObject *args)
{
  char *type;

  if (!PyArg_ParseTuple(args, "s", &type))
    return EXPP_ReturnPyObjError (PyExc_TypeError,
                                     "expected string argument");

  if (strcmp (type, "persp") == 0)
    self->camera->type = (short)EXPP_CAM_TYPE_PERSP;
  else if (strcmp (type, "ortho") == 0)
    self->camera->type = (short)EXPP_CAM_TYPE_ORTHO;  
  else
    return EXPP_ReturnPyObjError (PyExc_AttributeError,
                                     "unknown camera type");

  Py_INCREF(Py_None);
  return Py_None;
}

/* This one is 'private'. It is not really a method, just a helper function for
 * when script writers use Camera.type = t instead of Camera.setType(t), since
 * in the first case t should be an int and in the second a string. So while
 * the method setType expects a string ('persp' or 'ortho') or an empty
 * argument, this function should receive an int (0 or 1). */

static PyObject *Camera_setIntType(BPy_Camera *self, PyObject *args)
{
  short value;

  if (!PyArg_ParseTuple(args, "h", &value))
    return EXPP_ReturnPyObjError (PyExc_TypeError,
                                     "expected int argument: 0 or 1");

  if (value == 0 || value == 1)
    self->camera->type = value;
  else
    return EXPP_ReturnPyObjError (PyExc_ValueError,
                                     "expected int argument: 0 or 1");

  Py_INCREF(Py_None);
  return Py_None;
}

static PyObject *Camera_setMode(BPy_Camera *self, PyObject *args)
{
  char *mode_str1 = NULL, *mode_str2 = NULL;
  short flag = 0;

  if (!PyArg_ParseTuple(args, "|ss", &mode_str1, &mode_str2))
    return EXPP_ReturnPyObjError (PyExc_AttributeError,
            "expected one or two strings as arguments");
  
  if (mode_str1 != NULL) {
    if (strcmp(mode_str1, "showLimits") == 0)
      flag |= (short)EXPP_CAM_MODE_SHOWLIMITS;
    else if (strcmp(mode_str1, "showMist") == 0)
      flag |= (short)EXPP_CAM_MODE_SHOWMIST;
    else
      return EXPP_ReturnPyObjError (PyExc_AttributeError,
                              "first argument is an unknown camera flag");

    if (mode_str2 != NULL) {
      if (strcmp(mode_str2, "showLimits") == 0)
        flag |= (short)EXPP_CAM_MODE_SHOWLIMITS;
      else if (strcmp(mode_str2, "showMist") == 0)
        flag |= (short)EXPP_CAM_MODE_SHOWMIST;
      else
        return EXPP_ReturnPyObjError (PyExc_AttributeError,
                              "second argument is an unknown camera flag");
    }
  }

  self->camera->flag = flag;

  Py_INCREF(Py_None);
  return Py_None;
}

/* Another helper function, for the same reason.
 * (See comment before Camera_setIntType above). */

static PyObject *Camera_setIntMode(BPy_Camera *self, PyObject *args)
{
  short value;

  if (!PyArg_ParseTuple(args, "h", &value))
    return EXPP_ReturnPyObjError (PyExc_TypeError,
                                     "expected int argument in [0,3]");

  if (value >= 0 && value <= 3)
    self->camera->flag = value;
  else
    return EXPP_ReturnPyObjError (PyExc_ValueError,
                                     "expected int argument in [0,3]");

  Py_INCREF(Py_None);
  return Py_None;
}

static PyObject *Camera_setLens(BPy_Camera *self, PyObject *args)
{
  float value;
  
  if (!PyArg_ParseTuple(args, "f", &value))
    return EXPP_ReturnPyObjError (PyExc_TypeError,
                                     "expected float argument");
 
  self->camera->lens = EXPP_ClampFloat (value,
                  EXPP_CAM_LENS_MIN, EXPP_CAM_LENS_MAX);
  
  Py_INCREF(Py_None);
  return Py_None;
}

static PyObject *Camera_setClipStart(BPy_Camera *self, PyObject *args)
{
  float value;
  
  if (!PyArg_ParseTuple(args, "f", &value))
    return EXPP_ReturnPyObjError (PyExc_TypeError,
                                     "expected float argument");

  self->camera->clipsta = EXPP_ClampFloat (value,
                  EXPP_CAM_CLIPSTART_MIN, EXPP_CAM_CLIPSTART_MAX);
  
  Py_INCREF(Py_None);
  return Py_None;
}

static PyObject *Camera_setClipEnd(BPy_Camera *self, PyObject *args)
{
  float value;
  
  if (!PyArg_ParseTuple(args, "f", &value))
    return EXPP_ReturnPyObjError (PyExc_TypeError,
                                     "expected float argument");

  self->camera->clipend = EXPP_ClampFloat (value,
                  EXPP_CAM_CLIPEND_MIN, EXPP_CAM_CLIPEND_MAX);

  Py_INCREF(Py_None);
  return Py_None;
}

static PyObject *Camera_setDrawSize(BPy_Camera *self, PyObject *args)
{
  float value;
  
  if (!PyArg_ParseTuple(args, "f", &value))
    return EXPP_ReturnPyObjError (PyExc_TypeError,
                                     "expected a float number as argument");

  self->camera->drawsize = EXPP_ClampFloat (value,
                  EXPP_CAM_DRAWSIZE_MIN, EXPP_CAM_DRAWSIZE_MAX);

  Py_INCREF(Py_None);
  return Py_None;
}

static void Camera_dealloc (BPy_Camera *self)
{
  PyObject_DEL (self);
}

static PyObject *Camera_getAttr (BPy_Camera *self, char *name)
{
  PyObject *attr = Py_None;

  if (strcmp(name, "name") == 0)
    attr = PyString_FromString(self->camera->id.name+2);
  else if (strcmp(name, "type") == 0)
    attr = PyInt_FromLong(self->camera->type);
  else if (strcmp(name, "mode") == 0)
    attr = PyInt_FromLong(self->camera->flag);
  else if (strcmp(name, "lens") == 0)
    attr = PyFloat_FromDouble(self->camera->lens);
  else if (strcmp(name, "clipStart") == 0)
    attr = PyFloat_FromDouble(self->camera->clipsta);
  else if (strcmp(name, "clipEnd") == 0)
    attr = PyFloat_FromDouble(self->camera->clipend);
  else if (strcmp(name, "drawSize") == 0)
    attr = PyFloat_FromDouble(self->camera->drawsize);

  else if (strcmp(name, "Types") == 0) {
    attr = Py_BuildValue("{s:h,s:h}", "persp", EXPP_CAM_TYPE_PERSP,
                                      "ortho", EXPP_CAM_TYPE_ORTHO);
  }

  else if (strcmp(name, "Modes") == 0) {
    attr = Py_BuildValue("{s:h,s:h}", "showLimits", EXPP_CAM_MODE_SHOWLIMITS,
                                  "showMist", EXPP_CAM_MODE_SHOWMIST);
  }

  else if (strcmp(name, "__members__") == 0) {
    attr = Py_BuildValue("[s,s,s,s,s,s,s,s,s]",
                    "name", "type", "mode", "lens", "clipStart",
                    "clipEnd", "drawSize", "Types", "Modes");
  }

  if (!attr)
    return EXPP_ReturnPyObjError (PyExc_MemoryError,
                      "couldn't create PyObject");

  if (attr != Py_None) return attr; /* member attribute found, return it */

  /* not an attribute, search the methods table */
  return Py_FindMethod(BPy_Camera_methods, (PyObject *)self, name);
}

static int Camera_setAttr (BPy_Camera *self, char *name, PyObject *value)
{
  PyObject *valtuple; 
  PyObject *error = NULL;

/* We're playing a trick on the Python API users here.  Even if they use
 * Camera.member = val instead of Camera.setMember(val), we end up using the
 * function anyway, since it already has error checking, clamps to the right
 * interval and updates the Blender Camera structure when necessary. */

/* First we put "value" in a tuple, because we want to pass it to functions
 * that only accept PyTuples. */
  valtuple = Py_BuildValue("(O)", value);

  if (!valtuple) /* everything OK with our PyObject? */
    return EXPP_ReturnIntError(PyExc_MemoryError,
                         "CameraSetAttr: couldn't create PyTuple");

/* Now we just compare "name" with all possible BPy_Camera member variables */
  if (strcmp (name, "name") == 0)
    error = Camera_setName (self, valtuple);
  else if (strcmp (name, "type") == 0)
    error = Camera_setIntType (self, valtuple); /* special case */
  else if (strcmp (name, "mode") == 0)
    error = Camera_setIntMode (self, valtuple); /* special case */
  else if (strcmp (name, "lens") == 0)
    error = Camera_setLens (self, valtuple);
  else if (strcmp (name, "clipStart") == 0)
    error = Camera_setClipStart (self, valtuple);
  else if (strcmp (name, "clipEnd") == 0)
    error = Camera_setClipEnd (self, valtuple);
  else if (strcmp (name, "drawSize") == 0)
    error = Camera_setDrawSize (self, valtuple);

  else { /* Error */
    Py_DECREF(valtuple);

    if ((strcmp (name, "Types") == 0) || /* user tried to change a */
        (strcmp (name, "Modes") == 0))   /* constant dict type ... */
      return EXPP_ReturnIntError (PyExc_AttributeError,
                   "constant dictionary -- cannot be changed");

    else /* ... or no member with the given name was found */
      return EXPP_ReturnIntError (PyExc_KeyError,
                   "attribute not found");
  }

/* valtuple won't be returned to the caller, so we need to DECREF it */
  Py_DECREF (valtuple);

  if (error != Py_None) return -1;

/* Py_None was incref'ed by the called Camera_set* function. We probably
 * don't need to decref Py_None (!), but since Python/C API manual tells us
 * to treat it like any other PyObject regarding ref counting ... */
  Py_DECREF (Py_None);
  return 0; /* normal exit */
}

static int Camera_compare (BPy_Camera *a, BPy_Camera *b)
{
  Camera *pa = a->camera, *pb = b->camera;
  return (pa == pb) ? 0:-1;
}

static PyObject *Camera_repr (BPy_Camera *self)
{
  return PyString_FromFormat("[Camera \"%s\"]", self->camera->id.name+2);
}