利用者:SaphireS/gsoc2016/documentationのソースを表示

= End-User Documentation (GSOC2016 Project: UV Tools) =

== Improved Pack Islands Tool == 

A new and improved packing (''Pack Islands'') operator was arguably the biggest and most complex task of this Google Summer Of Code project.
This implementation was done as a separate operator since the current ''Pack Islands'' and the new '''Irregular Pack Islands''' are fundamentally different in how they work. 

The new Irregular Pack Islands can be accessed through the UV Menu or by pressing {{Shortcut|shift|ctrl|p}}.

[[File:irregular_pack_menu.png|left|735px]]{{clr}}

{{RefBox
|mode=Edit Mode (Mesh)
|hotkey={{Shortcut|shift|ctrl|p}}
|menu=UVs → Pack Islands (irregular)
|lang=en
}}

{{Note|Type of boundaries|The ''irregular'' in the name of the new operater is based in the fact that it is able to deal with irregular shapes (UV islands), while the current Pack Islands operator just used the bounding rectangles of the UV islands for placement. The picture below illustrates the different types of UV island boundaries that can be used for computing a packing solution: The red rectangle bounds are used by the current operator, one can see already that this results in a lot of wasted space. The green convex bounds are already a great improvement over the rectangle ones. Imagine putting a rubber band around the UV islands, then you get the convex hull/bounds. The blue concave boundaries follow exactly the outline of the UV islands, including concavities and holes. While these produce the best results they're also very computation heavy and an option to use the (faster to compute) convex bounds has been added to the new operator.

[[File:hull_types.png|center|800px]]}}

''Pack Islands (irregular)'' is a '''modal''' operator, which means after it is started it iteratively searches for better solutions until either the user is satisfied or a defined number of iterations is met. For this operator state-of-the-art algorithms and heuristics in bin packing were used, mostly Simulated Annealing and No-Fit-Polygon computation. Those interested in the technical and implementation details are referred to this page: [[User:SaphireS/gsoc2016/Packing|Packing Implementation Notes]]

Modal operator in Blender work like this: Once it's calles it caclulates better solutions iteratively until either the max. number of iterations is reached (see '''options''' below) or the user accepts/cancel the operator. ''While the operator is running'' this can be done with the following shortcuts:
*{{Shortcut|LMB}} or {{Shortcut|Return}} or {{Shortcut|PadEnter}}: Finish operator and keep result.
*{{Shortcut|RMB}} or {{Shortcut|Esc}} : Cancel operator and revert back to the state before calling Pack Islands (irregular).

The recommended way to change operator settings is calling it and accepting the result, then press {{Shortcut|F6}} to bring up the operator settings menu and change the desired settings.

The operator has the following options for users:

[[File:irregular_pack_options.png|left|328px]]{{clr}}

Here's what each one of these does:

* '''Use concave boundaries''': If this checkbox is ticked concave boundaries are used instead of convex ones, which leads to better results but is also slower and more computation heavy!
* '''Margin''': Margin or "Padding" is a minimum distance between each of the UV islands and the UV border. Default is 0.0.
* '''Rotation Steps''': This option tells the operator how many different rotations for the UV islands are allowed. Example: 0/1 = no rotation, 2 = 2 different rotations (180°rotation steps), 4 = 4 different rotations (90° rotation steps), 8 = 45° rotation steps and so on. The more rotation steps the better the potential result but the more computation performance is needed.
* '''Iterations''': Number of iterations before it stops searching for better solutions, 0 = runs until the users stops. 
* '''Average Islands Scale''': Run the ''Average Islands Scale'' operator before starting packing if this checkbox is ticked.

{{NiceTip|Number of iterations|With only a few iterations it should be possible to get better results compared to the old "Pack Islands" operator in most cases.}}

Here are a few examples of the old vs. the new operator (using ''convex'' setting and only 1 initial iteration):

{|align=center
| [[Image:Pack_1_comparison.jpg|thumb|250px| Comparison of old and new operator (convex setting, 1 iteration)]]
| [[Image:Pack_2_comparison.jpg|thumb|250px| Comparison of old and new operator (convex setting, 1 iteration)]]
| [[Image:packing_margin_2.jpg|thumb|250px| Margin support]]
|}

== Select Shortest Vertex Path Tool ==

The ''Select Shortest Vertex Path'' operator works similar to its counterpart in 3D View, it selects the shortest vertex path between two selected vertices. 
Make sure to only have 2 UV vertices selected prior to calling this operator, otherwise it displays a warning to have exactly 2 vertices selected for it to work. 

The operator can be found in the ''Select'' menu of the UV editor: {{Menu|Select|Select Shortest Vertex Path}}. 

[[File:shortest_path_menu.png|601px]]

The operator has one option: A checkbox to use '''Topological Distance'''. By default the path with the smallest spatial distance is chosen, if ''Topological Distance'' is ticked, the path with the least amount of vertices is chosen instead. An animated version can be found here:

[[File:shortest_path.gif|frame|400px|center|Animated .gif of this operator in action]]

== Scale to Bounds Tool ==

Sometimes also referred to as "Normalize UVs", this tool can be used to scale the selected UV Islands to fit the UV bounds.{{clr}}
It can be found in the UVs menu: {{Menu|UVs|Scale to bounds}}

[[File:Scale_bounds_menu.png|647px]]

The operator has the following options: 

* '''Keep Aspect Ratio''': If this checkbox is ticked the aspect ratio of the current selection is kept while scaling up. If it's unticked the selection is tretched to fit width and height of the UV boundaries/loaded image.
* '''Individual''': If this checkbox is ticked the individual UV islands are scaled to fit the UV boundaries, the default behaviour (unchecked) is that the current selection as a whole is scaled to fit the boundaries.

An animated version can be found below: 
[[File:scale_bounds.gif|frame|400px|center|Animated version of the ''Scale To Bounds'' operator and its options]]

== Snapping Improvements ==

The '''incremental snapping''' in Blenders UV editor had very low precision, resulting in effectively only 8 snapping intervals per axis.

During this project the precision for this was increased, with the possibility to hold down {{Shortcut|Shift}} for even more precise snapping.

{{Note|Already in master|Because of high demand this feature has already been commited to master and will be in the upcoming 2.78 release. [[Dev:Ref/Release_Notes/2.78/UI#Other|Release Notes]]}}

== "Real" UV Un/Hiding + Mesh De/Selection ==

For quite some time Blender was lacking any "real" hiding capabilities for UVs. The hiding that was in place before this project was actually deselecting the mesh in 3d view to hide UVs in UV editor. 

Now there's proper hiding, which hides the selected parts without changing the mesh selection in 3D view. {{clr}}
It can be accessed using the usual hide/unhide shortcuts:

* '''Hide Selected''': {{Shortcut|H}}
* '''Hide Unselected''': {{Shortcut|Shift|H}}
* '''Reveal''': {{Shortcut|Alt|H}}

Or using the UVs menu: {{Menu|UVs|Show/Hide}}

[[File:hide_uvs_menu.png|729px]]

The "old" hiding behaviour is still used in quite a few workflows though, so it's also made available as new operators and can be found in the UVs menu: {{clr}}
{{Menu|UVs|De/Select 3D Mesh}}

They're also usable with shortcuts (same as Show/Hide shortcuts + ''Ctrl'' as modifier key):

* '''Deselect 3D Mesh (selected)''': {{Shortcut|Ctrl|H}}
* '''Deselect 3D Mesh (unselected)''': {{Shortcut|Ctrl|Shift|H}}
* '''Select 3D Mesh''': {{Shortcut|Ctrl|Alt|H}}

[[File:Deselect_mesh_uv.jpg|546px]]

== Select Overlapping UVs Tool ==

As the name suggests, this operator can be used to find all UV islands which overlap other UV islands. When called it selects all overlapping UV islands. {{clr}}
It can be found in the ''Select'' menu: 

{{Menu|Select|Select All by Trait|Select Overlapping UVs}}

[[File:select_overlapping.jpg|722px]]

== Optional Packing for Unwrap Tools ==

Calling "Pack Islands" is now optional for most unwrap operators. This was enabled by default, now the user can decide to pack or not after unwrapping by simply ticking the '''Pack Islands''' checkbox.

[[File:optional_unwrap.gif|500px|frame|Optional packing for Unwrap Operators]]