DNA_curve_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_curve_enums.h"
#include "DNA_defs.h"
#include "DNA_listBase.h"
#include "DNA_vec_types.h"
 
#ifdef __cplusplus
#  include <optional>
#endif
 
struct AnimData;
struct Curves;
struct CurveProfile;
struct EditFont;
struct GHash;
struct Ipo;
struct Key;
struct Material;
struct Object;
struct VFont;
 
/* These two Lines with # tell `makesdna` this struct can be excluded. */
#
#
typedef struct BevPoint {
  float vec[3], tilt, radius, weight, offset;
  float sina, cosa;
  float dir[3], tan[3], quat[4];
  short dupe_tag;
} BevPoint;
 
/* These two Lines with # tell `makesdna` this struct can be excluded. */
#
#
typedef struct BevList {
  struct BevList *next, *prev;
  int nr, dupe_nr;
  int poly;
  int hole;
  int charidx;
  int *segbevcount;
  float *seglen;
  BevPoint *bevpoints;
} BevList;

typedef struct BezTriple {
  float vec[3][3];
  float tilt;
  float weight;
  float radius;

  char ipo;

  uint8_t h1, h2;
  uint8_t f1, f2, f3;

  char hide;

  char easing;
  float back;
  float amplitude, period;

  char auto_handle_type;
  char _pad[3];
} BezTriple;

#define BEZKEYTYPE(bezt) (eBezTriple_KeyframeType((bezt)->hide))
#define BEZKEYTYPE_LVALUE(bezt) ((bezt)->hide)

typedef struct BPoint {
  float vec[4];
  float tilt;
  float weight;
  uint8_t f1;
  char _pad1[1];
  short hide;
  float radius;
  char _pad[4];
} BPoint;

typedef struct Nurb {
  DNA_DEFINE_CXX_METHODS(Nurb)
 
  
  struct Nurb *next, *prev;
  short type;
  short mat_nr;
  short hide, flag;
  int pntsu, pntsv;
  char _pad[4];
  short resolu, resolv;
  short orderu, orderv;
  short flagu, flagv;
 
  float *knotsu, *knotsv;
  BPoint *bp;
  BezTriple *bezt;

  short tilt_interp;
  short radius_interp;
 
  /* only used for dynamically generated Nurbs created from OB_FONT's */
  int charidx;
} Nurb;
 
typedef struct CharInfo {
  float kern;
  short mat_nr;
  char flag;
  char _pad[1];
} CharInfo;
 
typedef struct TextBox {
  float x, y, w, h;
} TextBox;
 
/* These two Lines with # tell `makesdna` this struct can be excluded. */
#
#
typedef struct EditNurb {
  DNA_DEFINE_CXX_METHODS(EditNurb)
 
  /* base of nurbs' list (old Curve->editnurb) */
  ListBase nurbs;
 
  /* index data for shape keys */
  struct GHash *keyindex;
 
  /* shape key being edited */
  int shapenr;

  char needs_flush_to_id;
 
} EditNurb;
 
typedef struct Curve {
#ifdef __cplusplus
  DNA_DEFINE_CXX_METHODS(Curve)
  static constexpr ID_Type id_type = ID_CU_LEGACY;
#endif
 
  ID id;
  struct AnimData *adt;

  ListBase nurb;

  EditNurb *editnurb;
 
  struct Object *bevobj, *taperobj, *textoncurve;
  struct Ipo *ipo DNA_DEPRECATED;
  struct Key *key;
  struct Material **mat;
 
  struct CurveProfile *bevel_profile;
 
  float texspace_location[3];
  float texspace_size[3];

  short ob_type;
 
  char texspace_flag;
  char _pad0[7];
  short twist_mode;
  float twist_smooth, smallcaps_scale;
 
  int pathlen;
  short bevresol, totcol;
  int flag;
  float offset, extrude, bevel_radius;
 
  /* default */
  short resolu, resolv;
  short resolu_ren, resolv_ren;
 
  /* edit, index in nurb list */
  int actnu;
  /* edit, index in active nurb (BPoint or BezTriple) */
  int actvert;
 
  char overflow;
  char spacemode, align_y;
  char bevel_mode;
  char taper_radius_mode;
  char _pad[3];
 
  /* font part */
  float spacing, linedist, shear, fsize, wordspace, ulpos, ulheight;
  float xof, yof;
  float linewidth;
 
  /* copy of EditFont vars (wchar_t aligned),
   * warning! don't use in editmode (storage only) */
  int pos;
  int selstart, selend;
 
  /* text data */
  int len_char32;
  int len;
  char *str;
  struct EditFont *editfont;
 
  char family[64];
  struct VFont *vfont;
  struct VFont *vfontb;
  struct VFont *vfonti;
  struct VFont *vfontbi;
 
  struct TextBox *tb;
  int totbox, actbox;
 
  struct CharInfo *strinfo;
  struct CharInfo curinfo;
  /* font part end */

  float ctime;
  float bevfac1, bevfac2;
  char bevfac1_mapping, bevfac2_mapping;
 
  char _pad2[1];

  char edit_data_from_original;

  const struct Curves *curve_eval;
 
  void *batch_cache;
 
#ifdef __cplusplus
  std::optional<int> material_index_max() const;
#endif
} Curve;
 
/* **************** CURVE ********************* */
 
/* checks if the given BezTriple is selected */
#define BEZT_ISSEL_ANY(bezt) \
  (((bezt)->f2 & SELECT) || ((bezt)->f1 & SELECT) || ((bezt)->f3 & SELECT))
#define BEZT_ISSEL_ALL(bezt) \
  (((bezt)->f2 & SELECT) && ((bezt)->f1 & SELECT) && ((bezt)->f3 & SELECT))
#define BEZT_ISSEL_ALL_HIDDENHANDLES(v3d, bezt) \
  ((((v3d) != NULL) && ((v3d)->overlay.handle_display == CURVE_HANDLE_NONE)) ? \
       (bezt)->f2 & SELECT : \
       BEZT_ISSEL_ALL(bezt))
#define BEZT_ISSEL_ANY_HIDDENHANDLES(v3d, bezt) \
  ((((v3d) != NULL) && ((v3d)->overlay.handle_display == CURVE_HANDLE_NONE)) ? \
       (bezt)->f2 & SELECT : \
       BEZT_ISSEL_ANY(bezt))
 
#define BEZT_ISSEL_IDX(bezt, i) \
  ((i == 0 && (bezt)->f1 & SELECT) || (i == 1 && (bezt)->f2 & SELECT) || \
   (i == 2 && (bezt)->f3 & SELECT))
 
#define BEZT_SEL_ALL(bezt) \
  { \
    (bezt)->f1 |= SELECT; \
    (bezt)->f2 |= SELECT; \
    (bezt)->f3 |= SELECT; \
  } \
  ((void)0)
#define BEZT_DESEL_ALL(bezt) \
  { \
    (bezt)->f1 &= ~SELECT; \
    (bezt)->f2 &= ~SELECT; \
    (bezt)->f3 &= ~SELECT; \
  } \
  ((void)0)
#define BEZT_SEL_INVERT(bezt) \
  { \
    (bezt)->f1 ^= SELECT; \
    (bezt)->f2 ^= SELECT; \
    (bezt)->f3 ^= SELECT; \
  } \
  ((void)0)
 
#define BEZT_SEL_IDX(bezt, i) \
  { \
    switch (i) { \
      case 0: \
        (bezt)->f1 |= SELECT; \
        break; \
      case 1: \
        (bezt)->f2 |= SELECT; \
        break; \
      case 2: \
        (bezt)->f3 |= SELECT; \
        break; \
      default: \
        break; \
    } \
  } \
  ((void)0)
 
#define BEZT_DESEL_IDX(bezt, i) \
  { \
    switch (i) { \
      case 0: \
        (bezt)->f1 &= ~SELECT; \
        break; \
      case 1: \
        (bezt)->f2 &= ~SELECT; \
        break; \
      case 2: \
        (bezt)->f3 &= ~SELECT; \
        break; \
      default: \
        break; \
    } \
  } \
  ((void)0)
 
#define BEZT_IS_AUTOH(bezt) \
  (ELEM((bezt)->h1, HD_AUTO, HD_AUTO_ANIM) && ELEM((bezt)->h2, HD_AUTO, HD_AUTO_ANIM))