DNA_curves_types.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "DNA_ID.h"
#include "DNA_attribute_types.h"
#include "DNA_customdata_types.h"
#include "DNA_listBase.h"
 
#include "BLI_utildefines.h"
 
#ifdef __cplusplus
namespace blender::bke {
class CurvesGeometry;
class CurvesGeometryRuntime;
}  // namespace blender::bke
using CurvesGeometryRuntimeHandle = blender::bke::CurvesGeometryRuntime;
#else
typedef struct CurvesGeometryRuntimeHandle CurvesGeometryRuntimeHandle;
#endif
 
typedef enum CurveType {
  CURVE_TYPE_CATMULL_ROM = 0,
  CURVE_TYPE_POLY = 1,
  CURVE_TYPE_BEZIER = 2,
  CURVE_TYPE_NURBS = 3,
} CurveType;
/* The number of supported curve types. */
#define CURVE_TYPES_NUM 4
 
typedef enum HandleType {
  BEZIER_HANDLE_FREE = 0,
  BEZIER_HANDLE_AUTO = 1,
  BEZIER_HANDLE_VECTOR = 2,
  BEZIER_HANDLE_ALIGN = 3,
} HandleType;
#define BEZIER_HANDLES_NUM 4

typedef enum KnotsMode {
  NURBS_KNOT_MODE_NORMAL = 0,
  NURBS_KNOT_MODE_ENDPOINT = 1,
  NURBS_KNOT_MODE_BEZIER = 2,
  NURBS_KNOT_MODE_ENDPOINT_BEZIER = 3,
  NURBS_KNOT_MODE_CUSTOM = 4,
} KnotsMode;

typedef enum NormalMode {
  NORMAL_MODE_MINIMUM_TWIST = 0,
  NORMAL_MODE_Z_UP = 1,
  NORMAL_MODE_FREE = 2,
} NormalMode;

typedef struct CurvesGeometry {
  int *curve_offsets;

  struct AttributeStorage attribute_storage;

  CustomData point_data;

  CustomData curve_data_legacy;

  int point_num;
  int curve_num;

  ListBase vertex_group_names;
  int vertex_group_active_index;

  int attributes_active_index;

  CurvesGeometryRuntimeHandle *runtime;

  float *custom_knots;
 
  int custom_knot_num;
 
  char _pad[4];
 
#ifdef __cplusplus
  blender::bke::CurvesGeometry &wrap();
  const blender::bke::CurvesGeometry &wrap() const;
#endif
} CurvesGeometry;

typedef struct Curves {
#ifdef __cplusplus
  static constexpr ID_Type id_type = ID_CV;
#endif
 
  ID id;
  struct AnimData *adt;

  CurvesGeometry geometry;
 
  int flag;
  int attributes_active_index_legacy;
 
  /* Materials. */
  struct Material **mat;
  short totcol;

  char symmetry;
  char selection_domain;
  char _pad[4];

  struct Object *surface;

  char *surface_uv_map;
 
  /* Distance to keep the curves away from the surface. */
  float surface_collision_distance;
  char _pad2[4];
 
  /* Draw cache to store data used for viewport drawing. */
  void *batch_cache;
} Curves;

enum {
  HA_DS_EXPAND = (1 << 0),
  CV_SCULPT_COLLISION_ENABLED = (1 << 1),
};

typedef enum eCurvesSymmetryType {
  CURVES_SYMMETRY_X = 1 << 0,
  CURVES_SYMMETRY_Y = 1 << 1,
  CURVES_SYMMETRY_Z = 1 << 2,
} eCurvesSymmetryType;
ENUM_OPERATORS(eCurvesSymmetryType, CURVES_SYMMETRY_Z)
 
/* Only one material supported currently. */
#define CURVES_MATERIAL_NR 1