source/blender/makesrna/intern/rna_animation_api.c

   1 /*
   2  * ***** BEGIN GPL LICENSE BLOCK *****
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software Foundation,
  16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  *
  18  * The Original Code is Copyright (C) 2009 Blender Foundation.
  19  * All rights reserved.
  20  *
  21  *
  22  * Contributor(s): Joshua Leung
  23  *
  24  * ***** END GPL LICENSE BLOCK *****
  25  */
  26
  27 /** \file blender/makesrna/intern/rna_animation_api.c
  28  *  \ingroup RNA
  29  */
  30
  31
  32 #include <stdlib.h>
  33 #include <stdio.h>
  34
  35 #include "RNA_define.h"
  36 #include "RNA_enum_types.h"
  37
  38 #include "DNA_anim_types.h"
  39 #include "DNA_object_types.h"
  40 #include "DNA_scene_types.h"
  41
  42
  43 #ifdef RNA_RUNTIME
  44
  45 #include "BKE_context.h"
  46 #include "BKE_report.h"
  47
  48 #include "ED_keyframing.h"
  49
  50 static void rna_KeyingSet_context_refresh(KeyingSet *ks, bContext *C, ReportList *reports)
  51 {
  52         // TODO: enable access to providing a list of overrides (dsources)?
  53         int success = ANIM_validate_keyingset(C, NULL, ks);
  54
  55         if (success != 0) {
  56                 switch (success) {
  57                         case MODIFYKEY_INVALID_CONTEXT:
  58                                 BKE_report(reports, RPT_ERROR, "Invalid context for Keying Set");
  59                                 break;
  60
  61                         case MODIFYKEY_MISSING_TYPEINFO:
  62                                 BKE_report(reports, RPT_ERROR, "Incomplete built-in Keying Set. Appears to be missing type info");
  63                                 break;
  64                 }
  65         }
  66 }
  67
  68 #else
  69
  70 void RNA_api_keyingset(StructRNA *srna)
  71 {
  72         FunctionRNA *func;
  73         //PropertyRNA *parm;
  74
  75         /* validate relative Keying Set (used to ensure paths are ok for context) */
  76         func= RNA_def_function(srna, "refresh", "rna_KeyingSet_context_refresh");
  77         RNA_def_function_ui_description(func, "Refresh Keying Set to ensure that it is valid for the current context. Call before each use of one");
  78         RNA_def_function_flag(func, FUNC_USE_CONTEXT|FUNC_USE_REPORTS);
  79 }
  80
  81 #endif
  82