ANIM_keyframing.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include <array>
#include <string>
 
#include "BLI_array.hh"
#include "BLI_bit_span.hh"
#include "BLI_string_ref.hh"
#include "BLI_vector.hh"
 
#include "DNA_anim_types.h"
#include "DNA_windowmanager_types.h"
 
#include "RNA_path.hh"
#include "RNA_types.hh"
 
struct ID;
struct Main;
struct Scene;
 
struct AnimationEvalContext;
struct NlaKeyframingContext;
 
namespace blender::animrig {
 
enum class SingleKeyingResult {
  SUCCESS = 0,
  /* TODO: remove `UNKNOWN_FAILURE` and replace all usages with proper, specific
   * cases. This is needed right now as a stop-gap while progressively moving
   * the keyframing code over to propagate errors properly.*/
  UNKNOWN_FAILURE,
  CANNOT_CREATE_FCURVE,
  FCURVE_NOT_KEYFRAMEABLE,
  NO_KEY_NEEDED,
  UNABLE_TO_INSERT_TO_NLA_STACK,
  ID_NOT_EDITABLE,
  ID_NOT_ANIMATABLE,
  NO_VALID_LAYER,
  NO_VALID_STRIP,
  NO_VALID_SLOT,
  CANNOT_RESOLVE_PATH,
  /* Make sure to always keep this at the end of the enum. */
  _KEYING_RESULT_MAX,
};
 
class CombinedKeyingResult {
 private:
  /* The index to the array maps a `SingleKeyingResult` to the number of times this result has
   * occurred. */
  std::array<int, size_t(SingleKeyingResult::_KEYING_RESULT_MAX)> result_counter;
 
 public:
  CombinedKeyingResult();
 
  void add(SingleKeyingResult result, int count = 1);
 
  /* Add values of the given result to this result. */
  void merge(const CombinedKeyingResult &other);
 
  int get_count(const SingleKeyingResult result) const;
 
  bool has_errors() const;
 
  void generate_reports(ReportList *reports, eReportType report_level = RPT_ERROR);
};
 
const std::optional<StringRefNull> default_channel_group_for_path(
    const PointerRNA *animated_struct, const StringRef prop_rna_path);
 
/* -------------------------------------------------------------------- */
 
bool key_insertion_may_create_fcurve(eInsertKeyFlags insert_key_flags);
 
/* -------------------------------------------------------------------- */
/* Set the FCurve flag based on the property type of `prop`. */
void update_autoflags_fcurve_direct(FCurve *fcu, PropertyRNA *prop);
 
CombinedKeyingResult insert_keyframes(Main *bmain,
                                      PointerRNA *struct_pointer,
                                      std::optional<StringRefNull> channel_group,
                                      const blender::Span<RNAPath> rna_paths,
                                      std::optional<float> scene_frame,
                                      const AnimationEvalContext &anim_eval_context,
                                      eBezTriple_KeyframeType key_type,
                                      eInsertKeyFlags insert_key_flags);
 
bool insert_keyframe_direct(ReportList *reports,
                            PointerRNA ptr,
                            PropertyRNA *prop,
                            FCurve *fcu,
                            const AnimationEvalContext *anim_eval_context,
                            eBezTriple_KeyframeType keytype,
                            NlaKeyframingContext *nla_context,
                            eInsertKeyFlags flag);
 
int delete_keyframe(Main *bmain, ReportList *reports, ID *id, const RNAPath &rna_path, float cfra);
 
int clear_keyframe(Main *bmain, ReportList *reports, ID *id, const RNAPath &rna_path);
 
bool is_keying_flag(const Scene *scene, eKeying_Flag flag);
 
eInsertKeyFlags get_keyframing_flags(Scene *scene);
 
/* -------------------------------------------------------------------- */
bool is_autokey_on(const Scene *scene);
 
bool is_autokey_mode(const Scene *scene, eAutokey_Mode mode);
 
bool autokeyframe_cfra_can_key(const Scene *scene, ID *id);
 
void autokeyframe_object(bContext *C, Scene *scene, Object *ob, Span<RNAPath> rna_paths);
bool autokeyframe_object(bContext *C, Scene *scene, Object *ob, KeyingSet *ks);
bool autokeyframe_pchan(bContext *C, Scene *scene, Object *ob, bPoseChannel *pchan, KeyingSet *ks);
void autokeyframe_pose_channel(bContext *C,
                               Scene *scene,
                               Object *ob,
                               bPoseChannel *pose_channel,
                               Span<RNAPath> rna_paths,
                               short targetless_ik);
bool autokeyframe_property(bContext *C,
                           Scene *scene,
                           PointerRNA *ptr,
                           PropertyRNA *prop,
                           int rnaindex,
                           float cfra,
                           bool only_if_property_keyed);
 
}  // namespace blender::animrig