85 lines
2.9 KiB
C++
85 lines
2.9 KiB
C++
/* SPDX-FileCopyrightText: 2023 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup animrig
|
|
*
|
|
* \brief Functions to modify FCurves.
|
|
*/
|
|
#pragma once
|
|
|
|
#include "BLI_math_vector_types.hh"
|
|
#include "DNA_anim_types.h"
|
|
struct AnimData;
|
|
struct FCurve;
|
|
|
|
namespace blender::animrig {
|
|
|
|
/* 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;
|
|
};
|
|
|
|
/**
|
|
* Helper function to generate the KeyframeSettings struct.
|
|
*
|
|
* \param from_userprefs: if true read the user preferences for the settings, else return static
|
|
* defaults.
|
|
*/
|
|
KeyframeSettings get_keyframe_settings(bool from_userprefs);
|
|
|
|
/** Initialize the given BezTriple with default values. */
|
|
void initialize_bezt(BezTriple *beztr,
|
|
float2 position,
|
|
const KeyframeSettings &settings,
|
|
eFCurve_Flags fcu_flags);
|
|
|
|
/**
|
|
* \note The caller needs to run #BKE_nla_tweakedit_remap to get NLA relative frame.
|
|
* The caller should also check #BKE_fcurve_is_protected before keying.
|
|
*/
|
|
bool delete_keyframe_fcurve(AnimData *adt, FCurve *fcu, float cfra);
|
|
|
|
/**
|
|
* \brief Lesser Key-framing API call.
|
|
*
|
|
* Use this when validation of necessary animation data isn't necessary as it already
|
|
* exists, and there is a #BezTriple that can be directly copied into the array.
|
|
*
|
|
* This function adds a given #BezTriple to an F-Curve. It will allocate
|
|
* memory for the array if needed, and will insert the #BezTriple into a
|
|
* suitable place in chronological order.
|
|
*
|
|
* \returns The index of the keyframe array into which the bezt has been added.
|
|
*
|
|
* \note Any recalculate of the F-Curve that needs to be done will need to be done by the caller.
|
|
*/
|
|
int insert_bezt_fcurve(FCurve *fcu, const BezTriple *bezt, eInsertKeyFlags flag);
|
|
|
|
/**
|
|
* \brief Main Key-framing API call.
|
|
*
|
|
* Use this when validation of necessary animation data isn't necessary as it
|
|
* already exists. It will insert a keyframe using the current value being keyframed.
|
|
* Returns the index at which a keyframe was added (or -1 if failed).
|
|
*
|
|
* This function is a wrapper for #insert_bezt_fcurve(), and should be used when
|
|
* adding a new keyframe to a curve, when the keyframe doesn't exist anywhere else yet.
|
|
* It returns the index at which the keyframe was added.
|
|
*
|
|
* \returns The index of the keyframe array into which the bezt has been added.
|
|
*
|
|
* \param keyframe_type: The type of keyframe (#eBezTriple_KeyframeType).
|
|
* \param flag: Optional flags (#eInsertKeyFlags) for controlling how keys get added
|
|
* and/or whether updates get done.
|
|
*/
|
|
int insert_vert_fcurve(FCurve *fcu,
|
|
const float2 position,
|
|
const KeyframeSettings &settings,
|
|
eInsertKeyFlags flag);
|
|
|
|
} // namespace blender::animrig
|