Merge branch 'master' into blender2.8
[blender.git] / source / blender / editors / include / ED_anim_api.h
index c6b8d879180f2a724f16b7cb7af25c9ad65f91f6..99f9287be8ffc285c32ec86ff42612cea9898a09 100644 (file)
@@ -49,7 +49,6 @@ struct Object;
 struct bDopeSheet;
 
 struct bAction;
-struct bActionGroup;
 struct FCurve;
 struct FModifier;
 
@@ -75,6 +74,7 @@ typedef struct bAnimContext {
        short mode;             /* editor->mode */
        short spacetype;        /* sa->spacetype */
        short regiontype;       /* active region -> type (channels or main) */
+       
        struct ScrArea *sa;     /* editor host */
        struct SpaceLink *sl;   /* editor data */
        struct ARegion *ar;     /* region within editor */
@@ -86,6 +86,8 @@ typedef struct bAnimContext {
        ListBase *markers;      /* active set of markers */
        
        struct ReportList *reports; /* pointer to current reports list */
+       
+       float yscale_fac;       /* scale factor for height of channels (i.e. based on the size of keyframes) */
 } bAnimContext;
 
 /* Main Data container types */
@@ -111,16 +113,21 @@ typedef struct bAnimListElem {
        struct bAnimListElem *next, *prev;
        
        void    *data;          /* source data this elem represents */
-       int     type;           /* one of the ANIMTYPE_* values */
+       int     type;           /* (eAnim_ChannelType) one of the ANIMTYPE_* values */
        int     flag;           /* copy of elem's flags for quick access */
-       int     index;          /* for un-named data, the index of the data in it's collection */
+       int     index;          /* for un-named data, the index of the data in its collection */
        
-       short   datatype;       /* type of motion data to expect */
+       char    update;         /* (eAnim_Update_Flags)  tag the element for updating */
+       char    tag;            /* tag the included data. Temporary always */
+
+       short   datatype;       /* (eAnim_KeyType) type of motion data to expect */
        void   *key_data;       /* motion data - mostly F-Curves, but can be other types too */
        
        
        struct ID *id;          /* ID block that channel is attached to */
        struct AnimData *adt;   /* source of the animation data attached to ID block (for convenience) */
+       
+       void   *owner;          /* for per-element F-Curves (e.g. NLA Control Curves), the element that this represents (e.g. NlaStrip) */
 } bAnimListElem;
 
 
@@ -140,17 +147,20 @@ typedef enum eAnim_ChannelType {
        ANIMTYPE_GROUP,
        ANIMTYPE_FCURVE,
        
+       ANIMTYPE_NLACONTROLS,
+       ANIMTYPE_NLACURVE,
+       
        ANIMTYPE_FILLACTD,
        ANIMTYPE_FILLDRIVERS,
        
        ANIMTYPE_DSMAT,
        ANIMTYPE_DSLAM,
        ANIMTYPE_DSCAM,
+       ANIMTYPE_DSCACHEFILE,
        ANIMTYPE_DSCUR,
        ANIMTYPE_DSSKEY,
        ANIMTYPE_DSWOR,
        ANIMTYPE_DSNTREE,
-       ANIMTYPE_DSPART,
        ANIMTYPE_DSMBALL,
        ANIMTYPE_DSARM,
        ANIMTYPE_DSMESH,
@@ -158,12 +168,13 @@ typedef enum eAnim_ChannelType {
        ANIMTYPE_DSLAT,
        ANIMTYPE_DSLINESTYLE,
        ANIMTYPE_DSSPK,
+       ANIMTYPE_DSGPENCIL,
        
        ANIMTYPE_SHAPEKEY,
        
        ANIMTYPE_GPDATABLOCK,
        ANIMTYPE_GPLAYER,
-
+       
        ANIMTYPE_MASKDATABLOCK,
        ANIMTYPE_MASKLAYER,
        
@@ -189,6 +200,20 @@ typedef enum eAnim_KeyType {
        ALE_GROUP           /* Action Group summary */
 } eAnim_KeyType;
 
+/* Flags for specifying the types of updates (i.e. recalculation/refreshing) that
+ * needs to be performed to the data contained in a channel following editing.
+ * For use with ANIM_animdata_update()
+ */
+typedef enum eAnim_Update_Flags {
+       ANIM_UPDATE_DEPS        = (1 << 0),  /* referenced data and dependencies get refreshed */
+       ANIM_UPDATE_ORDER       = (1 << 1),  /* keyframes need to be sorted */
+       ANIM_UPDATE_HANDLES     = (1 << 2),  /* recalculate handles */
+} eAnim_Update_Flags;
+
+/* used for most tools which change keyframes (flushed by ANIM_animdata_update) */
+#define ANIM_UPDATE_DEFAULT (ANIM_UPDATE_DEPS | ANIM_UPDATE_ORDER | ANIM_UPDATE_HANDLES)
+#define ANIM_UPDATE_DEFAULT_NOHANDLES (ANIM_UPDATE_DEFAULT & ~ANIM_UPDATE_HANDLES)
+
 /* ----------------- Filtering -------------------- */
 
 /* filtering flags  - under what circumstances should a channel be returned */
@@ -250,8 +275,8 @@ typedef enum eAnimFilter_Flags {
 #define FILTER_MAT_OBJD(ma)     (CHECK_TYPE_INLINE(ma, Material *), ((ma->flag & MA_DS_EXPAND)))
 #define FILTER_LAM_OBJD(la)     (CHECK_TYPE_INLINE(la, Lamp *), ((la->flag & LA_DS_EXPAND)))
 #define FILTER_CAM_OBJD(ca)     (CHECK_TYPE_INLINE(ca, Camera *), ((ca->flag & CAM_DS_EXPAND)))
+#define FILTER_CACHEFILE_OBJD(cf)     (CHECK_TYPE_INLINE(cf, CacheFile *), ((cf->flag & CACHEFILE_DS_EXPAND)))
 #define FILTER_CUR_OBJD(cu)     (CHECK_TYPE_INLINE(cu, Curve *), ((cu->flag & CU_DS_EXPAND)))
-#define FILTER_PART_OBJD(part)  (CHECK_TYPE_INLINE(part, ParticleSettings *), ((part->flag & PART_DS_EXPAND)))
 #define FILTER_MBALL_OBJD(mb)   (CHECK_TYPE_INLINE(mb, MetaBall *), ((mb->flag2 & MB_DS_EXPAND)))
 #define FILTER_ARM_OBJD(arm)    (CHECK_TYPE_INLINE(arm, bArmature *), ((arm->flag & ARM_DS_EXPAND)))
 #define FILTER_MESH_OBJD(me)    (CHECK_TYPE_INLINE(me, Mesh *), ((me->flag & ME_DS_EXPAND)))
@@ -309,11 +334,11 @@ typedef enum eAnimFilter_Flags {
 /* -------------- Channel Defines -------------- */
 
 /* channel heights */
-#define ACHANNEL_FIRST          (-0.8f * U.widget_unit)
-#define ACHANNEL_HEIGHT         (0.8f * U.widget_unit)
-#define ACHANNEL_HEIGHT_HALF    (0.4f * U.widget_unit)
-#define ACHANNEL_SKIP           (0.1f * U.widget_unit)
-#define ACHANNEL_STEP           (ACHANNEL_HEIGHT + ACHANNEL_SKIP)
+#define ACHANNEL_FIRST(ac)          (-0.8f * (ac)->yscale_fac * U.widget_unit)
+#define ACHANNEL_HEIGHT(ac)         (0.8f * (ac)->yscale_fac * U.widget_unit)
+#define ACHANNEL_HEIGHT_HALF(ac)    (0.4f * (ac)->yscale_fac * U.widget_unit)
+#define ACHANNEL_SKIP               (0.1f * U.widget_unit)
+#define ACHANNEL_STEP(ac)           (ACHANNEL_HEIGHT(ac) + ACHANNEL_SKIP)
 
 /* channel widths */
 #define ACHANNEL_NAMEWIDTH      (10 * U.widget_unit)
@@ -325,7 +350,6 @@ typedef enum eAnimFilter_Flags {
 /* -------------- NLA Channel Defines -------------- */
 
 /* NLA channel heights */
-// XXX: NLACHANNEL_FIRST isn't used?
 #define NLACHANNEL_FIRST                (-0.8f * U.widget_unit)
 #define NLACHANNEL_HEIGHT(snla)         ((snla && (snla->flag & SNLA_NOSTRIPCURVES)) ? (0.8f * U.widget_unit) : (1.2f * U.widget_unit))
 #define NLACHANNEL_HEIGHT_HALF(snla)    ((snla && (snla->flag & SNLA_NOSTRIPCURVES)) ? (0.4f * U.widget_unit) : (0.6f * U.widget_unit))
@@ -343,7 +367,7 @@ typedef enum eAnimFilter_Flags {
 /* Obtain list of filtered Animation channels to operate on.
  * Returns the number of channels in the list
  */
-size_t ANIM_animdata_filter(bAnimContext *ac, ListBase *anim_data, int filter_mode, void *data, short datatype);
+size_t ANIM_animdata_filter(bAnimContext *ac, ListBase *anim_data, eAnimFilter_Flags filter_mode, void *data, eAnimCont_Types datatype);
 
 /* Obtain current anim-data context from Blender Context info.
  * Returns whether the operation was successful. 
@@ -356,12 +380,24 @@ bool ANIM_animdata_get_context(const struct bContext *C, bAnimContext *ac);
  */
 bool ANIM_animdata_context_getdata(bAnimContext *ac);
 
+/* Acts on bAnimListElem eAnim_Update_Flags */
+void ANIM_animdata_update(bAnimContext *ac, ListBase *anim_data);
+
+void ANIM_animdata_freelist(ListBase *anim_data);
+
 /* ************************************************ */
 /* ANIMATION CHANNELS LIST */
 /* anim_channels_*.c */
 
 /* ------------------------ Drawing TypeInfo -------------------------- */
 
+/* role or level of animchannel in the hierarchy */
+typedef enum eAnimChannel_Role {
+       ACHANNEL_ROLE_EXPANDER = -1,    /* datablock expander - a "composite" channel type */
+       ACHANNEL_ROLE_SPECIAL  = 0,     /* special purposes - not generally for hierarchy processing */
+       ACHANNEL_ROLE_CHANNEL  = 1      /* data channel - a channel representing one of the actual building blocks of channels */
+} eAnimChannel_Role;
+
 /* flag-setting behavior */
 typedef enum eAnimChannels_SetFlag {
        ACHANNEL_SETFLAG_CLEAR  = 0,     /* turn off */
@@ -378,17 +414,20 @@ typedef enum eAnimChannel_Settings {
        ACHANNEL_SETTING_EXPAND   = 3,
        ACHANNEL_SETTING_VISIBLE  = 4,  /* only for Graph Editor */
        ACHANNEL_SETTING_SOLO     = 5,  /* only for NLA Tracks */
-       ACHANNEL_SETTING_PINNED   = 6   /* only for NLA Actions */
+       ACHANNEL_SETTING_PINNED   = 6,  /* only for NLA Actions */
+       ACHANNEL_SETTING_MOD_OFF  = 7
 } eAnimChannel_Settings;
 
 
 /* Drawing, mouse handling, and flag setting behavior... */
 typedef struct bAnimChannelType {
-       /* type data */
+       /* -- Type data -- */
        /* name of the channel type, for debugging */
        const char *channel_type_name;
+       /* "level" or role in hierarchy - for finding the active channel */
+       eAnimChannel_Role channel_role;
        
-       /* drawing */
+       /* -- Drawing -- */
        /* get RGB color that is used to draw the majority of the backdrop */
        void (*get_backdrop_color)(bAnimContext *ac, bAnimListElem *ale, float r_color[3]);
        /* draw backdrop strip for channel */
@@ -405,7 +444,7 @@ typedef struct bAnimChannelType {
        /* get icon (for channel lists) */
        int (*icon)(bAnimListElem *ale);
        
-       /* settings */
+       /* -- Settings -- */
        /* check if the given setting is valid in the current context */
        bool (*has_setting)(bAnimContext *ac, bAnimListElem *ale, eAnimChannel_Settings setting);
        /* get the flag used for this setting */
@@ -420,15 +459,15 @@ typedef struct bAnimChannelType {
 /* ------------------------ Drawing API -------------------------- */
 
 /* Get typeinfo for the given channel */
-bAnimChannelType *ANIM_channel_get_typeinfo(bAnimListElem *ale);
+const bAnimChannelType *ANIM_channel_get_typeinfo(bAnimListElem *ale);
 
 /* Print debugging info about a given channel */
 void ANIM_channel_debug_print_info(bAnimListElem *ale, short indent_level);
 
 /* Draw the given channel */
-void ANIM_channel_draw(bAnimContext *ac, bAnimListElem *ale, float yminc, float ymaxc);
+void ANIM_channel_draw(bAnimContext *ac, bAnimListElem *ale, float yminc, float ymaxc, size_t channel_index);
 /* Draw the widgets for the given channel */
-void ANIM_channel_draw_widgets(struct bContext *C, bAnimContext *ac, bAnimListElem *ale, struct uiBlock *block, float yminc, float ymaxc, size_t channel_index);
+void ANIM_channel_draw_widgets(const struct bContext *C, bAnimContext *ac, bAnimListElem *ale, struct uiBlock *block, float yminc, float ymaxc, size_t channel_index);
 
 
 /* ------------------------ Editing API -------------------------- */
@@ -438,13 +477,13 @@ void ANIM_channel_draw_widgets(struct bContext *C, bAnimContext *ac, bAnimListEl
  *
  *  - setting: eAnimChannel_Settings
  */
-short ANIM_channel_setting_get(bAnimContext *ac, bAnimListElem *ale, int setting);
+short ANIM_channel_setting_get(bAnimContext *ac, bAnimListElem *ale, eAnimChannel_Settings setting);
 
 /* Change value of some setting for a channel 
  *     - setting: eAnimChannel_Settings
  *     - mode: eAnimChannels_SetFlag
  */
-void ANIM_channel_setting_set(bAnimContext *ac, bAnimListElem *ale, int setting, short mode);
+void ANIM_channel_setting_set(bAnimContext *ac, bAnimListElem *ale, eAnimChannel_Settings setting, eAnimChannels_SetFlag mode);
 
 
 /* Flush visibility (for Graph Editor) changes up/down hierarchy for changes in the given setting 
@@ -456,14 +495,14 @@ void ANIM_channel_setting_set(bAnimContext *ac, bAnimListElem *ale, int setting,
  *     - setting: type of setting to set
  *     - on: whether the visibility setting has been enabled or disabled 
  */
-void ANIM_flush_setting_anim_channels(bAnimContext *ac, ListBase *anim_data, bAnimListElem *ale_setting, int setting, short mode);
+void ANIM_flush_setting_anim_channels(bAnimContext *ac, ListBase *anim_data, bAnimListElem *ale_setting, eAnimChannel_Settings setting, eAnimChannels_SetFlag mode);
 
 
 /* Deselect all animation channels */
-void ANIM_deselect_anim_channels(bAnimContext *ac, void *data, short datatype, short test, short sel);
+void ANIM_deselect_anim_channels(bAnimContext *ac, void *data, eAnimCont_Types datatype, bool test, eAnimChannels_SetFlag sel);
 
 /* Set the 'active' channel of type channel_type, in the given action */
-void ANIM_set_active_channel(bAnimContext *ac, void *data, short datatype, int filter, void *channel_data, short channel_type);
+void ANIM_set_active_channel(bAnimContext *ac, void *data, eAnimCont_Types datatype, eAnimFilter_Flags filter, void *channel_data, eAnim_ChannelType channel_type);
 
 
 /* Delete the F-Curve from the given AnimData block (if possible), as appropriate according to animation context */
@@ -507,10 +546,10 @@ void ANIM_uiTemplate_fmodifier_draw(struct uiLayout *layout, struct ID *id, List
 
 
 /* free the copy/paste buffer */
-void free_fmodifiers_copybuf(void);
+void ANIM_fmodifiers_copybuf_free(void);
 
 /* copy the given F-Modifiers to the buffer, returning whether anything was copied or not
- * assuming that the buffer has been cleared already with free_fmodifiers_copybuf()
+ * assuming that the buffer has been cleared already with ANIM_fmodifiers_copybuf_free()
  *     - active: only copy the active modifier
  */
 bool ANIM_fmodifiers_copy_to_buf(ListBase *modifiers, bool active);
@@ -571,7 +610,7 @@ typedef enum eAnimUnitConv_Flags {
        ANIM_UNITCONV_SKIPKNOTS  = (1 << 4),
        /* Scale FCurve i a way it fits to -1..1 space */
        ANIM_UNITCONV_NORMALIZE  = (1 << 5),
-       /* Only whennormalization is used: use scale factor from previous run,
+       /* Only when normalization is used: use scale factor from previous run,
         * prevents curves from jumping all over the place when tweaking them.
         */
        ANIM_UNITCONV_NORMALIZE_FREEZE  = (1 << 6),
@@ -581,7 +620,7 @@ typedef enum eAnimUnitConv_Flags {
 short ANIM_get_normalization_flags(bAnimContext *ac);
 
 /* Get unit conversion factor for given ID + F-Curve */
-float ANIM_unit_mapping_get_factor(struct Scene *scene, struct ID *id, struct FCurve *fcu, short flag);
+float ANIM_unit_mapping_get_factor(struct Scene *scene, struct ID *id, struct FCurve *fcu, short flag, float *r_offset);
 
 /* ------------- Utility macros ----------------------- */
 
@@ -623,6 +662,7 @@ void ANIM_list_elem_update(struct Scene *scene, bAnimListElem *ale);
 /* data -> channels syncing */
 void ANIM_sync_animchannels_to_data(const struct bContext *C);
 
+void ANIM_center_frame(struct bContext *C, int smooth_viewtx);
 /* ************************************************* */
 /* OPERATORS */
        
@@ -639,6 +679,16 @@ void ED_operatormacros_graph(void);
 /* space_action */
 void ED_operatormacros_action(void);
 
+/* ************************************************ */
+/* Animation Editor Exports */
+/* XXX: Should we be doing these here, or at all? */
+
+/* Action Editor - Action Management */
+struct AnimData *ED_actedit_animdata_from_context(struct bContext *C);
+void ED_animedit_unlink_action(struct bContext *C, struct ID *id, 
+                               struct AnimData *adt, struct bAction *act,
+                               struct ReportList *reports, bool force_delete);
+
 /* ************************************************ */
 
 #endif /* __ED_ANIM_API_H__ */