Blender V5.3
DNA_anim_enums.h
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2009 Blender Authors, Joshua Leung. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include "BLI_enum_flags.hh"
12
13namespace blender {
14
15/* ************************************************ */
16/* F-Curve DataTypes */
17
18/* Modifiers -------------------------------------- */
19
24enum eFModifier_Types : short {
31 FMODIFIER_TYPE_FILTER = 6, /* Was never implemented, removed in #123906. */
32 FMODIFIER_TYPE_PYTHON = 7, /* Was never implemented, removed in #123906. */
36
37 /* NOTE: all new modifiers must be added above this line */
39};
40
42enum eFModifier_Flags : short {
47 FMODIFIER_FLAG_EXPANDED = (1 << 1),
48#endif
57};
59
60/* --- */
61
62/* generator modes */
67
68/* generator flags
69 * - shared by Generator and Function Generator
70 */
72 /* generator works in conjunction with other modifiers (i.e. doesn't replace those before it) */
74};
75
76/* 'function' generator types */
85
86/* cycling modes */
97
98/* limiting flags */
100 FCM_LIMIT_XMIN = (1 << 0),
101 FCM_LIMIT_XMAX = (1 << 1),
102 FCM_LIMIT_YMIN = (1 << 2),
103 FCM_LIMIT_YMAX = (1 << 3),
104};
105
106/* modification modes */
117
118/* stepped modifier range flags */
125
126/* Drivers -------------------------------------- */
127
133
135enum eDriverTarget_Flag : short {
141
142 /* "local-space" flags. */
147
150
153};
155
156/* Transform Channels for Driver Targets */
172
173/* Rotation channel mode for Driver Targets */
199
204
205/* --- */
206
207/* maximum number of driver targets per variable */
208#define MAX_DRIVER_TARGETS 8
209
231
232/* Driver Variable Flags */
233enum eDriverVar_Flags : short {
234 /* variable is not set up correctly */
235 DVAR_FLAG_ERROR = (1 << 0),
236
237 /* variable name doesn't pass the validation tests */
239 /* name starts with a number */
241 /* name starts with a special character (!, $, @, #, _, etc.) */
243 /* name contains a space */
245 /* name contains a dot */
247 /* name contains invalid chars */
249 /* name is a reserved keyword */
251 /* name is zero-length */
253};
255
257#define DVAR_ALL_INVALID_FLAGS \
258 (DVAR_FLAG_INVALID_NAME | DVAR_FLAG_INVALID_START_NUM | DVAR_FLAG_INVALID_START_CHAR | \
259 DVAR_FLAG_INVALID_HAS_SPACE | DVAR_FLAG_INVALID_HAS_DOT | DVAR_FLAG_INVALID_HAS_SPECIAL | \
260 DVAR_FLAG_INVALID_PY_KEYWORD | DVAR_FLAG_INVALID_EMPTY)
261
262/* --- */
263
277
279enum eDriver_Flags : int {
284 /* TODO: this needs to be implemented at some stage or left out... */
285 // DRIVER_FLAG_LAYERING = (1 << 2),
290 /* Set if the driver cannot run because it uses Python which isn't allowed to execute. */
294};
296
297/* F-Curves -------------------------------------- */
298
300#define FCURVE_ACTIVE_KEYFRAME_NONE -1
301
302/* user-editable flags/settings */
303enum eFCurve_Flags : short {
305 FCURVE_VISIBLE = (1 << 0),
307 FCURVE_SELECTED = (1 << 1),
309 FCURVE_ACTIVE = (1 << 2),
313 FCURVE_MUTED = (1 << 4),
314
317 FCURVE_AUTO_HANDLES = (1 << 5), /* Dirty. */
318#endif
319 FCURVE_MOD_OFF = (1 << 6),
322 FCURVE_DISABLED = (1 << 10),
324 FCURVE_INT_VALUES = (1 << 11),
328
330 FCURVE_TAGGED = static_cast<short>(1 << 15),
331};
333
334/* extrapolation modes (only simple value 'extending') */
341
342/* curve coloring modes */
353
354/* curve smoothing modes */
361
362/* ************************************************ */
363/* 'Action' Data-types */
364
365/* NOTE: Although these are part of the Animation System,
366 * they are not stored here, see `DNA_action_types.h` instead. */
367
368/* ************************************************ */
369/* NLA - Non-Linear Animation */
370
371/* NLA Strips ------------------------------------- */
372
373/* NLA Strip Blending Mode */
381
384 /* extend before first frame if no previous strips in track,
385 * and always hold+extend last frame */
387 /* only hold+extend last frame */
389 /* don't contribute at all */
391};
392
395 /* UI selection flags */
398 /* NLA strip is selected for editing */
400 // NLASTRIP_FLAG_SELECT_L = (1 << 2), /* left handle selected. */
401 // NLASTRIP_FLAG_SELECT_R = (1 << 3), /* right handle selected. */
402
408
409 /* controls driven by local F-Curves */
414
417
418 /* playback flags (may be overridden by F-Curves) */
426 /* NLASTRIP_FLAG_MIRROR = (1 << 13), */ /* UNUSED */
427
428 /* temporary editing flags */
429
441};
443
444/* NLA Strip Type */
445enum eNlaStrip_Type : short {
446 /* 'clip' - references an Action */
448 /* 'transition' - blends between the adjacent strips */
450 /* 'meta' - a strip which acts as a container for a few others */
452
453 /* 'emit sound' - a strip which is used for timing when speaker emits sounds */
455};
456
457/* NLA Tracks ------------------------------------- */
458
459/* settings for track */
460enum eNlaTrack_Flag : int {
463 NLATRACK_ACTIVE = (1 << 0),
467 NLATRACK_MUTED = (1 << 2),
469 NLATRACK_SOLO = (1 << 3),
472
475 NLATRACK_DISABLED = (1 << 10),
476
480
484};
486
487/* ************************************ */
488/* KeyingSet Data-types */
489
490/* KeyingSet settings */
491enum eKS_Settings : short {
493 /* KEYINGSET_BUILTIN = (1 << 0), */ /* UNUSED */
496};
498
499/* Flags for use by keyframe creation/deletion calls */
500enum eInsertKeyFlags : short {
507 INSERTKEY_FAST = (1 << 2),
509 /* INSERTKEY_FASTR = (1 << 3), */ /* UNUSED */
524};
526
527/* KS_Path->flag */
528enum eKSP_Settings : short {
529 /* entire array (not just the specified index) gets keyframed */
531};
533
534/* KS_Path->groupmode */
535enum eKSP_Grouping : short {
544 /* KSP_GROUP_TEMPLATE_ITEM, */ /* UNUSED */
545};
546
547/* ************************************************ */
548/* Animation Data */
549
550/* AnimData ------------------------------------- */
551
552/* Animation Data settings (mostly for NLA) */
553enum eAnimData_Flag : int {
559 ADT_NLA_EDIT_ON = (1 << 2),
564 /* Evaluate tracks above tweaked strip. Only relevant in tweak mode. */
566
570 /* ADT_DRIVERS_DISABLED = (1 << 11), */ /* UNUSED */
571
573 ADT_UI_SELECTED = (1 << 14),
575 ADT_UI_ACTIVE = (1 << 15),
576
579
582
585 ADT_UI_EXPANDED = (1 << 18),
586};
588
589/* From: `DNA_object_types.h`, see its docstring there. */
590#define SELECT 1
591
592} // namespace blender
#define ENUM_OPERATORS(_enum_type)
ENUM_OPERATORS(Layer::Flags)
BMesh Iterators.
@ DVAR_TYPE_TRANSFORM_CHAN
@ DVAR_TYPE_SINGLE_PROP
@ DVAR_TYPE_CONTEXT_PROP
@ NLATRACK_OVERRIDELIBRARY_LOCAL
@ NLATRACK_TEMPORARILY_ADDED
@ DRIVER_FLAG_PYTHON_BLOCKED
@ DRIVER_FLAG_RENAMEVAR
@ DRIVER_FLAG_RECOMPILE
@ DRIVER_FLAG_DEPRECATED
@ DRIVER_FLAG_INVALID
@ DRIVER_FLAG_USE_SELF
@ NLASTRIP_FLAG_USR_INFLUENCE
@ NLASTRIP_FLAG_REVERSE
@ NLASTRIP_FLAG_USR_TIME
@ NLASTRIP_FLAG_NO_TIME_MAP
@ NLASTRIP_FLAG_USR_TIME_CYCLIC
@ NLASTRIP_FLAG_SELECT
@ NLASTRIP_FLAG_TWEAKUSER
@ NLASTRIP_FLAG_EDIT_TOUCHED
@ NLASTRIP_FLAG_ACTIVE
@ NLASTRIP_FLAG_MUTED
@ NLASTRIP_FLAG_SYNC_LENGTH
@ NLASTRIP_FLAG_INVALID_LOCATION
@ NLASTRIP_FLAG_AUTO_BLENDS
@ NLASTRIP_FLAG_TEMP_META
@ FCM_GENERATOR_POLYNOMIAL
@ FCM_GENERATOR_POLYNOMIAL_FACTORISED
eNlaStrip_Extrapolate_Mode
@ NLASTRIP_EXTEND_NOTHING
@ NLASTRIP_EXTEND_HOLD_FORWARD
@ NLASTRIP_EXTEND_HOLD
@ ADT_CURVES_NOT_VISIBLE
@ ADT_CURVES_ALWAYS_VISIBLE
@ ADT_NLA_EVAL_UPPER_TRACKS
@ ADT_NLA_SKEYS_COLLAPSED
@ ADT_DRIVERS_COLLAPSED
eDriverTarget_RotationMode
@ DTAR_ROTMODE_QUATERNION
@ DTAR_ROTMODE_EULER_YXZ
@ DTAR_ROTMODE_EULER_XZY
@ DTAR_ROTMODE_SWING_TWIST_Y
@ DTAR_ROTMODE_EULER_ZYX
@ DTAR_ROTMODE_EULER_ZXY
@ DTAR_ROTMODE_SWING_TWIST_Z
@ DTAR_ROTMODE_EULER_XYZ
@ DTAR_ROTMODE_EULER_YZX
@ DTAR_ROTMODE_EULER_MAX
@ DTAR_ROTMODE_SWING_TWIST_X
@ DTAR_ROTMODE_EULER_MIN
@ DRIVER_TYPE_AVERAGE
eFMod_Noise_Modifications
@ FCM_NOISE_MODIF_REPLACE
@ FCM_NOISE_MODIF_SUBTRACT
@ FCM_NOISE_MODIF_ADD
@ FCM_NOISE_MODIF_MULTIPLY
@ FMODIFIER_TYPE_ENVELOPE
@ FMODIFIER_TYPE_NULL
@ FMODIFIER_TYPE_STEPPED
@ FMODIFIER_TYPE_FN_GENERATOR
@ FMODIFIER_TYPE_LIMITS
@ FMODIFIER_TYPE_CYCLES
@ FMODIFIER_TYPE_FILTER
@ FMODIFIER_TYPE_SMOOTH
@ FMODIFIER_TYPE_GENERATOR
@ FMODIFIER_TYPE_NOISE
@ FMODIFIER_TYPE_PYTHON
@ FMODIFIER_NUM_TYPES
unsigned int uint32_t
Definition BKE_text.h:81
@ INSERTKEY_AVAILABLE
@ INSERTKEY_CYCLE_AWARE
@ INSERTKEY_NO_USERPREF
@ INSERTKEY_OVERWRITE_FULL
@ FCM_EXTRAPOLATE_MIRROR
@ FCM_EXTRAPOLATE_NONE
@ FCM_EXTRAPOLATE_CYCLIC_OFFSET
@ FCM_EXTRAPOLATE_CYCLIC
eDriverTarget_ContextProperty
@ DTAR_CONTEXT_PROPERTY_ACTIVE_SCENE
@ DTAR_CONTEXT_PROPERTY_ACTIVE_VIEW_LAYER
@ NLASTRIP_TYPE_SOUND
@ NLASTRIP_TYPE_TRANSITION
@ DTAR_OPTION_USE_FALLBACK
@ NLASTRIP_MODE_MULTIPLY
@ NLASTRIP_MODE_REPLACE
@ NLASTRIP_MODE_SUBTRACT
@ NLASTRIP_MODE_COMBINE
@ FCURVE_DISCRETE_VALUES
@ FCM_STEPPED_NO_AFTER
@ FCM_STEPPED_NO_BEFORE
eFMod_Generator_Functions
@ FCM_GENERATOR_FN_SIN
@ FCM_GENERATOR_FN_SINC
@ FCM_GENERATOR_FN_LN
@ FCM_GENERATOR_FN_TAN
@ FCM_GENERATOR_FN_COS
@ FCM_GENERATOR_FN_SQRT
eDriverTarget_TransformChannels
@ DTAR_TRANSCHAN_ROTY
@ DTAR_TRANSCHAN_LOCY
@ DTAR_TRANSCHAN_SCALE_AVG
@ DTAR_TRANSCHAN_LOCX
@ DTAR_TRANSCHAN_SCALEX
@ DTAR_TRANSCHAN_ROTW
@ DTAR_TRANSCHAN_ROTX
@ MAX_DTAR_TRANSCHAN_TYPES
@ DTAR_TRANSCHAN_LOCZ
@ DTAR_TRANSCHAN_ROTZ
@ DTAR_TRANSCHAN_SCALEY
@ DTAR_TRANSCHAN_SCALEZ
@ FCURVE_SMOOTH_CONT_ACCEL
@ FCM_GENERATOR_ADDITIVE
@ FCURVE_COLOR_AUTO_YRGB
@ FCURVE_COLOR_CUSTOM
@ FCURVE_COLOR_AUTO_RGB
@ FCURVE_COLOR_AUTO_RAINBOW
@ DTAR_FLAG_LOCALSPACE
@ DTAR_FLAG_FALLBACK_USED
@ DTAR_FLAG_STRUCT_REF
@ DTAR_FLAG_ID_OB_ONLY
@ DTAR_FLAG_LOCAL_CONSTS
@ DVAR_FLAG_INVALID_HAS_DOT
@ DVAR_FLAG_INVALID_EMPTY
@ DVAR_FLAG_INVALID_NAME
@ DVAR_FLAG_INVALID_HAS_SPECIAL
@ DVAR_FLAG_INVALID_PY_KEYWORD
@ DVAR_FLAG_INVALID_HAS_SPACE
@ DVAR_FLAG_INVALID_START_NUM
@ DVAR_FLAG_INVALID_START_CHAR
@ FCURVE_EXTRAPOLATE_CONSTANT
@ FCURVE_EXTRAPOLATE_LINEAR
@ KSP_FLAG_WHOLE_ARRAY
@ FMODIFIER_FLAG_MUTED
@ FMODIFIER_FLAG_DISABLED
@ FMODIFIER_FLAG_RANGERESTRICT
@ FMODIFIER_FLAG_USEINFLUENCE
@ FMODIFIER_FLAG_ACTIVE
#define DNA_DEPRECATED_ALLOW
Definition versioning.cc:11