DNA_key_types.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 */
#pragma once
 
#include "DNA_ID.h"
#include "DNA_defs.h"
#include "DNA_listBase.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct AnimData;
struct Ipo;
 
typedef struct KeyBlock {
  struct KeyBlock *next, *prev;
 
  float pos;
  float curval;
 
  short type;
  char _pad1[2];
 
  short relative;
  short flag;
 
  int totelem;
  int uid;
 
  void *data;
  char name[64];
  char vgroup[64];
 
  float slidermin;
  float slidermax;
 
} KeyBlock;
 
typedef struct Key {
  ID id;
  struct AnimData *adt;
 
  KeyBlock *refkey;
 
  char elemstr[32];
  int elemsize;
  char _pad[4];
 
  ListBase block;
  struct Ipo *ipo DNA_DEPRECATED;
 
  ID *from;
 
  int totkey;
  short flag;
  char type;
  char _pad2;
 
  float ctime;
 
  int uidgen;
} Key;
 
/* **************** KEY ********************* */
 
/* Key->type: KeyBlocks are interpreted as... */
enum {
  /* Sequential positions over time (using KeyBlock->pos and Key->ctime) */
  KEY_NORMAL = 0,
 
  /* States to blend between (default) */
  KEY_RELATIVE = 1,
};
 
/* Key->flag */
enum {
  KEY_DS_EXPAND = 1,
};
 
/* KeyBlock->type */
enum {
  KEY_LINEAR = 0,
  KEY_CARDINAL = 1,
  KEY_BSPLINE = 2,
  KEY_CATMULL_ROM = 3,
};
 
/* KeyBlock->flag */
enum {
  KEYBLOCK_MUTE = (1 << 0),
  KEYBLOCK_SEL = (1 << 1),
  KEYBLOCK_LOCKED = (1 << 2),
};
 
#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)
 
#ifdef __cplusplus
}
#endif