Blender V5.0
blender::geometry::UVPackIsland_Params Class Reference

#include <GEO_uv_pack.hh>

Public Member Functions

 UVPackIsland_Params ()
bool isCancelled () const
Parametrizer Conversion
void setFromUnwrapOptions (const UnwrapOptions &options)
UDIM Access
void setUDIMOffsetFromSpaceImage (const SpaceImage *sima)

Public Attributes

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
floatprogress

Detailed Description

See also UnwrapOptions.

Definition at line 71 of file GEO_uv_pack.hh.

Constructor & Destructor Documentation

◆ UVPackIsland_Params()

Member Function Documentation

◆ isCancelled()

bool blender::geometry::UVPackIsland_Params::isCancelled ( ) const

Definition at line 173 of file uvedit_unwrap_ops.cc.

References stop.

◆ setFromUnwrapOptions()

void blender::geometry::UVPackIsland_Params::setFromUnwrapOptions ( const UnwrapOptions & options)

◆ setUDIMOffsetFromSpaceImage()

void blender::geometry::UVPackIsland_Params::setUDIMOffsetFromSpaceImage ( const SpaceImage * sima)

Member Data Documentation

◆ correct_aspect

bool blender::geometry::UVPackIsland_Params::correct_aspect

(In 3D Viewport or UV Editor) use aspect ratio from face.

Definition at line 91 of file GEO_uv_pack.hh.

Referenced by setFromUnwrapOptions(), and UVPackIsland_Params().

◆ do_update

bool* blender::geometry::UVPackIsland_Params::do_update

Definition at line 113 of file GEO_uv_pack.hh.

Referenced by pack_islands_startjob(), and UVPackIsland_Params().

◆ margin

float blender::geometry::UVPackIsland_Params::margin

Additional space to add around each island.

Definition at line 99 of file GEO_uv_pack.hh.

Referenced by ED_uvedit_live_unwrap(), pack_islands_exec(), unwrap_exec(), and UVPackIsland_Params().

◆ margin_method

eUVPackIsland_MarginMethod blender::geometry::UVPackIsland_Params::margin_method

Which formula to use when scaling island margin.

Definition at line 101 of file GEO_uv_pack.hh.

Referenced by ED_uvedit_live_unwrap(), pack_islands_exec(), unwrap_exec(), and UVPackIsland_Params().

◆ merge_overlap

bool blender::geometry::UVPackIsland_Params::merge_overlap

Overlapping islands stick together.

Definition at line 97 of file GEO_uv_pack.hh.

Referenced by pack_islands_exec(), blender::geometry::OverlapMerger::pack_islands_overlap(), and UVPackIsland_Params().

◆ only_selected_faces

bool blender::geometry::UVPackIsland_Params::only_selected_faces

(In 3D Viewport or UV Editor) only pack islands which have selected faces.

Definition at line 87 of file GEO_uv_pack.hh.

Referenced by setFromUnwrapOptions(), and UVPackIsland_Params().

◆ only_selected_uvs

bool blender::geometry::UVPackIsland_Params::only_selected_uvs

(In UV Editor) only pack islands which have one or more selected UVs.

Definition at line 85 of file GEO_uv_pack.hh.

Referenced by setFromUnwrapOptions(), and UVPackIsland_Params().

◆ pin_method

eUVPackIsland_PinMethod blender::geometry::UVPackIsland_Params::pin_method

How will pinned islands be treated.

Definition at line 93 of file GEO_uv_pack.hh.

Referenced by ED_uvedit_live_unwrap(), pack_islands_exec(), unwrap_exec(), and UVPackIsland_Params().

◆ pin_unselected

bool blender::geometry::UVPackIsland_Params::pin_unselected

Treat unselected UVs as if they were pinned.

Definition at line 95 of file GEO_uv_pack.hh.

Referenced by setFromUnwrapOptions(), and UVPackIsland_Params().

◆ progress

float* blender::geometry::UVPackIsland_Params::progress

How much progress we have made. From wmJob.

Definition at line 115 of file GEO_uv_pack.hh.

Referenced by pack_islands_startjob(), and UVPackIsland_Params().

◆ rotate_method

eUVPackIsland_RotationMethod blender::geometry::UVPackIsland_Params::rotate_method

Restrictions around island rotation.

Definition at line 81 of file GEO_uv_pack.hh.

Referenced by ED_uvedit_live_unwrap(), pack_islands_exec(), unwrap_exec(), and UVPackIsland_Params().

◆ scale_to_fit

bool blender::geometry::UVPackIsland_Params::scale_to_fit

Resize islands to fill the unit square.

Definition at line 83 of file GEO_uv_pack.hh.

Referenced by pack_islands_exec(), and UVPackIsland_Params().

◆ shape_method

eUVPackIsland_ShapeMethod blender::geometry::UVPackIsland_Params::shape_method

Which shape to use when packing.

Definition at line 109 of file GEO_uv_pack.hh.

Referenced by pack_islands_exec(), and UVPackIsland_Params().

◆ stop

bool* blender::geometry::UVPackIsland_Params::stop

Abandon packing early when set by the job system.

Definition at line 112 of file GEO_uv_pack.hh.

Referenced by isCancelled(), pack_islands_startjob(), and UVPackIsland_Params().

◆ target_aspect_y

float blender::geometry::UVPackIsland_Params::target_aspect_y

Target aspect ratio.

Definition at line 107 of file GEO_uv_pack.hh.

Referenced by UVPackIsland_Params().

◆ target_extent

float blender::geometry::UVPackIsland_Params::target_extent

Target vertical extent. Should be 1.0f for the unit square.

Definition at line 105 of file GEO_uv_pack.hh.

Referenced by UVPackIsland_Params().

◆ udim_base_offset

float blender::geometry::UVPackIsland_Params::udim_base_offset[2]

Additional translation for bottom left corner.

Definition at line 103 of file GEO_uv_pack.hh.

Referenced by setUDIMOffsetFromSpaceImage(), and UVPackIsland_Params().

◆ use_seams

bool blender::geometry::UVPackIsland_Params::use_seams

When determining islands, use Seams as boundary edges.

Definition at line 89 of file GEO_uv_pack.hh.

Referenced by setFromUnwrapOptions(), and UVPackIsland_Params().


The documentation for this class was generated from the following files: