ANIM_fcurve.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

#pragma once
 
#include "ANIM_keyframing.hh"
 
#include "BLI_math_vector_types.hh"
#include "BLI_string_ref.hh"
 
#include "DNA_anim_types.h"
 
struct AnimData;
struct FCurve;
 
namespace blender::animrig {

struct FCurveDescriptor {
  StringRefNull rna_path;
  int array_index;
  std::optional<PropertyType> prop_type;
  std::optional<PropertySubType> prop_subtype;
  std::optional<blender::StringRefNull> channel_group;
};
 
/* This is used to pass in the settings for a keyframe into a function. */
struct KeyframeSettings {
  eBezTriple_KeyframeType keyframe_type;
  eBezTriple_Handle handle;
  eBezTriple_Interpolation interpolation;
};

KeyframeSettings get_keyframe_settings(bool from_userprefs);

const FCurve *fcurve_find(Span<const FCurve *> fcurves, const FCurveDescriptor &fcurve_descriptor);
FCurve *fcurve_find(Span<FCurve *> fcurves, const FCurveDescriptor &fcurve_descriptor);

FCurve *create_fcurve_for_channel(const FCurveDescriptor &fcurve_descriptor);

eFCurve_Flags fcurve_flags_for_property_type(PropertyType prop_type);

void initialize_bezt(BezTriple *beztr,
                     float2 position,
                     const KeyframeSettings &settings,
                     eFCurve_Flags fcu_flags);

bool fcurve_delete_keyframe_at_time(FCurve *fcurve, float time);

bool delete_keyframe_fcurve_legacy(AnimData *adt, FCurve *fcu, float cfra);

int insert_bezt_fcurve(FCurve *fcu, const BezTriple *bezt, eInsertKeyFlags flag);

SingleKeyingResult insert_vert_fcurve(FCurve *fcu,
                                      const float2 position,
                                      const KeyframeSettings &settings,
                                      eInsertKeyFlags flag);

void sample_fcurve_segment(
    const FCurve *fcu, float start_frame, float sample_rate, float *samples, int sample_count);
 
enum class BakeCurveRemove {
  NONE = 0,
  IN_RANGE = 1,
  OUT_RANGE = 2,
  ALL = 3,
};

void bake_fcurve(FCurve *fcu, blender::int2 range, float step, BakeCurveRemove remove_existing);

void bake_fcurve_segments(FCurve *fcu);

bool fcurve_frame_has_keyframe(const FCurve *fcu, float frame);
 
}  // namespace blender::animrig