rna naming mainly for Scene/IK/KeyingSet's
[blender-staging.git] / source / blender / makesrna / intern / rna_scene_api.c
index f3cbb630df5a07b6b4cb94f64b95b443ae17aef6..498bd148508890d587bb9a4e63315c68c3d8d3db 100644 (file)
@@ -1,5 +1,5 @@
 /**
- * $Id: rna_object_api.c 21115 2009-06-23 19:17:59Z kazanbas $
+ * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  *
  * 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.
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  *
  * The Original Code is Copyright (C) 2009 Blender Foundation.
  * All rights reserved.
  *
  * 
- * Contributor(s): Blender Foundation
+ * Contributor(s): Joshua Leung, Arystanbek Dyussenov
  *
  * ***** END GPL LICENSE BLOCK *****
  */
 #include <stdio.h>
 
 #include "RNA_define.h"
-#include "RNA_types.h"
 
+#include "DNA_anim_types.h"
 #include "DNA_object_types.h"
 #include "DNA_scene_types.h"
+#include "BKE_utildefines.h"
 
 #ifdef RNA_RUNTIME
 
+#include "BKE_animsys.h"
+#include "BKE_depsgraph.h"
+#include "BKE_global.h"
+#include "BKE_image.h"
 #include "BKE_scene.h"
-#include "ED_object.h"
+#include "BKE_writeavi.h"
 
-static void rna_Scene_add_object(Scene *sce, ReportList *reports, Object *ob)
+
+
+static void rna_Scene_set_frame(Scene *scene, int frame, float subframe)
 {
-       Base *base= object_in_scene(ob, sce);
-       if (base) {
-               BKE_report(reports, RPT_ERROR, "Object is already in this scene.");
-               return;
-       }
-       base= scene_add_base(sce, ob);
-       ob->id.us++;
+       scene->r.cfra= frame;
+       scene->r.subframe= subframe;
+       
+       CLAMP(scene->r.cfra, MINAFRAME, MAXFRAME);
+       scene_update_for_newframe(G.main, scene, (1<<20) - 1);
 
-       /* this is similar to what object_add_type and add_object do */
-       ob->lay= base->lay= sce->lay;
-       ob->recalc |= OB_RECALC;
+       WM_main_add_notifier(NC_SCENE|ND_FRAME, scene);
+}
 
-       DAG_scene_sort(sce);
+static void rna_Scene_update_tagged(Scene *scene)
+{
+       scene_update_tagged(G.main, scene);
 }
 
-static void rna_Scene_remove_object(Scene *sce, ReportList *reports, Object *ob)
+static KeyingSet *rna_Scene_add_keying_set(Scene *sce, ReportList *reports, 
+               char name[], int absolute, int insertkey_needed, int insertkey_visual)
 {
-       Base *base= object_in_scene(ob, sce);
-       if (!base) {
-               BKE_report(reports, RPT_ERROR, "Object is not in this scene.");
-               return;
+       KeyingSet *ks= NULL;
+       short flag=0, keyingflag=0;
+       
+       /* validate flags */
+       if (absolute)
+               flag |= KEYINGSET_ABSOLUTE;
+       if (insertkey_needed)
+               keyingflag |= INSERTKEY_NEEDED;
+       if (insertkey_visual)
+               keyingflag |= INSERTKEY_MATRIX;
+               
+       /* call the API func, and set the active keyingset index */
+       ks= BKE_keyingset_add(&sce->keyingsets, name, flag, keyingflag);
+       
+       if (ks) {
+               sce->active_keyingset= BLI_countlist(&sce->keyingsets);
+               return ks;
+       }
+       else {
+               BKE_report(reports, RPT_ERROR, "Keying Set could not be added.");
+               return NULL;
        }
-       /* as long as ED_base_object_free_and_unlink calls free_libblock_us, we don't have to decrement ob->id.us */
-       ED_base_object_free_and_unlink(sce, base);
 }
 
-static void rna_Scene_set_frame(Scene *sce, bContext *C, int frame)
+static void rna_SceneRender_get_frame_path(RenderData *rd, int frame, char *name)
 {
-       sce->r.cfra= frame;
-       CLAMP(sce->r.cfra, MINAFRAME, MAXFRAME);
-       scene_update_for_newframe(sce, (1<<20) - 1);
-
-       WM_event_add_notifier(C, NC_SCENE|ND_FRAME, sce);
+       if(BKE_imtype_is_movie(rd->imtype))
+               BKE_makeanimstring(name, rd);
+       else
+               BKE_makepicstring(name, rd->pic, (frame==INT_MIN) ? rd->cfra : frame, rd->imtype, rd->scemode & R_EXTENSION);
 }
 
 #else
@@ -84,23 +105,42 @@ void RNA_api_scene(StructRNA *srna)
        FunctionRNA *func;
        PropertyRNA *parm;
 
-       func= RNA_def_function(srna, "add_object", "rna_Scene_add_object");
-       RNA_def_function_ui_description(func, "Add object to scene.");
-       RNA_def_function_flag(func, FUNC_USE_REPORTS);
-       parm= RNA_def_pointer(func, "object", "Object", "", "Object to add to scene.");
+       func= RNA_def_function(srna, "set_frame", "rna_Scene_set_frame");
+       RNA_def_function_ui_description(func, "Set scene frame updating all objects immediately.");
+       parm= RNA_def_int(func, "frame", 0, MINAFRAME, MAXFRAME, "", "Frame number to set.", MINAFRAME, MAXFRAME);
        RNA_def_property_flag(parm, PROP_REQUIRED);
+       parm= RNA_def_float(func, "subframe", 0.0, 0.0, 1.0, "", "Sub-frame time, between 0.0 and 1.0", 0.0, 1.0);
 
-       func= RNA_def_function(srna, "remove_object", "rna_Scene_remove_object");
-       RNA_def_function_ui_description(func, "Remove object from scene.");
+       func= RNA_def_function(srna, "update", "rna_Scene_update_tagged");
+       RNA_def_function_ui_description(func, "Update data tagged to be updated from previous access to data or operators.");
+
+       /* Add Keying Set */
+       func= RNA_def_function(srna, "add_keying_set", "rna_Scene_add_keying_set");
+       RNA_def_function_ui_description(func, "Add a new Keying Set to Scene.");
        RNA_def_function_flag(func, FUNC_USE_REPORTS);
-       parm= RNA_def_pointer(func, "object", "Object", "", "Object to remove from scene.");
-       RNA_def_property_flag(parm, PROP_REQUIRED);
+       /* returns the new KeyingSet */
+       parm= RNA_def_pointer(func, "keyingset", "KeyingSet", "", "Newly created Keying Set.");
+       RNA_def_function_return(func, parm);
+       /* name */
+       RNA_def_string(func, "name", "KeyingSet", 64, "Name", "Name of Keying Set");
+       /* flags */
+       RNA_def_boolean(func, "absolute", 1, "Absolute", "Keying Set defines specific paths/settings to be keyframed (i.e. is not reliant on context info)");
+       /* keying flags */
+       RNA_def_boolean(func, "use_insertkey_needed", 0, "Insert Keyframes - Only Needed", "Only insert keyframes where they're needed in the relevant F-Curves.");
+       RNA_def_boolean(func, "use_insertkey_visual", 0, "Insert Keyframes - Visual", "Insert keyframes based on 'visual transforms'.");
+}
 
-       func= RNA_def_function(srna, "set_frame", "rna_Scene_set_frame");
-       RNA_def_function_flag(func, FUNC_USE_CONTEXT);
+void RNA_api_scene_render(StructRNA *srna)
+{
+       FunctionRNA *func;
+       PropertyRNA *parm;
+
+       func= RNA_def_function(srna, "frame_path", "rna_SceneRender_get_frame_path");
        RNA_def_function_ui_description(func, "Set scene frame updating all objects immediately.");
-       parm= RNA_def_int(func, "frame", 0, MINAFRAME, MAXFRAME, "", "Frame number to set.", MINAFRAME, MAXFRAME);
-       RNA_def_property_flag(parm, PROP_REQUIRED);
+       parm= RNA_def_int(func, "frame", INT_MIN, INT_MIN, INT_MAX, "", "Frame number to use, if unset the current frame will be used.", MINAFRAME, MAXFRAME);
+       parm= RNA_def_string(func, "name", "", FILE_MAX, "File Name", "the resulting filename from the scenes render settings.");
+       RNA_def_property_flag(parm, PROP_THICK_WRAP); /* needed for string return value */
+       RNA_def_function_output(func, parm);
 }
 
 #endif