doxygen: editor entry
[blender.git] / source / blender / editors / include / ED_keyframing.h
index dc0fb597c221ea0f6ca8f1c1a334c46d82b3c032..7bab563641a002c8a307436106c1f29a6ab12dd4 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file ED_keyframing.h
+ *  \ingroup editors
+ */
+
 #ifndef ED_KEYFRAMING_H
 #define ED_KEYFRAMING_H
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 struct ListBase;
 struct ID;
 struct Scene;
@@ -43,9 +51,13 @@ struct bConstraint;
 
 struct bContext;
 struct wmOperatorType;
+struct ReportList;
 
 struct PointerRNA;
 struct PropertyRNA;
+struct EnumPropertyItem;
+
+#include "RNA_types.h"
 
 /* ************ Keyframing Management **************** */
 
@@ -87,7 +99,7 @@ int insert_vert_fcurve(struct FCurve *fcu, float x, float y, short flag);
  *     Use this to insert a keyframe using the current value being keyframed, in the 
  *     nominated F-Curve (no creation of animation data performed). Returns success.
  */
-short insert_keyframe_direct(struct PointerRNA ptr, struct PropertyRNA *prop, struct FCurve *fcu, float cfra, short flag);
+short insert_keyframe_direct(struct ReportList *reports, struct PointerRNA ptr, struct PropertyRNA *prop, struct FCurve *fcu, float cfra, short flag);
 
 /* -------- */
 
@@ -95,12 +107,12 @@ short insert_keyframe_direct(struct PointerRNA ptr, struct PropertyRNA *prop, st
  *     Use this to create any necessary animation data, and then insert a keyframe
  *     using the current value being keyframed, in the relevant place. Returns success.
  */
-short insert_keyframe(struct ID *id, struct bAction *act, const char group[], const char rna_path[], int array_index, float cfra, short flag);
+short insert_keyframe(struct ReportList *reports, struct ID *id, struct bAction *act, const char group[], const char rna_path[], int array_index, float cfra, short flag);
 
 /* Main Keyframing API call: 
  *     Use this to delete keyframe on current frame for relevant channel. Will perform checks just in case.
  */
-short delete_keyframe(struct ID *id, struct bAction *act, const char group[], const char rna_path[], int array_index, float cfra, short flag);
+short delete_keyframe(struct ReportList *reports, struct ID *id, struct bAction *act, const char group[], const char rna_path[], int array_index, float cfra, short flag);
 
 /* ************ Keying Sets ********************** */
 
@@ -123,10 +135,10 @@ typedef struct KeyingSetInfo {
        /* info */
                /* identifier so that user can hook this up to a KeyingSet */
        char name[64];
+               /* identifier used for class name, which KeyingSet instances reference as "Typeinfo Name" */
+       char idname[64];
                /* keying settings */
        short keyingflag;
-               /* builtin? */
-       short builtin;
        
        /* polling callbacks */
                /* callback for polling the context for whether the right data is available */
@@ -177,7 +189,7 @@ struct KeyingSet *ANIM_builtin_keyingset_get_named(struct KeyingSet *prevKS, con
 KeyingSetInfo *ANIM_keyingset_info_find_named(const char name[]);
 
 /* for RNA type registrations... */
-void ANIM_keyingset_info_register(const struct bContext *C, KeyingSetInfo *ksi);
+void ANIM_keyingset_info_register(KeyingSetInfo *ksi);
 void ANIM_keyingset_info_unregister(const struct bContext *C, KeyingSetInfo *ksi);
 
 /* cleanup on exit */
@@ -188,34 +200,53 @@ void ANIM_keyingset_infos_exit(void);
 /* Get the active KeyingSet for the given scene */
 struct KeyingSet *ANIM_scene_get_active_keyingset(struct Scene *scene);
 
+/* Get the index of the Keying Set provided, for the given Scene */
+int ANIM_scene_get_keyingset_index(struct Scene *scene, struct KeyingSet *ks);
+
+/* Get Keying Set to use for Auto-Keyframing some transforms */
+struct KeyingSet *ANIM_get_keyingset_for_autokeying(struct Scene *scene, const char *tranformKSName);
+
+/* Create (and show) a menu containing all the Keying Sets which can be used in the current context */
+void ANIM_keying_sets_menu_setup(struct bContext *C, const char title[], const char op_name[]);
+
+/* Dynamically populate an enum of Keying Sets */
+struct EnumPropertyItem *ANIM_keying_sets_enum_itemf(struct bContext *C, struct PointerRNA *ptr, int *free);
+
 /* Check if KeyingSet can be used in the current context */
 short ANIM_keyingset_context_ok_poll(struct bContext *C, struct KeyingSet *ks);
 
 /* ************ Drivers ********************** */
 
+/* Flags for use by driver creation calls */
+typedef enum eCreateDriverFlags {
+       CREATEDRIVER_WITH_DEFAULT_DVAR  = (1<<0),       /* create drivers with a default variable for nicer UI */
+} eCreateDriverFlags;
+
+/* -------- */
+
 /* Returns whether there is a driver in the copy/paste buffer to paste */
 short ANIM_driver_can_paste(void);
 
 /* Main Driver Management API calls:
  *     Add a new driver for the specified property on the given ID block
  */
-short ANIM_add_driver(struct ID *id, const char rna_path[], int array_index, short flag, int type);
+short ANIM_add_driver(struct ReportList *reports, struct ID *id, const char rna_path[], int array_index, short flag, int type);
 
 /* Main Driver Management API calls:
  *     Remove the driver for the specified property on the given ID block (if available)
  */
-short ANIM_remove_driver(struct ID *id, const char rna_path[], int array_index, short flag);
+short ANIM_remove_driver(struct ReportList *reports, struct ID *id, const char rna_path[], int array_index, short flag);
 
 /* Main Driver Management API calls:
  *     Make a copy of the driver for the specified property on the given ID block
  */
-short ANIM_copy_driver(struct ID *id, const char rna_path[], int array_index, short flag);
+short ANIM_copy_driver(struct ReportList *reports, struct ID *id, const char rna_path[], int array_index, short flag);
 
 /* Main Driver Management API calls:
  *     Add a new driver for the specified property on the given ID block or replace an existing one
  *     with the driver + driver-curve data from the buffer 
  */
-short ANIM_paste_driver(struct ID *id, const char rna_path[], int array_index, short flag);
+short ANIM_paste_driver(struct ReportList *reports, struct ID *id, const char rna_path[], int array_index, short flag);
 
 /* ************ Auto-Keyframing ********************** */
 /* Notes:
@@ -232,8 +263,12 @@ short ANIM_paste_driver(struct ID *id, const char rna_path[], int array_index, s
 #define IS_AUTOKEY_ON(scene)   ((scene) ? (scene->toolsettings->autokey_mode & AUTOKEY_ON) : (U.autokey_mode & AUTOKEY_ON))
        /* check the mode for auto-keyframing (per scene takes presidence)  */
 #define IS_AUTOKEY_MODE(scene, mode)   ((scene) ? (scene->toolsettings->autokey_mode == AUTOKEY_MODE_##mode) : (U.autokey_mode == AUTOKEY_MODE_##mode))
-       /* check if a flag is set for auto-keyframing (as userprefs only!) */
-#define IS_AUTOKEY_FLAG(flag)  (U.autokey_flag & AUTOKEY_FLAG_##flag)
+       /* check if a flag is set for auto-keyframing (per scene takes presidence) */
+#define IS_AUTOKEY_FLAG(scene, flag) \
+       ((scene)? \
+               ((scene->toolsettings->autokey_flag & AUTOKEY_FLAG_##flag) || (U.autokey_flag & AUTOKEY_FLAG_##flag)) \
+        : \
+               (U.autokey_flag & AUTOKEY_FLAG_##flag))
 
 /* auto-keyframing feature - checks for whether anything should be done for the current frame */
 int autokeyframe_cfra_can_key(struct Scene *scene, struct ID *id);
@@ -249,7 +284,7 @@ short fcurve_frame_has_keyframe(struct FCurve *fcu, float frame, short filter);
  * Checks whether a keyframe exists for the given ID-block one the given frame.
  *  - It is recommended to call this method over the other keyframe-checkers directly,
  *       in case some detail of the implementation changes...
- *     - frame: the value of this is quite often result of frame_to_float(CFRA)
+ *     - frame: the value of this is quite often result of BKE_curframe()
  */
 short id_frame_has_keyframe(struct ID *id, float frame, short filter);
 
@@ -269,4 +304,8 @@ typedef enum eAnimFilterFlags {
        ANIMFILTER_KEYS_NOSKEY          = (1<<10),              /* don't include shape keys (for geometry) */
 } eAnimFilterFlags;
 
+#ifdef __cplusplus
+}
+#endif
+
 #endif /*  ED_KEYFRAMING_H */