transform.hh

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 "BLI_function_ref.hh"
#include "BLI_math_vector_types.hh"
 
#include "ED_numinput.hh"
#include "ED_transform.hh"
#include "ED_view3d.hh"
 
#include "DNA_listBase.h"
#include "DNA_windowmanager_enums.h"
 
#include "DEG_depsgraph.hh"
 
/* -------------------------------------------------------------------- */
 
#define T_ALL_RESTRICTIONS (T_NO_CONSTRAINT | T_NULL_ONE)
#define T_PROP_EDIT_ALL (T_PROP_EDIT | T_PROP_CONNECTED | T_PROP_PROJECTED)
 
/* Hard min/max for proportional size. */
#define T_PROP_SIZE_MIN 1e-6f
#define T_PROP_SIZE_MAX 1e12f
 
#define TRANSFORM_SNAP_MAX_PX 100.0f
#define TRANSFORM_DIST_INVALID -FLT_MAX
 
#define TRANS_DATA_CONTAINER_FIRST_OK(t) (&(t)->data_container[0])
/* For cases we _know_ there is only one handle. */
#define TRANS_DATA_CONTAINER_FIRST_SINGLE(t) \
  (BLI_assert((t)->data_container_len == 1), (&(t)->data_container[0]))
 
#define FOREACH_TRANS_DATA_CONTAINER(t, th) \
  for (TransDataContainer *tc = (t)->data_container, \
                          *tc_end = (t)->data_container + (t)->data_container_len; \
       th != tc_end; \
       th++)
 
#define FOREACH_TRANS_DATA_CONTAINER_INDEX(t, th, i) \
  for (TransDataContainer *tc = ((i = 0), (t)->data_container), \
                          *tc_end = (t)->data_container + (t)->data_container_len; \
       th != tc_end; \
       th++, i++)

 
/* -------------------------------------------------------------------- */
 
struct ARegion;
struct bConstraint;
struct Depsgraph;
struct NumInput;
struct Object;
struct RNG;
struct ReportList;
struct Scene;
struct ScrArea;
struct ViewLayer;
struct ViewOpsData;
struct bContext;
struct wmEvent;
struct wmKeyConfig;
struct wmKeyMap;
struct wmMsgBus;
struct wmOperator;
struct wmTimer;

 
/* -------------------------------------------------------------------- */
 
namespace blender::ed::transform {
 
struct TransSnap;
struct TransConvertTypeInfo;
struct TransDataContainer;
struct TransInfo;
struct TransModeInfo;
struct TransSeqSnapData;
struct SnapObjectContext;

enum eTContext {
  CTX_NONE = 0,
 
  /* These are similar to TransInfo::data_type. */
  CTX_CAMERA = (1 << 0),
  CTX_CURSOR = (1 << 1),
  CTX_EDGE_DATA = (1 << 2),
  CTX_GPENCIL_STROKES = (1 << 3),
  CTX_MASK = (1 << 4),
  CTX_MOVIECLIP = (1 << 5),
  CTX_OBJECT = (1 << 6),
  CTX_PAINT_CURVE = (1 << 7),
  CTX_POSE_BONE = (1 << 8),
  CTX_TEXTURE_SPACE = (1 << 9),
  CTX_SEQUENCER_IMAGE = (1 << 10),
 
  CTX_NO_PET = (1 << 11),
  CTX_AUTOCONFIRM = (1 << 12),
  CTX_OBMODE_XFORM_OBDATA = (1 << 13),
  CTX_OBMODE_XFORM_SKIP_CHILDREN = (1 << 14),
  CTX_VIEW2D_EDGE_PAN = (1 << 15),
};
ENUM_OPERATORS(eTContext, CTX_VIEW2D_EDGE_PAN)
 

enum eTFlag {
  T_EDIT = 1 << 0,
  T_POINTS = 1 << 1,
  T_NO_CONSTRAINT = 1 << 2,
  T_NULL_ONE = 1 << 3,
 
  T_PROP_EDIT = 1 << 4,
  T_PROP_CONNECTED = 1 << 5,
  T_PROP_PROJECTED = 1 << 6,
 
  T_V3D_ALIGN = 1 << 7,
  T_2D_EDIT = 1 << 8,
  T_CLIP_UV = 1 << 9,

  T_AUTOIK = 1 << 10,

  T_NO_MIRROR = 1 << 11,

  T_INPUT_IS_VALUES_FINAL = 1 << 12,

  T_MODAL = 1 << 13,

  T_NO_PROJECT = 1 << 14,
 
  T_RELEASE_CONFIRM = 1 << 15,

  T_ALT_TRANSFORM = 1 << 16,

  T_OVERRIDE_CENTER = 1 << 17,
 
  T_MODAL_CURSOR_SET = 1 << 18,
 
  T_CLNOR_REBUILD = 1 << 19,

  T_AUTOMERGE = 1 << 20,
  T_AUTOSPLIT = 1 << 21,

  T_EVENT_DRAG_START = 1 << 22,

  T_NO_CURSOR_WRAP = 1 << 23,

  T_NO_GIZMO = 1 << 24,
 
  T_DRAW_SNAP_SOURCE = 1 << 25,

  T_DUPLICATED_KEYFRAMES = 1 << 26,

  T_ORIGIN = 1 << 27,
};
ENUM_OPERATORS(eTFlag, T_ORIGIN);

enum eTModifier {
  MOD_CONSTRAINT_SELECT_AXIS = 1 << 0,
  MOD_PRECISION = 1 << 1,
  MOD_SNAP = 1 << 2,
  MOD_SNAP_INVERT = 1 << 3,
  MOD_CONSTRAINT_SELECT_PLANE = 1 << 4,
  MOD_NODE_ATTACH = 1 << 5,
  MOD_SNAP_FORCED = 1 << 6,
  MOD_EDIT_SNAP_SOURCE = 1 << 7,
  MOD_NODE_FRAME = 1 << 8,
};
ENUM_OPERATORS(eTModifier, MOD_EDIT_SNAP_SOURCE)
 

enum eTSnap {
  SNAP_RESETTED = 0,
  SNAP_SOURCE_FOUND = 1 << 0,
  /* Special flag for snap to grid. */
  SNAP_TARGET_FOUND = 1 << 1,
  SNAP_MULTI_POINTS = 1 << 2,
};
ENUM_OPERATORS(eTSnap, SNAP_MULTI_POINTS)
 

enum eSnapDir {
  DIR_GLOBAL_X = (1 << 0),
  DIR_GLOBAL_Y = (1 << 1),
  DIR_GLOBAL_Z = (1 << 2),
};
ENUM_OPERATORS(eSnapDir, DIR_GLOBAL_Z)
 

enum eTConstraint {
  CON_APPLY = 1 << 0,
  CON_AXIS0 = 1 << 1,
  CON_AXIS1 = 1 << 2,
  CON_AXIS2 = 1 << 3,
  CON_SELECT = 1 << 4,
  CON_NOFLIP = 1 << 5,
  CON_USER = 1 << 6,
};
ENUM_OPERATORS(eTConstraint, CON_USER)
 

enum eTState {
  TRANS_STARTING = 0,
  TRANS_RUNNING = 1,
  TRANS_CONFIRM = 2,
  TRANS_CANCEL = 3,
};

enum eRedrawFlag {
  TREDRAW_NOTHING = 0,
  TREDRAW_SOFT = (1 << 0),
  TREDRAW_HARD = (1 << 1) | TREDRAW_SOFT,
};
ENUM_OPERATORS(eRedrawFlag, TREDRAW_HARD)
 

enum eTHelpline {
  HLP_NONE = 0,
  HLP_SPRING = 1,
  HLP_ANGLE = 2,
  HLP_HARROW = 3,
  HLP_VARROW = 4,
  HLP_CARROW = 5,
  HLP_TRACKBALL = 6,
  HLP_ERROR = 7,
  HLP_ERROR_DASH = 8,
};
 
enum eTOType {
  O_DEFAULT = 0,
  O_SCENE,
  O_SET,
};

 
/* -------------------------------------------------------------------- */
 
enum {
  TFM_MODAL_CANCEL = 1,
  TFM_MODAL_CONFIRM = 2,
  TFM_MODAL_TRANSLATE = 3,
  TFM_MODAL_ROTATE = 4,
  TFM_MODAL_RESIZE = 5,
  TFM_MODAL_SNAP_INV_ON = 6,
  TFM_MODAL_SNAP_INV_OFF = 7,
  TFM_MODAL_SNAP_TOGGLE = 8,
  TFM_MODAL_AXIS_X = 9,
  TFM_MODAL_AXIS_Y = 10,
  TFM_MODAL_AXIS_Z = 11,
  TFM_MODAL_PLANE_X = 12,
  TFM_MODAL_PLANE_Y = 13,
  TFM_MODAL_PLANE_Z = 14,
  TFM_MODAL_CONS_OFF = 15,
  TFM_MODAL_ADD_SNAP = 16,
  TFM_MODAL_REMOVE_SNAP = 17,
 
  /* 18 and 19 used by number-input, defined in `ED_numinput.hh`. */
  // NUM_MODAL_INCREMENT_UP = 18,
  // NUM_MODAL_INCREMENT_DOWN = 19,
 
  TFM_MODAL_PROPSIZE_UP = 20,
  TFM_MODAL_PROPSIZE_DOWN = 21,
  TFM_MODAL_AUTOIK_LEN_INC = 22,
  TFM_MODAL_AUTOIK_LEN_DEC = 23,
 
  TFM_MODAL_NODE_ATTACH_ON = 24,
  TFM_MODAL_NODE_ATTACH_OFF = 25,

  TFM_MODAL_PROPSIZE = 26,
  TFM_MODAL_INSERTOFS_TOGGLE_DIR = 27,
 
  TFM_MODAL_AUTOCONSTRAINT = 28,
  TFM_MODAL_AUTOCONSTRAINTPLANE = 29,
 
  TFM_MODAL_PRECISION = 30,
 
  TFM_MODAL_VERT_EDGE_SLIDE = 31,
  TFM_MODAL_TRACKBALL = 32,
  TFM_MODAL_ROTATE_NORMALS = 33,
 
  TFM_MODAL_EDIT_SNAP_SOURCE_ON = 34,
  TFM_MODAL_EDIT_SNAP_SOURCE_OFF = 35,
 
  TFM_MODAL_PASSTHROUGH_NAVIGATE = 36,
 
  TFM_MODAL_NODE_FRAME = 37,
};

 
/* -------------------------------------------------------------------- */

enum {
  TD_SELECTED = 1 << 0,
  TD_USEQUAT = 1 << 1,
  /* TD_NOTCONNECTED = 1 << 2, */
  TD_SINGLE_SCALE = 1 << 3,
  TD_INDIVIDUAL_SCALE = 1 << 4,
  TD_NOCENTER = 1 << 5,
  TD_NO_EXT = 1 << 6,
  TD_SKIP = 1 << 7,
  TD_BEZTRIPLE = 1 << 8,
  TD_NO_LOC = 1 << 9,
  TD_NOTIMESNAP = 1 << 10,
  TD_INTVALUES = 1 << 11,
  TD_MIRROR_X = 1 << 12,
  TD_MIRROR_Y = 1 << 13,
  TD_MIRROR_Z = 1 << 14,
#define TD_MIRROR_EDGE_AXIS_SHIFT 12
  TD_MIRROR_EDGE_X = 1 << 12,
  TD_MIRROR_EDGE_Y = 1 << 13,
  TD_MIRROR_EDGE_Z = 1 << 14,
  TD_MOVEHANDLE1 = 1 << 15,
  TD_MOVEHANDLE2 = 1 << 16,
  TD_PBONE_LOCAL_MTX_P = 1 << 17,
  TD_PBONE_LOCAL_MTX_C = 1 << 18,
  /* Grease pencil layer frames. */
  TD_GREASE_PENCIL_FRAME = 1 << 19,
};
 
struct TransDataBasic {
  void *extra;
  float *loc;
  float iloc[3];
  float center[3];
  float *val;
  float ival;
  int flag;
};
 
struct TransDataMirror : public TransDataBasic {
  float *loc_src;
};
 
struct TransDataExtension {
  float drot[3];
#if 0 /* TODO: not yet implemented. */
  /* Initial object `drotAngle`. */
  float drotAngle;
  /* Initial object `drotAxis`. */
  float drotAxis[3];
#endif
  float dquat[4];
  float dscale[3];
  float *rot;
  float irot[3];
  float *quat;
  float iquat[4];
  float *rotAngle;
  float irotAngle;
  float *rotAxis;
  float irotAxis[4];
  float *scale;
  float iscale[3];
  float obmat[4][4];
  float axismtx_gimbal[3][3];
  float l_smtx[3][3];
  float r_mtx[3][3];
  float r_smtx[3][3];
  int rotOrder;
  float oloc[3], orot[3], oquat[4], orotAxis[3], orotAngle;
};
 
struct TransData2D {
  float loc[3];
  union {
    float *loc2d;
    int *loc2d_i;
  };
  float *h1, *h2;
  float ih1[2], ih2[2];
};

struct TransDataCurveHandleFlags {
  uint8_t ih1, ih2;
  uint8_t *h1, *h2;
};
 
struct TransData : public TransDataBasic {
  float dist;
  float rdist;
  float factor;
  float mtx[3][3];
  float smtx[3][3];
  float axismtx[3][3];
  bConstraint *con;
  TransDataExtension *ext;
  TransDataCurveHandleFlags *hdata;
  short protectflag;
};
 
/* -------------------------------------------------------------------- */
 
struct TransSnapPoint {
  TransSnapPoint *next, *prev;
  float co[3];
};
 
struct TransSnap {
  /* Snapping options stored as flags. */
  eSnapFlag flag;
  /* Method(s) used for snapping source to target. */
  eSnapMode mode;
  /* Part of source to snap to target. */
  eSnapSourceOP source_operation;
  /* Determines which objects are possible target. */
  eSnapTargetOP target_operation;
  short face_nearest_steps;
  eTSnap status;
  /* Snapped Element Type (currently for objects only). */
  eSnapMode source_type;
  eSnapMode target_type;
  /* For independent snapping in different directions (currently used only by VSE preview). */
  eSnapDir direction;
  float snap_source[3];
  float snap_target[3];
  float snapNormal[3];
  ListBase points;
  TransSnapPoint *selectedPoint;
  double last;
  void (*snap_target_fn)(TransInfo *, float *);
  void (*snap_source_fn)(TransInfo *);

  union {
    SnapObjectContext *object_context;
    TransSeqSnapData *seq_context;
  };
};
 
struct TransCon {
  char text[50];
  float pmtx[3][3];
  eTConstraint mode;
  void (*drawExtra)(TransInfo *t);
 
  /* NOTE: if 'tc' is NULL, 'td' must also be NULL.
   * For constraints that needs to draw differently from the other
   * uses this instead of the generic draw function. */

  void (*applyVec)(const TransInfo *t,
                   const TransDataContainer *tc,
                   const TransData *td,
                   const float in[3],
                   float r_out[3]);
  void (*applySize)(const TransInfo *t,
                    const TransDataContainer *tc,
                    const TransData *td,
                    float r_smat[3][3]);
  void (*applyRot)(const TransInfo *t,
                   const TransDataContainer *tc,
                   const TransData *td,
                   float r_axis[3],
                   float *r_angle);
};
 
struct MouseInput {
  void (*apply)(TransInfo *t, MouseInput *mi, const double mval[2], float output[3]);
  void (*post)(TransInfo *t, float values[3]);

  float2 imval;
  float2 center;
  float factor;
  float precision_factor;
  bool precision;

  void *data;

  bool use_virtual_mval;
  struct {
    double2 prev;
    double2 accum;
  } virtual_mval;
};
 
struct TransCustomData {
  void *data;
  void (*free_cb)(TransInfo *, TransDataContainer *tc, TransCustomData *custom_data);
  unsigned int use_free : 1;
};

struct TransCustomDataContainer {
  union {
    TransCustomData mode, first_elem;
  };
  TransCustomData type;
};
#define TRANS_CUSTOM_DATA_ELEM_MAX (sizeof(TransCustomDataContainer) / sizeof(TransCustomData))

struct TransDataContainer {
  TransData *data;
  TransDataExtension *data_ext;
  TransData2D *data_2d;
  TransDataMirror *data_mirror;

  int data_len;
  int data_mirror_len;
  int data_gpf_len;
 
  Object *obedit;
 
  float mat[4][4];
  float imat[4][4];
  float mat3[3][3];
  float imat3[3][3];

  float mat3_unit[3][3];

  Object *poseobj;

  float center_local[3];

  bool is_active;

  bool use_local_mat;

  union {
    struct {
      uint use_mirror_axis_x : 1;
      uint use_mirror_axis_y : 1;
      uint use_mirror_axis_z : 1;
    };
    /* For easy checking. */
    char use_mirror_axis_any;
  };
 
  TransCustomDataContainer custom;

  int *sorted_index_map;

  bool foreach_index(FunctionRef<bool(int)> fn) const
  {
    if (this->sorted_index_map) {
      for (const int i : Span(this->sorted_index_map, this->data_len)) {
        if (!fn(i)) {
          return false;
        }
      }
    }
    else {
      for (const int i : IndexRange(this->data_len)) {
        if (!fn(i)) {
          return false;
        }
      }
    }
    return true;
  }

  void foreach_index_selected(FunctionRef<void(int)> fn) const
  {
    this->foreach_index([&](const int i) {
      const bool is_selected = (this->data[i].flag & TD_SELECTED);
      if (!is_selected) {
        /* Selected items are sorted first. Either this is trivially true
         * (proportional editing off, so the only transformed data is the
         * selected data) or it's handled by `sorted_index_map`. */
        return false;
      }
      fn(i);
      return true;
    });
  }
};
 
struct TransInfo {
  TransDataContainer *data_container;
  int data_container_len;

  int data_len_all;

  TransConvertTypeInfo *data_type;

  eTfmMode mode;
  TransModeInfo *mode_info;

  eTContext options;
  eTFlag flag;
  eTModifier modifiers;
  eTState state;
  eRedrawFlag redraw;
  eTHelpline helpline;

  TransCon con;

  TransSnap tsnap;

  NumInput num;

  MouseInput mouse;

  float prop_size;
  char proptext[20];
  float aspect[3];
  float center_global[3];
  float center2d[2];
  short idx_max;
  float snap[2];
  float snap_spatial[3];
  float snap_spatial_precision;
  char frame_side;

  float viewmat[4][4];
  float viewinv[4][4];
  float persmat[4][4];
  float persinv[4][4];
  short persp;
  short around;
  char spacetype;
  short obedit_type;

  float vec[3];
  float mat[3][3];

  float spacemtx[3][3];
  float spacemtx_inv[3][3];
  char spacename[/*MAX_NAME*/ 64];
 
  /*************** NEW STUFF *********************/
  short launch_event;
  bool is_launch_event_drag;
 
  bool is_orient_default_overwrite;
 
  struct {
    short type;
    float matrix[3][3];
  } orient[3];
 
  eTOType orient_curr;

  int orient_type_mask;
 
  short prop_mode;

  float values[4];

  float values_modal_offset[4];

  float values_final[4];

  float values_inside_constraints[4];
 
  /* Axis members for modes that use an axis separate from the orientation (rotate & shear). */

  int orient_axis;
  int orient_axis_ortho;

  bool remove_on_cancel;
 
  void *view;
  bContext *context;
  wmMsgBus *mbus;
  ScrArea *area;
  ARegion *region;
  Depsgraph *depsgraph;
  Scene *scene;
  ViewLayer *view_layer;
  ToolSettings *settings;
  wmTimer *animtimer;
  wmKeyMap *keymap;
  ReportList *reports;
  float2 mval;
  float zfac;
  void *draw_handle_view;
  void *draw_handle_pixel;
  void *draw_handle_cursor;

  RNG *rng;
 
  ViewOpsData *vod;

  TransCustomDataContainer custom;
 
  /* Needed for sculpt transform. */
  const char *undo_name;
};

 
/* -------------------------------------------------------------------- */

bool initTransform(bContext *C, TransInfo *t, wmOperator *op, const wmEvent *event, int mode);
void saveTransform(bContext *C, TransInfo *t, wmOperator *op);
wmOperatorStatus transformEvent(TransInfo *t, wmOperator *op, const wmEvent *event);
void transformApply(bContext *C, TransInfo *t);
wmOperatorStatus transformEnd(bContext *C, TransInfo *t);
 
void setTransformViewMatrices(TransInfo *t);
void setTransformViewAspect(TransInfo *t, float r_aspect[3]);
void convertViewVec(TransInfo *t, float r_vec[3], double dx, double dy);
void projectFloatViewCenterFallback(TransInfo *t, float adr[2]);
void projectIntViewEx(TransInfo *t, const float vec[3], int adr[2], eV3DProjTest flag);
void projectIntView(TransInfo *t, const float vec[3], int adr[2]);
void projectFloatViewEx(TransInfo *t, const float vec[3], float adr[2], eV3DProjTest flag);
void projectFloatView(TransInfo *t, const float vec[3], float adr[2]);
 
void applyAspectRatio(TransInfo *t, float vec[2]);
void removeAspectRatio(TransInfo *t, float vec[2]);

wmKeyMap *transform_modal_keymap(wmKeyConfig *keyconf);

bool transform_apply_matrix(TransInfo *t, float mat[4][4]);
void transform_final_value_get(const TransInfo *t, float *value, int value_num);

 
/* -------------------------------------------------------------------- */

void transform_view_vector_calc(const TransInfo *t, const float focus[3], float r_vec[3]);
bool transdata_check_local_islands(TransInfo *t, short around);

 
/* -------------------------------------------------------------------- */
 
enum MouseInputMode {
  INPUT_NONE,
  INPUT_VECTOR,
  INPUT_SPRING,
  INPUT_SPRING_FLIP,
  INPUT_SPRING_DELTA,
  INPUT_ANGLE,
  INPUT_ANGLE_SPRING,
  INPUT_TRACKBALL,
  INPUT_HORIZONTAL_RATIO,
  INPUT_HORIZONTAL_ABSOLUTE,
  INPUT_VERTICAL_RATIO,
  INPUT_VERTICAL_ABSOLUTE,
  INPUT_CUSTOM_RATIO,
  INPUT_CUSTOM_RATIO_FLIP,
  INPUT_ERROR,
  INPUT_ERROR_DASH,
};
 
void initMouseInput(
    TransInfo *t, MouseInput *mi, const float2 &center, const float2 &mval, bool precision);
void initMouseInputMode(TransInfo *t, MouseInput *mi, MouseInputMode mode);
void applyMouseInput(TransInfo *t, MouseInput *mi, const float2 &mval, float output[3]);
void transform_input_update(TransInfo *t, const float fac);
void transform_input_virtual_mval_reset(TransInfo *t);
void transform_input_reset(TransInfo *t, const float2 &mval);
 
void setCustomPoints(TransInfo *t, MouseInput *mi, const int mval_start[2], const int mval_end[2]);
void setCustomPointsFromDirection(TransInfo *t, MouseInput *mi, const float2 &dir);
void setInputPostFct(MouseInput *mi, void (*post)(TransInfo *t, float values[3]));

 
/* -------------------------------------------------------------------- */

void initTransInfo(bContext *C, TransInfo *t, wmOperator *op, const wmEvent *event);
void freeTransCustomDataForMode(TransInfo *t);
void postTrans(bContext *C, TransInfo *t);
void resetTransModal(TransInfo *t);
void resetTransRestrictions(TransInfo *t);
 
void applyTransObjects(TransInfo *t);
void restoreTransObjects(TransInfo *t);
 
void calculateCenter2D(TransInfo *t);
void calculateCenterLocal(TransInfo *t, const float center_global[3]);
 
void calculateCenter(TransInfo *t);
void transformViewUpdate(TransInfo *t);
 
/* API functions for getting center points. */
void calculateCenterBound(TransInfo *t, float r_center[3]);
void calculateCenterMedian(TransInfo *t, float r_center[3]);
void calculateCenterCursor(TransInfo *t, float r_center[3]);
void calculateCenterCursor2D(TransInfo *t, float r_center[2]);
void calculateCenterCursorGraph2D(TransInfo *t, float r_center[2]);
bool calculateCenterActive(TransInfo *t, bool select_only, float r_center[3]);
 
void calculatePropRatio(TransInfo *t);

void transform_data_ext_rotate(TransData *td, float mat[3][3], bool use_drot);
 
Object *transform_object_deform_pose_armature_get(const TransInfo *t, Object *ob);
 
void freeCustomNormalArray(TransInfo *t, TransDataContainer *tc, TransCustomData *custom_data);
 
/* TODO: move to: `transform_query.c`. */
bool checkUseAxisMatrix(TransInfo *t);

 
}  // namespace blender::ed::transform