BKE_nla.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2009 Blender Authors, Joshua Leung. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once


#define NLASTRIP_MIN_LEN_THRESH 0.1f
 
#include "DNA_listBase.h"
 
#include "BKE_action.hh"
#include "BKE_anim_data.hh"
 
#include "BLI_function_ref.hh"
 
struct AnimData;
struct ID;
struct LibraryForeachIDData;
struct Main;
struct NlaStrip;
struct NlaTrack;
struct Scene;
struct Speaker;
struct bAction;
 
struct BlendDataReader;
struct BlendWriter;
struct PointerRNA;
struct PropertyRNA;
 
/* ----------------------------- */
/* Data Management */

struct NlaTrack *BKE_nlatrack_new();

void BKE_nlastrip_free(NlaStrip *strip, bool do_id_user);
void BKE_nlatrack_free(NlaTrack *nlt, bool do_id_user);
void BKE_nla_tracks_free(ListBase *tracks, bool do_id_user);

NlaStrip *BKE_nlastrip_copy(Main *bmain, NlaStrip *strip, bool use_same_action, int flag);
NlaTrack *BKE_nlatrack_copy(Main *bmain, NlaTrack *nlt, bool use_same_actions, int flag);
void BKE_nla_tracks_copy(Main *bmain, ListBase *dst, const ListBase *src, int flag);

void BKE_nla_tracks_copy_from_adt(Main *bmain,
                                  AnimData *adt_dest,
                                  const AnimData *adt_source,
                                  int flag);

void BKE_nlatrack_insert_before(ListBase *nla_tracks,
                                NlaTrack *next,
                                NlaTrack *new_track,
                                bool is_liboverride);

void BKE_nlatrack_insert_after(ListBase *nla_tracks,
                               NlaTrack *prev,
                               NlaTrack *new_track,
                               bool is_liboverride);

NlaTrack *BKE_nlatrack_new_before(ListBase *nla_tracks, NlaTrack *next, bool is_liboverride);

NlaTrack *BKE_nlatrack_new_after(ListBase *nla_tracks, NlaTrack *prev, bool is_liboverride);

NlaTrack *BKE_nlatrack_new_head(ListBase *nla_tracks, bool is_liboverride);

NlaTrack *BKE_nlatrack_new_tail(ListBase *nla_tracks, const bool is_liboverride);

void BKE_nlatrack_remove(ListBase *tracks, NlaTrack *nlt);

void BKE_nlatrack_remove_and_free(ListBase *tracks, NlaTrack *nlt, bool do_id_user);

bool BKE_nlatrack_is_enabled(const AnimData &adt, const NlaTrack &nlt);

float BKE_nla_clip_length_get_nonzero(const NlaStrip *strip);

void BKE_nla_clip_length_ensure_nonzero(const float *actstart, float *r_actend);

NlaStrip *BKE_nlastrip_new(bAction *act, ID &animated_id);

NlaStrip *BKE_nlastrip_new_for_slot(bAction *act,
                                    blender::animrig::slot_handle_t slot_handle,
                                    ID &animated_id);
 
/*
 * Removes the given NLA strip from the list of strips provided.
 */
void BKE_nlastrip_remove(ListBase *strips, NlaStrip *strip);
 
/*
 * Removes the given NLA strip from the list of strips provided, and frees it's memory.
 */
void BKE_nlastrip_remove_and_free(ListBase *strips, NlaStrip *strip, const bool do_id_user);

NlaStrip *BKE_nlastack_add_strip(OwnedAnimData owned_adt, const bool is_liboverride);

NlaStrip *BKE_nla_add_soundstrip(Main *bmain, Scene *scene, Speaker *speaker);

void BKE_nla_strip_foreach_id(NlaStrip *strip, LibraryForeachIDData *data);
 
/* ----------------------------- */
/* API */

bool BKE_nlastrips_has_space(ListBase *strips, float start, float end);
void BKE_nlastrips_sort_strips(ListBase *strips);

void BKE_nlastrips_add_strip_unsafe(ListBase *strips, NlaStrip *strip);

bool BKE_nlastrips_add_strip(ListBase *strips, NlaStrip *strip);

void BKE_nlastrips_make_metas(ListBase *strips, bool is_temp);
void BKE_nlastrips_clear_metas(ListBase *strips, bool only_sel, bool only_temp);
void BKE_nlastrips_clear_metastrip(ListBase *strips, NlaStrip *strip);
bool BKE_nlameta_add_strip(NlaStrip *mstrip, NlaStrip *strip);
void BKE_nlameta_flush_transforms(NlaStrip *mstrip);
 
/* ............ */

NlaTrack *BKE_nlatrack_find_active(ListBase *tracks);
void BKE_nlatrack_set_active(ListBase *tracks, NlaTrack *nlt);

NlaTrack *BKE_nlatrack_find_tweaked(AnimData *adt);

void BKE_nlatrack_solo_toggle(AnimData *adt, NlaTrack *nlt);

bool BKE_nlatrack_has_space(NlaTrack *nlt, float start, float end);

bool BKE_nlatrack_has_strips(ListBase *tracks);

void BKE_nlatrack_sort_strips(NlaTrack *nlt);

bool BKE_nlatrack_add_strip(NlaTrack *nlt, NlaStrip *strip, bool is_liboverride);

void BKE_nlatrack_remove_strip(NlaTrack *track, NlaStrip *strip);

bool BKE_nlatrack_get_bounds(NlaTrack *nlt, float bounds[2]);
bool BKE_nlatrack_is_nonlocal_in_liboverride(const ID *id, const NlaTrack *nlt);
 
/* ............ */

float BKE_nlastrip_compute_frame_from_previous_strip(NlaStrip *strip);
float BKE_nlastrip_compute_frame_to_next_strip(NlaStrip *strip);

NlaStrip *BKE_nlastrip_next_in_track(NlaStrip *strip, bool skip_transitions);

NlaStrip *BKE_nlastrip_prev_in_track(NlaStrip *strip, bool skip_transitions);
 
/* ............ */

NlaStrip *BKE_nlastrip_find_active(NlaTrack *nlt);
void BKE_nlastrip_set_active(AnimData *adt, NlaStrip *strip);
NlaStrip *BKE_nlastrip_find_by_name(NlaTrack *nlt, const char *name);

bool BKE_nlastrip_within_bounds(NlaStrip *strip, float min, float max);
float BKE_nlastrip_distance_to_frame(const NlaStrip *strip, float timeline_frame);
void BKE_nlastrip_recalculate_bounds(NlaStrip *strip);
void BKE_nlastrip_recalculate_bounds_sync_action(NlaStrip *strip);

void BKE_nlastrip_recalculate_blend(NlaStrip *strip);

void BKE_nlastrip_validate_name(AnimData *adt, NlaStrip *strip);
 
/* ............ */

bool BKE_nlatrack_has_animated_strips(NlaTrack *nlt);
bool BKE_nlatracks_have_animated_strips(ListBase *tracks);
void BKE_nlastrip_validate_fcurves(NlaStrip *strip);

bool BKE_nlastrip_controlcurve_remove(NlaStrip *strip, FCurve *fcurve);

bool BKE_nlastrip_has_curves_for_property(const PointerRNA *ptr, const PropertyRNA *prop);

void BKE_nla_validate_state(AnimData *adt);
 
/* ............ */

bool BKE_nla_action_slot_is_stashed(AnimData *adt,
                                    bAction *act,
                                    blender::animrig::slot_handle_t slot_handle);
bool BKE_nla_action_stash(OwnedAnimData owned_adt, bool is_liboverride);
 
/* ............ */

void BKE_nla_action_pushdown(OwnedAnimData owned_adt, bool is_liboverride);

bool BKE_nla_tweakmode_enter(OwnedAnimData owned_adt);
void BKE_nla_tweakmode_exit(OwnedAnimData owned_adt);

void BKE_nla_tweakmode_clear_flags(AnimData *adt);

void BKE_nla_tweakmode_exit_nofollowptr(AnimData *adt);
 
/* ----------------------------- */
/* Time Mapping */
 
/* time mapping conversion modes */
enum eNlaTime_ConvertModes {
  /* convert from global time to strip time - for evaluation */
  NLATIME_CONVERT_EVAL = 0,
  /* convert from global time to strip time - for editing corrections */
  /* XXX: old 0 invert. */
  NLATIME_CONVERT_UNMAP,
  /* convert from strip time to global time */
  /* XXX: old 1 invert. */
  NLATIME_CONVERT_MAP,
};

float BKE_nla_tweakedit_remap(AnimData *adt, float cframe, eNlaTime_ConvertModes mode);
 
/* ----------------------------- */
/* .blend file API */
 
void BKE_nla_blend_write(BlendWriter *writer, ListBase *tracks);
void BKE_nla_blend_read_data(BlendDataReader *reader, ID *id_owner, ListBase *tracks);

void BKE_nla_liboverride_post_process(ID *id, AnimData *adt);

void BKE_nla_debug_print_flags(AnimData *adt, ID *owner_id);
 
namespace blender::bke::nla {

bool foreach_strip(ID *id, blender::FunctionRef<bool(NlaStrip *)> callback);

bool foreach_strip_adt(const AnimData &adt, blender::FunctionRef<bool(NlaStrip *)> callback);
 
}  // namespace blender::bke::nla