Alexander Gavrilov
a0dfa320cd
With the new automatic handle algorithm, it is possible to do a lot of the animation via keyframes without touching the curves. It is however necessary to change the keyframe interpolation and handle types in certain cases. Currently the dopesheet/action editor allows changing the types, but does not show them in any way. To fix, add a new menu option to display this information. For handle type, it is represented using the shape of the key icons: diamond for Free, clipped diamond for Aligned, square for Vector, circle for Auto Clamp, and cirle with dot for Automatic. Non-bezier interpolation is a property of intervals between keys, so it is marked by drawing lines, similar to holds. In this initial version, only the fact of non-bezier interpolation is displayed, without distinguishing types. For summaries, the line is drawn at half alpha if not all curves in the group are non-bezier. In addition, it is sometimes helpful to know the general direction of change of the curve, and which keys are extremes. This commit also adds an option to highlight extremes, based on comparing the keyed values with adjacent keys. Half-intensity display is used for overshot bezier extremes, or non-uniform summaries. Reviewers: brecht, aligorith, billreynish Differential Revision: https://developer.blender.org/D3788
199 lines
7.8 KiB
C++
199 lines
7.8 KiB
C++
/*
|
|
* ***** BEGIN GPL LICENSE BLOCK *****
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
* The Original Code is Copyright (C) (C) 2009 Blender Foundation, Joshua Leung
|
|
* All rights reserved.
|
|
*
|
|
* The Original Code is: all of this file.
|
|
*
|
|
* Contributor(s): Joshua Leung (full recode)
|
|
*
|
|
* ***** END GPL LICENSE BLOCK *****
|
|
*/
|
|
|
|
/** \file ED_keyframes_draw.h
|
|
* \ingroup editors
|
|
*/
|
|
|
|
#ifndef __ED_KEYFRAMES_DRAW_H__
|
|
#define __ED_KEYFRAMES_DRAW_H__
|
|
|
|
struct bAnimContext;
|
|
struct AnimData;
|
|
struct CacheFile;
|
|
struct FCurve;
|
|
struct bDopeSheet;
|
|
struct bAction;
|
|
struct bActionGroup;
|
|
struct Object;
|
|
struct ListBase;
|
|
struct bGPDlayer;
|
|
struct Palette;
|
|
struct MaskLayer;
|
|
struct Scene;
|
|
struct View2D;
|
|
struct DLRBT_Tree;
|
|
|
|
/* ****************************** Base Structs ****************************** */
|
|
|
|
/* Information about the stretch of time from current to the next column */
|
|
typedef struct ActKeyBlockInfo {
|
|
/* Combination of flags from all curves. */
|
|
short flag;
|
|
/* Mask of flags that differ between curves. */
|
|
short conflict;
|
|
|
|
/* Selection flag. */
|
|
char sel;
|
|
} ActKeyBlockInfo;
|
|
|
|
/* Keyframe Column Struct */
|
|
typedef struct ActKeyColumn {
|
|
/* ListBase linkage */
|
|
struct ActKeyColumn *next, *prev;
|
|
|
|
/* sorting-tree linkage */
|
|
struct ActKeyColumn *left, *right; /* 'children' of this node, less than and greater than it (respectively) */
|
|
struct ActKeyColumn *parent; /* parent of this node in the tree */
|
|
char tree_col; /* DLRB_BLACK or DLRB_RED */
|
|
|
|
/* keyframe info */
|
|
char key_type; /* eBezTripe_KeyframeType */
|
|
char handle_type; /* eKeyframeHandleDrawOpts */
|
|
char extreme_type; /* eKeyframeExtremeDrawOpts */
|
|
short sel;
|
|
float cfra;
|
|
|
|
/* key-block info */
|
|
ActKeyBlockInfo block;
|
|
|
|
/* number of curves and keys in this column */
|
|
short totcurve, totkey, totblock;
|
|
} ActKeyColumn;
|
|
|
|
/* ActKeyBlockInfo - Flag */
|
|
typedef enum eActKeyBlock_Hold {
|
|
/* Key block represents a moving hold */
|
|
ACTKEYBLOCK_FLAG_MOVING_HOLD = (1 << 0),
|
|
/* Key block represents a static hold */
|
|
ACTKEYBLOCK_FLAG_STATIC_HOLD = (1 << 1),
|
|
/* Key block represents any kind of hold */
|
|
ACTKEYBLOCK_FLAG_ANY_HOLD = (1 << 2),
|
|
/* The curve segment uses non-bezier interpolation */
|
|
ACTKEYBLOCK_FLAG_NON_BEZIER = (1 << 3),
|
|
} eActKeyBlock_Flag;
|
|
|
|
/* *********************** Keyframe Drawing ****************************** */
|
|
|
|
/* options for keyframe shape drawing */
|
|
typedef enum eKeyframeShapeDrawOpts {
|
|
/* only the border */
|
|
KEYFRAME_SHAPE_FRAME = 0,
|
|
/* only the inside filling */
|
|
KEYFRAME_SHAPE_INSIDE,
|
|
/* the whole thing */
|
|
KEYFRAME_SHAPE_BOTH
|
|
} eKeyframeShapeDrawOpts;
|
|
|
|
/* Handle type. */
|
|
typedef enum eKeyframeHandleDrawOpts {
|
|
/* Don't draw */
|
|
KEYFRAME_HANDLE_NONE = 0,
|
|
/* Various marks in order of increasing display priority. */
|
|
KEYFRAME_HANDLE_AUTO_CLAMP,
|
|
KEYFRAME_HANDLE_AUTO,
|
|
KEYFRAME_HANDLE_VECTOR,
|
|
KEYFRAME_HANDLE_ALIGNED,
|
|
KEYFRAME_HANDLE_FREE,
|
|
} eKeyframeHandleDrawOpts;
|
|
|
|
/* Extreme type. */
|
|
typedef enum eKeyframeExtremeDrawOpts {
|
|
KEYFRAME_EXTREME_NONE = 0,
|
|
/* Minimum/maximum present. */
|
|
KEYFRAME_EXTREME_MIN = (1 << 0),
|
|
KEYFRAME_EXTREME_MAX = (1 << 1),
|
|
/* Grouped keys have different states. */
|
|
KEYFRAME_EXTREME_MIXED = (1 << 2),
|
|
/* Both neigbors are equal to this key. */
|
|
KEYFRAME_EXTREME_FLAT = (1 << 3),
|
|
} eKeyframeExtremeDrawOpts;
|
|
|
|
/* draw simple diamond-shape keyframe */
|
|
/* caller should set up vertex format, bind GPU_SHADER_KEYFRAME_DIAMOND, immBegin(GPU_PRIM_POINTS, n), then call this n times */
|
|
void draw_keyframe_shape(float x, float y, float size, bool sel, short key_type, short mode, float alpha,
|
|
unsigned int pos_id, unsigned int size_id, unsigned int color_id, unsigned int outline_color_id,
|
|
unsigned int linemask_id, short ipo_type, short extreme_type);
|
|
|
|
/* ******************************* Methods ****************************** */
|
|
|
|
/* Channel Drawing ------------------ */
|
|
/* F-Curve */
|
|
void draw_fcurve_channel(struct View2D *v2d, struct AnimData *adt, struct FCurve *fcu, float ypos, float yscale_fac, int saction_flag);
|
|
/* Action Group Summary */
|
|
void draw_agroup_channel(struct View2D *v2d, struct AnimData *adt, struct bActionGroup *agrp, float ypos, float yscale_fac, int saction_flag);
|
|
/* Action Summary */
|
|
void draw_action_channel(struct View2D *v2d, struct AnimData *adt, struct bAction *act, float ypos, float yscale_fac, int saction_flag);
|
|
/* Object Summary */
|
|
void draw_object_channel(struct View2D *v2d, struct bDopeSheet *ads, struct Object *ob, float ypos, float yscale_fac, int saction_flag);
|
|
/* Scene Summary */
|
|
void draw_scene_channel(struct View2D *v2d, struct bDopeSheet *ads, struct Scene *sce, float ypos, float yscale_fac, int saction_flag);
|
|
/* DopeSheet Summary */
|
|
void draw_summary_channel(struct View2D *v2d, struct bAnimContext *ac, float ypos, float yscale_fac, int saction_flag);
|
|
/* Grease Pencil datablock summary */
|
|
void draw_gpencil_channel(struct View2D *v2d, struct bDopeSheet *ads, struct bGPdata *gpd, float ypos, float yscale_fac, int saction_flag);
|
|
/* Grease Pencil Layer */
|
|
void draw_gpl_channel(struct View2D *v2d, struct bDopeSheet *ads, struct bGPDlayer *gpl, float ypos, float yscale_fac, int saction_flag);
|
|
/* Mask Layer */
|
|
void draw_masklay_channel(struct View2D *v2d, struct bDopeSheet *ads, struct MaskLayer *masklay, float ypos, float yscale_fac, int saction_flag);
|
|
|
|
/* Keydata Generation --------------- */
|
|
/* F-Curve */
|
|
void fcurve_to_keylist(struct AnimData *adt, struct FCurve *fcu, struct DLRBT_Tree *keys, int saction_flag);
|
|
/* Action Group */
|
|
void agroup_to_keylist(struct AnimData *adt, struct bActionGroup *agrp, struct DLRBT_Tree *keys, int saction_flag);
|
|
/* Action */
|
|
void action_to_keylist(struct AnimData *adt, struct bAction *act, struct DLRBT_Tree *keys, int saction_flag);
|
|
/* Object */
|
|
void ob_to_keylist(struct bDopeSheet *ads, struct Object *ob, struct DLRBT_Tree *keys, int saction_flag);
|
|
/* Cache File */
|
|
void cachefile_to_keylist(struct bDopeSheet *ads, struct CacheFile *cache_file, struct DLRBT_Tree *keys, int saction_flag);
|
|
/* Scene */
|
|
void scene_to_keylist(struct bDopeSheet *ads, struct Scene *sce, struct DLRBT_Tree *keys, int saction_flag);
|
|
/* DopeSheet Summary */
|
|
void summary_to_keylist(struct bAnimContext *ac, struct DLRBT_Tree *keys, int saction_flag);
|
|
/* Grease Pencil datablock summary */
|
|
void gpencil_to_keylist(struct bDopeSheet *ads, struct bGPdata *gpd, struct DLRBT_Tree *keys, const bool active);
|
|
/* Grease Pencil Layer */
|
|
void gpl_to_keylist(struct bDopeSheet *ads, struct bGPDlayer *gpl, struct DLRBT_Tree *keys);
|
|
/* Palette */
|
|
void palette_to_keylist(struct bDopeSheet *ads, struct Palette *palette, struct DLRBT_Tree *keys);
|
|
/* Mask */
|
|
void mask_to_keylist(struct bDopeSheet *UNUSED(ads), struct MaskLayer *masklay, struct DLRBT_Tree *keys);
|
|
|
|
/* ActKeyColumn API ---------------- */
|
|
/* Comparator callback used for ActKeyColumns and cframe float-value pointer */
|
|
short compare_ak_cfraPtr(void *node, void *data);
|
|
|
|
/* Checks if ActKeyColumn has any block data */
|
|
bool actkeyblock_is_valid(ActKeyColumn *ab);
|
|
|
|
/* Checks if ActKeyColumn can be used as a block (i.e. drawn/used to detect "holds") */
|
|
int actkeyblock_get_valid_hold(ActKeyColumn *ab);
|
|
|
|
#endif /* __ED_KEYFRAMES_DRAW_H__ */
|