transform_mode_translate.cc

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 */

 
#include <cstdlib>
 
#include "MEM_guardedalloc.h"
 
#include "BLI_math_matrix.h"
#include "BLI_math_matrix.hh"
#include "BLI_math_rotation.h"
#include "BLI_math_vector.h"
#include "BLI_string_utf8.h"
#include "BLI_task.hh"
 
#include "BKE_image.hh"
#include "BKE_report.hh"
#include "BKE_unit.hh"
 
#include "ED_screen.hh"
 
#include "BLT_translation.hh"
 
#include "UI_interface_types.hh"
#include "UI_view2d.hh"
 
#include "transform.hh"
#include "transform_convert.hh"
#include "transform_mode.hh"
#include "transform_snap.hh"
 
namespace blender::ed::transform {
 
/* -------------------------------------------------------------------- */

enum eTranslateRotateMode {
  TRANSLATE_ROTATE_OFF = 0, 
  TRANSLATE_ROTATE_ON,      
  TRANSLATE_ROTATE_RESET,
};

struct TranslateCustomData {
  struct {
    enum eTranslateRotateMode rotate_mode;
  } prev;
 
  float3 snap_target_grid;
};

 
/* -------------------------------------------------------------------- */
 
static void transdata_elem_translate(const TransInfo *t,
                                     const TransDataContainer *tc,
                                     TransData *td,
                                     TransDataExtension *td_ext,
                                     const float3 &snap_source_local,
                                     const float3 &vec,
                                     enum eTranslateRotateMode rotate_mode)
{
  float rotate_offset[3] = {0};
  bool use_rotate_offset = false;
 
  /* Handle snapping rotation before doing the translation. */
  if (rotate_mode != TRANSLATE_ROTATE_OFF) {
    float mat[3][3];
 
    if (rotate_mode == TRANSLATE_ROTATE_RESET) {
      unit_m3(mat);
    }
    else {
      BLI_assert(rotate_mode == TRANSLATE_ROTATE_ON);
 
      float3 original_normal;
 
      /* In pose mode, we want to align normals with Y axis of bones. */
      if (t->options & CTX_POSE_BONE) {
        original_normal = td->axismtx[1];
      }
      else {
        original_normal = td->axismtx[2];
      }
 
      if (t->flag & T_POINTS) {
        /* Convert to Global Space since #ElementRotation_ex operates with the matrix in global
         * space. */
        original_normal = math::transform_direction(float3x3(td->mtx), original_normal);
      }
 
      rotation_between_vecs_to_mat3(mat, original_normal, t->tsnap.snapNormal);
    }
 
    ElementRotation_ex(t, tc, td, td_ext, mat, snap_source_local);
 
    if (td->loc) {
      use_rotate_offset = true;
      sub_v3_v3v3(rotate_offset, td->loc, td->iloc);
    }
  }
 
  float tvec[3];
 
  if (t->con.applyVec) {
    t->con.applyVec(t, tc, td, vec, tvec);
  }
  else {
    copy_v3_v3(tvec, vec);
  }
 
  mul_m3_v3(td->smtx, tvec);
 
  if (use_rotate_offset) {
    add_v3_v3(tvec, rotate_offset);
  }
 
  if (t->options & CTX_GPENCIL_STROKES) {
    /* Grease pencil multi-frame falloff. */
    float *gp_falloff = static_cast<float *>(td->extra);
    if (gp_falloff != nullptr) {
      mul_v3_fl(tvec, td->factor * *gp_falloff);
    }
    else {
      mul_v3_fl(tvec, td->factor);
    }
  }
  else {
    /* Proportional editing falloff. */
    mul_v3_fl(tvec, td->factor);
  }
 
  protectedTransBits(td->protectflag, tvec);
 
  if (td->loc) {
    add_v3_v3v3(td->loc, td->iloc, tvec);
  }
 
  constraintTransLim(t, tc, td);
}

 
/* -------------------------------------------------------------------- */
 
static void translate_dist_to_str(char *r_str,
                                  const int r_str_maxncpy,
                                  const float val,
                                  const UnitSettings *unit)
{
  if (unit && (unit->system != USER_UNIT_NONE)) {
    BKE_unit_value_as_string_scaled(r_str, r_str_maxncpy, val, -4, B_UNIT_LENGTH, *unit, false);
  }
  else {
    /* Check range to prevent string buffer overflow. */
    BLI_snprintf_utf8(
        r_str, r_str_maxncpy, IN_RANGE_INCL(val, -1e10f, 1e10f) ? "%.4f" : "%.4e", val);
  }
}
 
static void headerTranslation(TransInfo *t, const float vec[3], char str[UI_MAX_DRAW_STR])
{
  size_t ofs = 0;
  char dvec_str[3][NUM_STR_REP_LEN];
  char dist_str[NUM_STR_REP_LEN];
  float dist;
 
  const UnitSettings *unit = nullptr;
  if (!(t->flag & T_2D_EDIT)) {
    unit = &t->scene->unit;
  }
 
  if (hasNumInput(&t->num)) {
    outputNumInput(&(t->num), dvec_str[0], t->scene->unit);
    dist = len_v3(t->num.val);
  }
  else {
    float dvec[3];
    copy_v3_v3(dvec, vec);
    if (t->spacetype == SPACE_GRAPH) {
      /* WORKAROUND:
       * Special case where snapping is done in #recalData.
       * Update the header based on the #center_local. */
      eSnapMode autosnap = t->tsnap.mode;
      float ival = TRANS_DATA_CONTAINER_FIRST_OK(t)->center_local[0];
      float val = ival + dvec[0];
      snapFrameTransform(t, autosnap, ival, val, &val);
      dvec[0] = val - ival;
    }
 
    if (t->flag & T_2D_EDIT) {
      applyAspectRatio(t, dvec);
    }
 
    if (t->con.mode & CON_APPLY) {
      int i = 0;
      if (t->con.mode & CON_AXIS0) {
        dvec[i++] = dvec[0];
      }
      if (t->con.mode & CON_AXIS1) {
        dvec[i++] = dvec[1];
      }
      if (t->con.mode & CON_AXIS2) {
        dvec[i++] = dvec[2];
      }
      while (i != 3) {
        dvec[i++] = 0.0f;
      }
    }
 
    dist = len_v3(dvec);
 
    for (int i = 0; i < 3; i++) {
      translate_dist_to_str(dvec_str[i], sizeof(dvec_str[i]), dvec[i], unit);
    }
  }
 
  translate_dist_to_str(dist_str, sizeof(dist_str), dist, unit);
 
  if (t->flag & T_PROP_EDIT_ALL) {
    char prop_str[NUM_STR_REP_LEN];
    translate_dist_to_str(prop_str, sizeof(prop_str), t->prop_size, unit);
 
    ofs += BLI_snprintf_utf8_rlen(str + ofs,
                                  UI_MAX_DRAW_STR - ofs,
                                  "%s %s: %s   ",
                                  IFACE_("Proportional Size"),
                                  t->proptext,
                                  prop_str);
  }
 
  if (t->flag & T_AUTOIK) {
    short chainlen = t->settings->autoik_chainlen;
    if (chainlen) {
      ofs += BLI_snprintf_utf8_rlen(
          str + ofs, UI_MAX_DRAW_STR - ofs, IFACE_("Auto IK Length: %d"), chainlen);
      ofs += BLI_strncpy_utf8_rlen(str + ofs, "   ", UI_MAX_DRAW_STR - ofs);
    }
  }
 
  if (t->con.mode & CON_APPLY) {
    switch (t->num.idx_max) {
      case 0:
        ofs += BLI_snprintf_utf8_rlen(
            str + ofs, UI_MAX_DRAW_STR - ofs, "D: %s (%s)%s", dvec_str[0], dist_str, t->con.text);
        break;
      case 1:
        ofs += BLI_snprintf_utf8_rlen(str + ofs,
                                      UI_MAX_DRAW_STR - ofs,
                                      "D: %s   D: %s (%s)%s",
                                      dvec_str[0],
                                      dvec_str[1],
                                      dist_str,
                                      t->con.text);
        break;
      case 2:
        ofs += BLI_snprintf_utf8_rlen(str + ofs,
                                      UI_MAX_DRAW_STR - ofs,
                                      "D: %s   D: %s   D: %s (%s)%s",
                                      dvec_str[0],
                                      dvec_str[1],
                                      dvec_str[2],
                                      dist_str,
                                      t->con.text);
        break;
    }
  }
  else {
    if (t->spacetype == SPACE_NODE) {
      SpaceNode *snode = (SpaceNode *)t->area->spacedata.first;
      if (U.uiflag & USER_NODE_AUTO_OFFSET) {
        const char *str_dir = (snode->insert_ofs_dir == SNODE_INSERTOFS_DIR_RIGHT) ?
                                  IFACE_("right") :
                                  IFACE_("left");
        ofs += BLI_snprintf_utf8_rlen(
            str, UI_MAX_DRAW_STR, IFACE_("Auto-offset direction: %s"), str_dir);
      }
    }
    else {
      if (t->flag & T_2D_EDIT) {
        ofs += BLI_snprintf_utf8_rlen(str + ofs,
                                      UI_MAX_DRAW_STR - ofs,
                                      "Dx: %s   Dy: %s (%s)%s",
                                      dvec_str[0],
                                      dvec_str[1],
                                      dist_str,
                                      t->con.text);
      }
      else {
        ofs += BLI_snprintf_utf8_rlen(str + ofs,
                                      UI_MAX_DRAW_STR - ofs,
                                      "Dx: %s   Dy: %s   Dz: %s (%s)%s",
                                      dvec_str[0],
                                      dvec_str[1],
                                      dvec_str[2],
                                      dist_str,
                                      t->con.text);
      }
    }
  }
}

 
/* -------------------------------------------------------------------- */
 
static void ApplySnapTranslation(TransInfo *t, float vec[3])
{
  float point[3];
  getSnapPoint(t, point);
 
  if (t->spacetype == SPACE_SEQ) {
    if (t->region->regiontype == RGN_TYPE_PREVIEW) {
      snap_sequencer_image_apply_translate(t, vec);
    }
    else {
      snap_sequencer_apply_seqslide(t, vec);
    }
  }
  else {
    if (t->spacetype == SPACE_VIEW3D) {
      if (t->options & CTX_PAINT_CURVE) {
        if (ED_view3d_project_float_global(t->region, point, point, V3D_PROJ_TEST_NOP) !=
            V3D_PROJ_RET_OK)
        {
          zero_v3(point); /* No good answer here... */
        }
      }
    }
 
    sub_v3_v3v3(vec, point, t->tsnap.snap_source);
  }
}
static void translate_snap_increment_init(const TransInfo *t)
{
  if (!(t->tsnap.flag & SCE_SNAP_ABS_GRID)) {
    return;
  }
 
  TranslateCustomData *custom_data = static_cast<TranslateCustomData *>(t->custom.mode.data);
  if (t->data_type == &TransConvertType_Cursor3D) {
    /* Use a fallback when transforming the cursor.
     * In this case the center is _not_ derived from the cursor which is being transformed. */
    custom_data->snap_target_grid = TRANS_DATA_CONTAINER_FIRST_SINGLE(t)->data->iloc;
  }
  else if (t->around == V3D_AROUND_CURSOR) {
    /* Use a fallback for cursor selection,
     * this isn't useful as a global center for absolute grid snapping
     * since its not based on the position of the selection. */
    tranform_snap_target_median_calc(t, custom_data->snap_target_grid);
  }
  else {
    custom_data->snap_target_grid = t->center_global;
  }
}
 
static bool translate_snap_increment(const TransInfo *t, float *r_val)
{
  if (!transform_snap_increment_ex(t, (t->con.mode & CON_APPLY) != 0, r_val)) {
    return false;
  }
 
  if (t->tsnap.flag & SCE_SNAP_ABS_GRID) {
    TranslateCustomData *custom_data = static_cast<TranslateCustomData *>(t->custom.mode.data);
 
    float3 absolute_grid_snap_offset = custom_data->snap_target_grid;
    transform_snap_increment_ex(t, (t->con.mode & CON_APPLY) != 0, absolute_grid_snap_offset);
    absolute_grid_snap_offset -= custom_data->snap_target_grid;
    add_v3_v3(r_val, absolute_grid_snap_offset);
 
    if (t->con.mode & CON_APPLY) {
      t->con.applyVec(t, nullptr, nullptr, r_val, r_val);
    }
  }
  return true;
}

 
/* -------------------------------------------------------------------- */
 
static void applyTranslationValue(TransInfo *t, const float vec[3])
{
  TranslateCustomData *custom_data = static_cast<TranslateCustomData *>(t->custom.mode.data);
 
  enum eTranslateRotateMode rotate_mode = TRANSLATE_ROTATE_OFF;
 
  if (transform_snap_is_active(t) && usingSnappingNormal(t) && validSnappingNormal(t)) {
    rotate_mode = TRANSLATE_ROTATE_ON;
  }
 
  /* Check to see if this needs to be re-enabled. */
  if (rotate_mode == TRANSLATE_ROTATE_OFF) {
    if (t->flag & T_POINTS) {
      /* When transforming points, only use rotation when snapping is enabled
       * since re-applying translation without rotation removes rotation. */
    }
    else {
      /* When transforming data that itself stores rotation (objects, bones etc),
       * apply rotation if it was applied (with the snap normal) previously.
       * This is needed because failing to rotate will leave the rotation at the last
       * value used before snapping was disabled. */
      if (custom_data->prev.rotate_mode == TRANSLATE_ROTATE_ON) {
        rotate_mode = TRANSLATE_ROTATE_RESET;
      }
    }
  }
 
  FOREACH_TRANS_DATA_CONTAINER (t, tc) {
    float3 snap_source_local(0);
    if (rotate_mode != TRANSLATE_ROTATE_OFF) {
      snap_source_local = t->tsnap.snap_source;
      if (tc->use_local_mat) {
        /* The pivot has to be in local-space (see #49494). */
        snap_source_local = math::transform_point(float4x4(tc->imat), snap_source_local);
      }
    }
 
    threading::parallel_for(IndexRange(tc->data_len), 1024, [&](const IndexRange range) {
      for (const int i : range) {
        TransData *td = &tc->data[i];
        TransDataExtension *td_ext = tc->data_ext ? &tc->data_ext[i] : nullptr;
        if (td->flag & TD_SKIP) {
          continue;
        }
        transdata_elem_translate(t, tc, td, td_ext, snap_source_local, vec, rotate_mode);
      }
    });
  }
 
  custom_data->prev.rotate_mode = rotate_mode;
}
 
static bool clip_uv_transform_translation(TransInfo *t, float vec[2])
{
  /* Stores the coordinates of the closest UDIM tile.
   * Also acts as an offset to the tile from the origin of UV space. */
  float base_offset[2] = {0.0f, 0.0f};
 
  /* If tiled image then constrain to correct/closest UDIM tile, else 0-1 UV space. */
  const SpaceImage *sima = static_cast<const SpaceImage *>(t->area->spacedata.first);
  BKE_image_find_nearest_tile_with_offset(sima->image, t->center_global, base_offset);
 
  float min[2], max[2];
  min[0] = min[1] = FLT_MAX;
  max[0] = max[1] = -FLT_MAX;
 
  FOREACH_TRANS_DATA_CONTAINER (t, tc) {
    for (TransData *td = tc->data; td < tc->data + tc->data_len; td++) {
      minmax_v2v2_v2(min, max, td->loc);
    }
  }
 
  bool result = false;
  if (min[0] < base_offset[0]) {
    vec[0] += base_offset[0] - min[0];
    result = true;
  }
  else if (max[0] > base_offset[0] + t->aspect[0]) {
    vec[0] -= max[0] - base_offset[0] - t->aspect[0];
    result = true;
  }
 
  if (min[1] < base_offset[1]) {
    vec[1] += base_offset[1] - min[1];
    result = true;
  }
  else if (max[1] > base_offset[1] + t->aspect[1]) {
    vec[1] -= max[1] - base_offset[1] - t->aspect[1];
    result = true;
  }
 
  return result;
}
 
static void applyTranslation(TransInfo *t)
{
  char str[UI_MAX_DRAW_STR] = "";
  float global_dir[3] = {0.0f};
 
  if (t->flag & T_INPUT_IS_VALUES_FINAL) {
    mul_v3_m3v3(global_dir, t->spacemtx, t->values);
  }
  else if (applyNumInput(&t->num, global_dir)) {
    if (t->con.mode & CON_APPLY) {
      if (t->con.mode & CON_AXIS0) {
        mul_v3_v3fl(global_dir, t->spacemtx[0], global_dir[0]);
      }
      else if (t->con.mode & CON_AXIS1) {
        mul_v3_v3fl(global_dir, t->spacemtx[1], global_dir[0]);
      }
      else if (t->con.mode & CON_AXIS2) {
        mul_v3_v3fl(global_dir, t->spacemtx[2], global_dir[0]);
      }
    }
    else {
      mul_v3_m3v3(global_dir, t->spacemtx, global_dir);
    }
    if (t->flag & T_2D_EDIT) {
      removeAspectRatio(t, global_dir);
    }
  }
  else {
    copy_v3_v3(global_dir, t->values);
    if (!is_zero_v3(t->values_modal_offset)) {
      float values_ofs[3];
      mul_v3_m3v3(values_ofs, t->spacemtx, t->values_modal_offset);
      add_v3_v3(global_dir, values_ofs);
    }
 
    transform_snap_mixed_apply(t, global_dir);
 
    if (t->con.mode & CON_APPLY) {
      float in[3];
      copy_v3_v3(in, global_dir);
      t->con.applyVec(t, nullptr, nullptr, in, global_dir);
    }
 
    float incr_dir[3];
    copy_v3_v3(incr_dir, global_dir);
    if (!(transform_snap_is_active(t) && validSnap(t)) && translate_snap_increment(t, incr_dir)) {
 
      /* Test for mixed snap with grid. */
      float snap_dist_sq = FLT_MAX;
      if (t->tsnap.target_type != SCE_SNAP_TO_NONE) {
        snap_dist_sq = len_squared_v3v3(t->values, global_dir);
      }
      if ((snap_dist_sq == FLT_MAX) || (len_squared_v3v3(global_dir, incr_dir) < snap_dist_sq)) {
        copy_v3_v3(global_dir, incr_dir);
      }
    }
  }
 
  applyTranslationValue(t, global_dir);
 
  /* Evil hack - redo translation if clipping needed. */
  if (t->flag & T_CLIP_UV && clip_uv_transform_translation(t, global_dir)) {
    applyTranslationValue(t, global_dir);
 
    /* Not ideal, see #clipUVData code-comment. */
    if (t->flag & T_PROP_EDIT) {
      clipUVData(t);
    }
  }
 
  /* Set the redo value. */
  mul_v3_m3v3(t->values_final, t->spacemtx_inv, global_dir);
  headerTranslation(t, (t->con.mode & CON_APPLY) ? t->values_final : global_dir, str);
 
  recalc_data(t);
  ED_area_status_text(t->area, (str[0] == '\0') ? nullptr : str);
}
 
static void applyTranslationMatrix(TransInfo *t, float mat_xform[4][4])
{
  float delta[3];
  mul_v3_m3v3(delta, t->spacemtx, t->values_final);
  add_v3_v3(mat_xform[3], delta);
}
 
static void initTranslation(TransInfo *t, wmOperator * /*op*/)
{
  if (t->spacetype == SPACE_ACTION) {
    /* This space uses time translate. */
    BKE_report(t->reports,
               RPT_ERROR,
               "Use 'Time_Translate' transform mode instead of 'Translation' mode "
               "for translating keyframes in Dope Sheet Editor");
    t->state = TRANS_CANCEL;
    return;
  }
 
  initMouseInputMode(t, &t->mouse, INPUT_VECTOR);
 
  t->idx_max = (t->flag & T_2D_EDIT) ? 1 : 2;
  t->num.flag = 0;
  t->num.idx_max = t->idx_max;
 
  float3 aspect = t->aspect;
  /* Custom aspect for fcurve. */
  if (t->spacetype == SPACE_GRAPH) {
    View2D *v2d = &t->region->v2d;
    Scene *scene = t->scene;
    aspect[0] = UI_view2d_grid_resolution_x__frames_or_seconds(v2d, scene);
    aspect[1] = UI_view2d_grid_resolution_y__values(v2d, 10);
  }
 
  t->increment = t->snap_spatial * aspect;
  t->increment_precision = t->snap_spatial_precision;
 
  copy_v3_fl(t->num.val_inc, t->increment[0]);
  t->num.unit_sys = t->scene->unit.system;
  if (t->spacetype == SPACE_VIEW3D) {
    /* Handling units makes only sense in 3Dview... See #38877. */
    t->num.unit_type[0] = B_UNIT_LENGTH;
    t->num.unit_type[1] = B_UNIT_LENGTH;
    t->num.unit_type[2] = B_UNIT_LENGTH;
  }
  else {
    /* SPACE_GRAPH, SPACE_ACTION, etc. could use some time units, when we have them... */
    t->num.unit_type[0] = B_UNIT_NONE;
    t->num.unit_type[1] = B_UNIT_NONE;
    t->num.unit_type[2] = B_UNIT_NONE;
  }
 
  transform_mode_default_modal_orientation_set(
      t, (t->options & CTX_CAMERA) ? V3D_ORIENT_VIEW : V3D_ORIENT_GLOBAL);
 
  TranslateCustomData *custom_data = static_cast<TranslateCustomData *>(
      MEM_callocN(sizeof(*custom_data), __func__));
  custom_data->prev.rotate_mode = TRANSLATE_ROTATE_OFF;
  t->custom.mode.data = custom_data;
  t->custom.mode.use_free = true;
 
  translate_snap_increment_init(t);
}

 
TransModeInfo TransMode_translate = {
    /*flags*/ 0,
    /*init_fn*/ initTranslation,
    /*transform_fn*/ applyTranslation,
    /*transform_matrix_fn*/ applyTranslationMatrix,
    /*handle_event_fn*/ nullptr,
    /*snap_distance_fn*/ transform_snap_distance_len_squared_fn,
    /*snap_apply_fn*/ ApplySnapTranslation,
    /*draw_fn*/ nullptr,
};
 
}  // namespace blender::ed::transform