nla_private.h

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
 
#include "BLI_bitmap.h"
#include "BLI_ghash.h"
 
#include "DNA_anim_types.h"
#include "DNA_listBase.h"
 
#include "RNA_types.hh"
 
struct AnimationEvalContext;
 
/* --------------- NLA Evaluation DataTypes ----------------------- */

typedef struct NlaEvalStrip {
  struct NlaEvalStrip *next, *prev;

  NlaTrack *track;
  NlaStrip *strip;

  short track_index;
  short strip_mode;

  float strip_time;
} NlaEvalStrip;

enum eNlaEvalStrip_StripMode {
  /* standard evaluation */
  NES_TIME_BEFORE = -1,
  NES_TIME_WITHIN,
  NES_TIME_AFTER,
 
  /* transition-strip evaluations */
  NES_TIME_TRANSITION_START,
  NES_TIME_TRANSITION_END,
};
 
struct NlaEvalChannel;
struct NlaEvalData;

typedef struct NlaEvalChannelKey {
  struct PointerRNA ptr;
  struct PropertyRNA *prop;
} NlaEvalChannelKey;

typedef struct NlaValidMask {
  BLI_bitmap *ptr;
  BLI_bitmap buffer[sizeof(uint64_t) / sizeof(BLI_bitmap)];
} NlaValidMask;

typedef struct NlaEvalChannelSnapshot {
  struct NlaEvalChannel *channel;

  NlaValidMask blend_domain;

  NlaValidMask remap_domain;
 
  int length;   /* Number of values in the property. */
  bool is_base; /* Base snapshot of the channel. */
 
  float values[]; /* Item values. */
  /* Memory over-allocated to provide space for values. */
} NlaEvalChannelSnapshot;

enum eNlaEvalChannel_MixMode {
  NEC_MIX_ADD,
  NEC_MIX_MULTIPLY,
  NEC_MIX_QUATERNION,
  NEC_MIX_AXIS_ANGLE,
};

typedef struct NlaEvalChannel {
  struct NlaEvalChannel *next, *prev;
  struct NlaEvalData *owner;
 
  /* Original RNA path string and property key. */
  const char *rna_path;
  NlaEvalChannelKey key;
 
  int index;
  bool is_array;
  char mix_mode;
 
  /* Associated with the RNA property's value(s), marks which elements are affected by NLA. */
  NlaValidMask domain;
 
  /* Base set of values. */
  NlaEvalChannelSnapshot base_snapshot;
  /* Memory over-allocated to provide space for base_snapshot.values. */
} NlaEvalChannel;

typedef struct NlaEvalSnapshot {
  /* Snapshot this one defaults to. */
  struct NlaEvalSnapshot *base;
 
  int size;
  NlaEvalChannelSnapshot **channels;
} NlaEvalSnapshot;

typedef struct NlaEvalData {
  ListBase channels;
 
  /* Mapping of paths and NlaEvalChannelKeys to channels. */
  GHash *path_hash;
  GHash *key_hash;
 
  /* Base snapshot. */
  int num_channels;
  NlaEvalSnapshot base_snapshot;
 
  /* Evaluation result snapshot. */
  NlaEvalSnapshot eval_snapshot;
} NlaEvalData;

typedef struct NlaKeyframingContext {
  struct NlaKeyframingContext *next, *prev;
 
  /* AnimData for which this context was built. */
  struct AnimData *adt;
 
  /* Data of the currently edited strip (copy, or fake strip for the main action). */
  NlaStrip strip;
  NlaEvalStrip *eval_strip;
  /* Storage for the action track as a strip. */
  NlaStrip action_track_strip;
 
  /* Strips above tweaked strip. */
  ListBase upper_estrips;
  /* Evaluated NLA stack below the tweak strip. */
  NlaEvalData lower_eval_data;
} NlaKeyframingContext;
 
/* --------------- NLA Functions (not to be used as a proper API) ----------------------- */

float nlastrip_get_frame(NlaStrip *strip, float cframe, short mode);
 
/* --------------- NLA Evaluation (very-private stuff) ----------------------- */
/* these functions are only defined here to avoid problems with the order
 * in which they get defined. */

NlaEvalStrip *nlastrips_ctime_get_strip(ListBase *list,
                                        ListBase *strips,
                                        short index,
                                        const struct AnimationEvalContext *anim_eval_context,
                                        bool flush_to_original);
 
enum eNlaStripEvaluate_Mode {
  STRIP_EVAL_BLEND,
  STRIP_EVAL_BLEND_GET_INVERTED_LOWER_SNAPSHOT,
  STRIP_EVAL_NOBLEND,
};
 
void nlastrip_evaluate(const int evaluation_mode,
                       PointerRNA *ptr,
                       NlaEvalData *channels,
                       ListBase *modifiers,
                       NlaEvalStrip *nes,
                       NlaEvalSnapshot *snapshot,
                       const struct AnimationEvalContext *anim_eval_context,
                       bool flush_to_original);
void nladata_flush_channels(PointerRNA *ptr,
                            NlaEvalData *channels,
                            NlaEvalSnapshot *snapshot,
                            bool flush_to_original);
 
void nlasnapshot_enable_all_blend_domain(NlaEvalSnapshot *snapshot);
 
void nlasnapshot_ensure_channels(NlaEvalData *eval_data, NlaEvalSnapshot *snapshot);

void nlasnapshot_blend(NlaEvalData *eval_data,
                       NlaEvalSnapshot *lower_snapshot,
                       NlaEvalSnapshot *upper_snapshot,
                       short upper_blendmode,
                       float upper_influence,
                       NlaEvalSnapshot *r_blended_snapshot);

void nlasnapshot_blend_get_inverted_upper_snapshot(NlaEvalData *eval_data,
                                                   NlaEvalSnapshot *lower_snapshot,
                                                   NlaEvalSnapshot *blended_snapshot,
                                                   short upper_blendmode,
                                                   float upper_influence,
                                                   NlaEvalSnapshot *r_upper_snapshot);

void nlasnapshot_blend_get_inverted_lower_snapshot(NlaEvalData *eval_data,
                                                   NlaEvalSnapshot *blended_snapshot,
                                                   NlaEvalSnapshot *upper_snapshot,
                                                   const short upper_blendmode,
                                                   const float upper_influence,
                                                   NlaEvalSnapshot *r_lower_snapshot);
 
void nlasnapshot_blend_strip(PointerRNA *ptr,
                             NlaEvalData *channels,
                             ListBase *modifiers,
                             NlaEvalStrip *nes,
                             NlaEvalSnapshot *snapshot,
                             const struct AnimationEvalContext *anim_eval_context,
                             const bool flush_to_original);
 
void nlasnapshot_blend_strip_get_inverted_lower_snapshot(
    PointerRNA *ptr,
    NlaEvalData *channels,
    ListBase *modifiers,
    NlaEvalStrip *nes,
    NlaEvalSnapshot *snapshot,
    const struct AnimationEvalContext *anim_eval_context);
 
void nlasnapshot_blend_strip_no_blend(PointerRNA *ptr,
                                      NlaEvalData *channels,
                                      ListBase *modifiers,
                                      NlaEvalStrip *nes,
                                      NlaEvalSnapshot *snapshot,
                                      const struct AnimationEvalContext *anim_eval_context);