archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity

document bpy.types.Struct methods C methods, currently only keyframe_delete() and keyframe_insert() have useful docstrings.

Browse Source 
http://www.blender.org/documentation/250PythonDoc/bpy.types.Struct.html?highlight=bpy.types.struct#bpy.types.Struct.keyframe_insert
This commit is contained in:
Campbell Barton
2010-04-05 22:37:09 +00:00
parent a9fa23c624
commit e302f33be7
2 changed files with 48 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
source/blender/python/intern/bpy_rna.c
View File

@@ -1711,6 +1711,18 @@ int pyrna_struct_keyframe_parse(PointerRNA *ptr, PyObject *args, char *error_pre
return 0; /* success */
}
static char pyrna_struct_keyframe_insert_doc[] =
".. function:: keyframe_insert(path, index=-1, frame=bpy.context.scene.frame_current)\n"
"\n"
" Returns a boolean, True if the keyframe is set.\n"
"\n"
" :arg path: path to the property to key, analogous to the fcurve's data path.\n"
" :type path: string\n"
" :arg index: array index of the property to key. Defaults to -1 which will key all indicies or a single channel if the property is not an array.\n"
" :type index: int\n"
" :arg frame: The frame on which the keyframe is inserted, defaulting to the current frame.\n"
" :type frame: float";
static PyObject *pyrna_struct_keyframe_insert(BPy_StructRNA *self, PyObject *args)
{
PyObject *result;
@@ -1728,6 +1740,18 @@ static PyObject *pyrna_struct_keyframe_insert(BPy_StructRNA *self, PyObject *arg
return result;
}
static char pyrna_struct_keyframe_delete_doc[] =
".. function:: keyframe_delete(path, index=-1, frame=bpy.context.scene.frame_current)\n"
"\n"
" Returns a boolean, True if the keyframe is removed.\n"
"\n"
" :arg path: path to the property to remove a key, analogous to the fcurve's data path.\n"
" :type path: string\n"
" :arg index: array index of the property to remove a key. Defaults to -1 removing all indicies or a single channel if the property is not an array.\n"
" :type index: int\n"
" :arg frame: The frame on which the keyframe is deleted, defaulting to the current frame.\n"
" :type frame: float";
static PyObject *pyrna_struct_keyframe_delete(BPy_StructRNA *self, PyObject *args)
{
PyObject *result;
@@ -2714,8 +2738,8 @@ static struct PyMethodDef pyrna_struct_methods[] = {
{"as_pointer", (PyCFunction)pyrna_struct_as_pointer, METH_NOARGS, NULL},
/* maybe this become and ID function */
{"keyframe_insert", (PyCFunction)pyrna_struct_keyframe_insert, METH_VARARGS, NULL},
{"keyframe_delete", (PyCFunction)pyrna_struct_keyframe_delete, METH_VARARGS, NULL},
{"keyframe_insert", (PyCFunction)pyrna_struct_keyframe_insert, METH_VARARGS, pyrna_struct_keyframe_insert_doc},
{"keyframe_delete", (PyCFunction)pyrna_struct_keyframe_delete, METH_VARARGS, pyrna_struct_keyframe_delete_doc},
{"driver_add", (PyCFunction)pyrna_struct_driver_add, METH_VARARGS, NULL},
{"is_property_set", (PyCFunction)pyrna_struct_is_property_set, METH_VARARGS, NULL},
{"is_property_hidden", (PyCFunction)pyrna_struct_is_property_hidden, METH_VARARGS, NULL},