path: root/source/blender/python/api2_2x/Armature.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): Jordi Rovira i Bonet
 *
 * ***** END GPL/BL DUAL LICENSE BLOCK *****
 */

#include "Armature.h"
#include "Bone.h"

/*****************************************************************************/
/* Function:              M_Armature_New                                     */
/* Python equivalent:     Blender.Armature.New                               */
/*****************************************************************************/
static PyObject *M_Armature_New(PyObject *self, PyObject *args,
                                PyObject *keywords)
{
  char        *type_str = "Armature";
  char        *name_str = "ArmatureData";
  static char *kwlist[] = {"type_str", "name_str", NULL};
  BPy_Armature  *py_armature; /* for Armature Data object wrapper in Python */
  bArmature   *bl_armature; /* for actual Armature Data we create in Blender */
  char        buf[21];

  if (!PyArg_ParseTupleAndKeywords(args, keywords, "|ss", kwlist,
           &type_str, &name_str))
    return (EXPP_ReturnPyObjError (PyExc_AttributeError,
           "expected string(s) or empty argument"));

  bl_armature = add_armature(); /* first create in Blender */
  if (bl_armature) /* now create the wrapper obj in Python */
    py_armature = (BPy_Armature *)PyObject_NEW(BPy_Armature, &Armature_Type);
  else
    return (EXPP_ReturnPyObjError (PyExc_RuntimeError,
           "couldn't create Armature Data in Blender"));

  if (py_armature == NULL)
    return (EXPP_ReturnPyObjError (PyExc_MemoryError,
           "couldn't create Armature Data object"));

  /* link Python armature wrapper with Blender Armature: */
  py_armature->armature = bl_armature;

  if (strcmp(name_str, "ArmatureData") == 0)
    return (PyObject *)py_armature;
  else { /* user gave us a name for the armature, use it */
    PyOS_snprintf(buf, sizeof(buf), "%s", name_str);
    rename_id(&bl_armature->id, buf);
  }

  return (PyObject *)py_armature;
}

/*****************************************************************************/
/* Function:              M_Armature_Get                                     */
/* Python equivalent:     Blender.Armature.Get                               */
/*****************************************************************************/
static PyObject *M_Armature_Get(PyObject *self, PyObject *args)
{
  char   *name = NULL;
  bArmature   *armature_iter;
  BPy_Armature *wanted_armature;

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

  armature_iter = G.main->armature.first;
  
  /* Use the name to search for the armature requested. */

  if (name) { /* (name) - Search armature by name */
    wanted_armature = NULL;
    
    while ((armature_iter) && (wanted_armature == NULL)) {
      
      if (strcmp (name, armature_iter->id.name+2) == 0) {
  wanted_armature = (BPy_Armature *)PyObject_NEW(BPy_Armature, &Armature_Type);
  if (wanted_armature) wanted_armature->armature = armature_iter;
      }
      
      armature_iter = armature_iter->id.next;
    }

    if (wanted_armature == NULL) {/* Requested Armature doesn't exist */
      char error_msg[64];
      PyOS_snprintf(error_msg, sizeof(error_msg),
        "Armature \"%s\" not found", name);
      return (EXPP_ReturnPyObjError (PyExc_NameError, error_msg));
    }

    return (PyObject*)wanted_armature;
  }
  
  else
    {
      /* Return a list of with armatures in the scene */
      int index = 0;
      PyObject *armlist, *pyobj;

      armlist = PyList_New (BLI_countlist (&(G.main->armature)));

      if (armlist == NULL)
        return (PythonReturnErrorObject (PyExc_MemoryError,
                "couldn't create PyList"));

      while (armature_iter) {
        pyobj = Armature_CreatePyObject (armature_iter);

        if (!pyobj)
          return (PythonReturnErrorObject (PyExc_MemoryError,
                    "couldn't create PyString"));
  
        PyList_SET_ITEM (armlist, index, pyobj);

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

      return (armlist);
    }

}

/*****************************************************************************/
/* Function:              Armature_Init                                      */
/*****************************************************************************/
PyObject *Armature_Init (void)
{
  PyObject  *submodule;
  PyObject  *dict;

  Armature_Type.ob_type = &PyType_Type;

  submodule = Py_InitModule3("Blender.Armature",
                             M_Armature_methods, M_Armature_doc);

  /* Add the Bone submodule to this module */
  dict = PyModule_GetDict (submodule);
  PyDict_SetItemString (dict, "Bone", Bone_Init());

  return (submodule);
}

/*****************************************************************************/
/* Python BPy_Armature methods:                                              */
/*****************************************************************************/
static PyObject *Armature_getName(BPy_Armature *self)
{
  PyObject *attr = PyString_FromString(self->armature->id.name+2);

  if (attr) return attr;

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


/** Create and return a list of the root bones for this armature. */
static PyObject *Armature_getBones(BPy_Armature *self)
{
  int totbones = 0;
  PyObject *listbones = NULL;
  Bone* current = NULL; 
  int i;

  /* Count the number of bones to create the list */
  current = self->armature->bonebase.first;
  for (;current; current=current->next) totbones++;

  /* Create a list with a bone wrapper for each bone */
  current = self->armature->bonebase.first;
  listbones = PyList_New(totbones);
  for (i=0; i<totbones; i++) {
    /* Wrap and set to corresponding element of the list. */
    PyList_SetItem(listbones, i, Bone_CreatePyObject(current) );
    current = current->next;
  }

  return listbones;
}


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

  if (!PyArg_ParseTuple(args, "s", &name))
    return (EXPP_ReturnPyObjError (PyExc_AttributeError,
           "expected string argument"));
  
  PyOS_snprintf(buf, sizeof(buf), "%s", name);

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

  Py_INCREF(Py_None);
  return Py_None;
}

/*
  static PyObject *Armature_setBones(BPy_Armature *self, PyObject *args)
  {
  // TODO: Implement me!
  printf("ERROR: Armature_setBones NOT implemented yet!\n");
  Py_INCREF(Py_None);
  return Py_None;
  
  }
*/

/*****************************************************************************/
/* Function:    Armature_dealloc                                             */
/* Description: This is a callback function for the BPy_Armature type. It is */
/*              the destructor function.                                     */
/*****************************************************************************/
static void Armature_dealloc (BPy_Armature *self)
{
  PyObject_DEL (self);
}

/*****************************************************************************/
/* Function:    Armature_getAttr                                             */
/* Description: This is a callback function for the BPy_Armature type. It is */
/*              the function that accesses BPy_Armature member variables and */
/*              methods.                                                     */
/*****************************************************************************/
static PyObject* Armature_getAttr (BPy_Armature *self, char *name)
{
  PyObject *attr = Py_None;

  if (strcmp(name, "name") == 0)
    attr = Armature_getName(self);
  if (strcmp(name, "bones") == 0)
    attr = Armature_getBones(self);
  else if (strcmp(name, "__members__") == 0) {
    /* 2 entries */
    attr = Py_BuildValue("[s,s]",
       "name", "bones");
  }

  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_Armature_methods, (PyObject *)self, name);
}

/*****************************************************************************/
/* Function:    Armature_setAttr                                             */
/* Description: This is a callback function for the BPy_Armature type. It is */
/*              the function that changes Armature Data members values. If   */
/*              this data is linked to a Blender Armature, it also gets      */
/*              updated.                                                     */
/*****************************************************************************/
static int Armature_setAttr (BPy_Armature *self, char *name, PyObject *value)
{
  PyObject *valtuple; 
  PyObject *error = NULL;

  valtuple = Py_BuildValue("(O)", value); /*the set* functions expect a tuple*/

  if (!valtuple)
    return EXPP_ReturnIntError(PyExc_MemoryError,
             "ArmatureSetAttr: couldn't create tuple");

  if (strcmp (name, "name") == 0)
    error = Armature_setName (self, valtuple);
  /*  if (strcmp (name, "bones") == 0)
      error = Armature_setBones (self, valtuple);*/
  else { /* Error */
    Py_DECREF(valtuple);
  
    /* ... member with the given name was found */
    return (EXPP_ReturnIntError (PyExc_KeyError,
         "attribute not found"));
  }

  Py_DECREF(valtuple);
  
  if (error != Py_None) return -1;

  Py_DECREF(Py_None); /* was incref'ed by the called Armature_set* function */
  return 0; /* normal exit */
}

/*****************************************************************************/
/* Function:    Armature_repr                                                */
/* Description: This is a callback function for the BPy_Armature type. It    */
/*              builds a meaninful string to represent armature objects.     */
/*****************************************************************************/
static PyObject *Armature_repr (BPy_Armature *self)
{
  return PyString_FromFormat("[Armature \"%s\"]", self->armature->id.name+2);
}

/*****************************************************************************/
/* Function:    Armature_compare                                             */
/* Description: This is a callback function for the BPy_Armature type. It    */
/*              compares the two armatures: translate comparison to the      */
/*              C pointers.                                                  */
/*****************************************************************************/
static int Armature_compare (BPy_Armature *a, BPy_Armature *b)
{
  bArmature *pa = a->armature, *pb = b->armature;
  return (pa == pb) ? 0:-1;
}

/*****************************************************************************/
/* Function:    Armature_CreatePyObject                                      */
/* Description: This function will create a new BlenArmature from an         */
/*              existing Armature structure.                                 */
/*****************************************************************************/
PyObject* Armature_CreatePyObject (struct bArmature *obj)
{
  BPy_Armature    * blen_armature;

  blen_armature = (BPy_Armature*)PyObject_NEW (BPy_Armature, &Armature_Type);

  if (blen_armature == NULL)
    {
      return (NULL);
    }
  blen_armature->armature = obj;
  return ((PyObject*)blen_armature);
}

/*****************************************************************************/
/* Function:    Armature_CheckPyObject                                       */
/* Description: This function returns true when the given PyObject is of the */
/*              type Armature. Otherwise it will return false.               */
/*****************************************************************************/
int Armature_CheckPyObject (PyObject *py_obj)
{
  return (py_obj->ob_type == &Armature_Type);
}

/*****************************************************************************/
/* Function:    Armature_FromPyObject                                        */
/* Description: This function returns the Blender armature from the given    */
/*              PyObject.                                                    */
/*****************************************************************************/
struct bArmature* Armature_FromPyObject (PyObject *py_obj)
{
  BPy_Armature    * blen_obj;

  blen_obj = (BPy_Armature*)py_obj;
  return (blen_obj->armature);
}