GEO_uv_pack.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include "BLI_heap.h"
#include "BLI_memarena.h"
#include "BLI_span.hh"
#include "BLI_vector.hh"
 
#include "DNA_space_types.h"

 
struct UnwrapOptions;
 
enum eUVPackIsland_MarginMethod {
  ED_UVPACK_MARGIN_SCALED = 0,
  ED_UVPACK_MARGIN_ADD,
  ED_UVPACK_MARGIN_FRACTION,
};
 
enum eUVPackIsland_RotationMethod {
  ED_UVPACK_ROTATION_NONE = 0,
  ED_UVPACK_ROTATION_AXIS_ALIGNED,
  ED_UVPACK_ROTATION_AXIS_ALIGNED_X,
  ED_UVPACK_ROTATION_AXIS_ALIGNED_Y,
  ED_UVPACK_ROTATION_CARDINAL,
  ED_UVPACK_ROTATION_ANY,
};
 
enum eUVPackIsland_ShapeMethod {
  ED_UVPACK_SHAPE_AABB = 0,
  ED_UVPACK_SHAPE_CONVEX,
  ED_UVPACK_SHAPE_CONCAVE,
};
 
enum eUVPackIsland_PinMethod {
  ED_UVPACK_PIN_NONE = 0,
  ED_UVPACK_PIN_IGNORE,
  ED_UVPACK_PIN_LOCK_ROTATION,
  ED_UVPACK_PIN_LOCK_ROTATION_SCALE,
  ED_UVPACK_PIN_LOCK_SCALE,
  ED_UVPACK_PIN_LOCK_ALL,
};
 
namespace blender::geometry {

class UVPackIsland_Params {
 public:
  UVPackIsland_Params();
 
  void setFromUnwrapOptions(const UnwrapOptions &options);
  void setUDIMOffsetFromSpaceImage(const SpaceImage *sima);
  bool isCancelled() const;

  eUVPackIsland_RotationMethod rotate_method;
  bool scale_to_fit;
  bool only_selected_uvs;
  bool only_selected_faces;
  bool use_seams;
  bool correct_aspect;
  eUVPackIsland_PinMethod pin_method;
  bool pin_unselected;
  bool merge_overlap;
  float margin;
  eUVPackIsland_MarginMethod margin_method;
  float udim_base_offset[2];
  float target_extent;
  float target_aspect_y;
  eUVPackIsland_ShapeMethod shape_method;

  bool *stop;
  bool *do_update;
  float *progress;
};
 
class UVPhi;
class PackIsland {
 public:
  PackIsland();

  float aspect_y;
  bool pinned;
  float2 pre_translate;
  float angle;
  int caller_index;
 
  void add_triangle(float2 uv0, float2 uv1, float2 uv2);
  void add_polygon(Span<float2> uvs, MemArena *arena, Heap *heap);
 
  void build_transformation(float scale, double angle, float r_matrix[2][2]) const;
  void build_inverse_transformation(float scale, double angle, float r_matrix[2][2]) const;
 
  float2 get_diagonal_support(float scale, float rotation, float margin) const;
  float2 get_diagonal_support_d4(float scale, float rotation, float margin) const;

  float2 pivot_;
  float2 half_diagonal_;
  float pre_rotate_;
 
  void place_(float scale, UVPhi phi);
  void finalize_geometry_(const UVPackIsland_Params &params, MemArena *arena, Heap *heap);
  bool can_rotate_before_pack_(const UVPackIsland_Params &params) const;
  bool can_rotate_(const UVPackIsland_Params &params) const;
  bool can_scale_(const UVPackIsland_Params &params) const;
  bool can_translate_(const UVPackIsland_Params &params) const;
 
  Vector<float2> triangle_vertices_;
 
 private:
  void calculate_pivot_(); /* Calculate `pivot_` and `half_diagonal_` based on added triangles. */
  void calculate_pre_rotation_(const UVPackIsland_Params &params);
 
  friend class Occupancy;
  friend class OverlapMerger;
};
 
float pack_islands(Span<PackIsland *> islands, const UVPackIsland_Params &params);

void mul_v2_m2_add_v2v2(float r[2], const float mat[2][2], const float a[2], const float b[2]);
 
}  // namespace blender::geometry