DNA_key_types.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
#pragma once

 
#include "DNA_ID.h"
#include "DNA_defs.h"
#include "DNA_listBase.h"
 
struct AnimData;

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

  float pos;
  float curval;

  short type;
  char _pad1[2];

  short relative;
  /* KeyBlockFlag */
  short flag;

  int totelem;
  int uid;

  void *data;
  char name[/*MAX_NAME*/ 64];
  char vgroup[/*MAX_VGROUP_NAME*/ 64];

  float slidermin;
  float slidermax;
 
} KeyBlock;
 
typedef struct Key {
#ifdef __cplusplus
  static constexpr ID_Type id_type = ID_KE;
#endif
 
  ID id;
  struct AnimData *adt;

  KeyBlock *refkey;

  char elemstr[32];
  int elemsize;
  char _pad[4];

  ListBase block;
 
  ID *from;

  int totkey;
  /* ShapekeyContainerFlag */
  short flag;
  char type;
  char _pad2;

  float ctime;

  int uidgen;
} Key;
 
/* **************** KEY ********************* */
 
/* Key::type: KeyBlocks are interpreted as... */
typedef enum ShapekeyContainerType {
  /* Sequential positions over time (using KeyBlock::pos and Key::ctime) */
  KEY_NORMAL = 0,
 
  /* States to blend between (default) */
  KEY_RELATIVE = 1,
} ShapekeyContainerType;
 
/* Key::flag */
typedef enum ShapekeyContainerFlag {
  KEY_DS_EXPAND = 1,
} ShapekeyContainerFlag;
 
/* The obvious name would be `KeyBlockType` but this enum is actually used in places outside of
 * Shape Keys (NURBS, particles, etc.). */
typedef enum KeyInterpolationType {
  KEY_LINEAR = 0,
  KEY_CARDINAL = 1,
  KEY_BSPLINE = 2,
  KEY_CATMULL_ROM = 3,
} KeyInterpolationType;
 
typedef enum KeyBlockFlag {
  KEYBLOCK_MUTE = (1 << 0),
  KEYBLOCK_SEL = (1 << 1),
  KEYBLOCK_LOCKED = (1 << 2),
  KEYBLOCK_LOCKED_SHAPE = (1 << 3),
} KeyBlockFlag;
 
#define KEYELEM_FLOAT_LEN_COORD 3
 
/* Curve key data layout constants */
#define KEYELEM_ELEM_SIZE_CURVE 3
 
#define KEYELEM_ELEM_LEN_BPOINT 2
#define KEYELEM_FLOAT_LEN_BPOINT (KEYELEM_ELEM_LEN_BPOINT * KEYELEM_ELEM_SIZE_CURVE)
 
#define KEYELEM_ELEM_LEN_BEZTRIPLE 4
#define KEYELEM_FLOAT_LEN_BEZTRIPLE (KEYELEM_ELEM_LEN_BEZTRIPLE * KEYELEM_ELEM_SIZE_CURVE)