blender/blender-manual
24
24
Fork 105
Code Issues 76 Pull Requests 6 Projects 1 Releases Wiki Activity

UV: Document pack islands features and new ui #104468

Closed
Chris Blackbourn wants to merge 63 commits from Chris_Blackbourn/blender-manual:uv_pack_islands into blender-v3.6-release
pull from: Chris_Blackbourn/blender-manual:uv_pack_islands
merge into: blender:blender-v3.6-release

When changing the target branch, be careful to rebase the branch in your fork to match. See documentation.
Conversation 3 Commits 63 Files Changed 49 +282 -274
9 changed files with 282 additions and 274 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit da74f51165 - Show all commits

4
manual/editors/image/editing.rst
View File

@ -14,7 +14,7 @@ New
:Menu: :menuselection:`Image --> New` :Menu: :menuselection:`Image --> New`
:Shortcut: :kbd:`Alt-N` :Shortcut: :kbd:`Alt-N`
Creates a new :ref:`image-generated` Image. Create a new :ref:`image-generated` Image.
.. _bpy.ops.image.open: .. _bpy.ops.image.open:
@ -28,7 +28,7 @@ Open
:Menu: :menuselection:`Image --> Open` :Menu: :menuselection:`Image --> Open`
:Shortcut: :kbd:`Alt-O` :Shortcut: :kbd:`Alt-O`
Load image from a file. Load an image from a file.
.. _bpy.ops.image.read_viewlayers: .. _bpy.ops.image.read_viewlayers:

4
manual/editors/image/sidebar.rst
View File

@ -43,7 +43,7 @@ You can set the editor's display options in this panel.
Aspect Ratio Aspect Ratio
Display aspect for this image. Does not affect rendering. Display aspect for this image. Does not affect rendering.
Repeat Image Repeat Image
Tiles the image so it completely fills the editor. Tile the image so it completely fills the editor.
Annotations Annotations
@ -78,7 +78,7 @@ A predominantly dark image would have the highest values toward the left side of
Use this mode to balance out the tonal range in an image. Use this mode to balance out the tonal range in an image.
A well-balanced image should have a nice smooth distribution of color values. A well-balanced image should have a nice smooth distribution of color values.
You can drag the mouse in the histogram to adjust its vertical zoom. You can drag :kbd:`LMB` in the histogram to adjust its vertical zoom.
Luma Luma
Shows a luminosity histogram. Shows a luminosity histogram.

37
manual/editors/uv/controls/snapping.rst
View File

@ -3,6 +3,13 @@
Snapping Snapping
******** ********
Snapping lets you easily align UV elements to others.
It can be toggled by clicking the magnet icon in the UV Editor's header,
or more temporarily by holding :kbd:`Ctrl`.
This page is about the Snap header button; for the Snap menu,
see :ref:`UV Editing <bpy.ops.uv.snap_selected>`.
.. _bpy.types.ToolSettings.snap_uv_element: .. _bpy.types.ToolSettings.snap_uv_element:
Snap To Snap To
@ -14,23 +21,20 @@ Snap To
:Shortcut: :kbd:`Shift-Ctrl-Tab` :Shortcut: :kbd:`Shift-Ctrl-Tab`
Increment Increment
Snap elements along points on a fixed scale. Snaps to grid points.
These points are defined by the intersection points of the grid
and the scale of the increments depending on zoom level,
unless using :ref:`Fixed Subdivisions <bpy.types.SpaceUVEditor.custom_grid_subdivisions>`.
The Custom Grid can also be used to define a set distance of the scale.
.. note:: .. note::
In this context the grid does not mean the visual grid cue displayed. By default, this option won't snap to the grid that's displayed in the editor,
Snapping will use the resolution of the displayed grid, but an imaginary grid with the same resolution that starts at the selection's
but all transformations are relative to the initial position (before the snap operation). original location. In other words, it lets you move the selection in "increments" of the
grid cell size.
Note, the behavior can be disabled by using *Absolute Grid Snap*. If you want to snap to the viewport grid instead, you can enable *Absolute Grid Snap*
(see below).
Vertex Vertex
Snap to UV vertices. Snaps to the vertex that's closest to the mouse cursor.
Additional Options Additional Options
@ -38,15 +42,16 @@ Additional Options
.. _bpy.types.ToolSettings.use_snap_uv_grid_absolute: .. _bpy.types.ToolSettings.use_snap_uv_grid_absolute:
Absolute Grid Snap Absolute Grid Snap :guilabel:`Increment`
Available only for the *Increment* option. Snaps to the grid, instead of snapping in increments relative to the current location.
Snap to the visual grid, instead of snapping in increments relative to the current location.
Target Target :guilabel:`Vertex`
See :ref:`3D Viewport Snapping <bpy.types.ToolSettings.snap_target>` for more information. See :ref:`3D Viewport Snapping <bpy.types.ToolSettings.snap_target>` for more information.
Affect Affect
====== ======
Limits the effect of the snap to the transformation type. Specifies which transformations are affected by snapping.
By default, snapping only happens while moving something,
but you can also enable it for rotating and scaling.

151
manual/editors/uv/introduction.rst
View File

@ -4,41 +4,42 @@
Introduction Introduction
************ ************
The UV Editor is used to map 2D assets like images/textures The UV Editor is used for editing UV maps, which describe how a 2D image should be mapped
onto 3D objects and edit what are called UVs. onto a 3D object.
.. figure:: /images/editors_uv_introduction_main.png .. figure:: /images/editors_uv_introduction_main.png
UV Editor with a UV map and a test grid texture. UV Editor with a UV map and a test grid texture.
The most flexible way of mapping a 2D texture over a 3D object is a process called "UV mapping". Image textures are typically needed when the desired look is hard to achieve with procedural textures,
In this process, you take your three-dimensional (X, Y & Z) mesh and unwrap it to a flat two-dimensional or if the texture is not uniform. For example, a car would only have scratches in a few places where they make sense,
(X & Y ... or rather, as we shall soon see, "U & V") image. Colors in the image are thus mapped to your mesh, not in random places all over its body.
and show up as the color of the faces of the mesh. Use UV texturing to provide realism to your objects that
procedural materials and textures cannot do, and better details than Vertex Painting can provide. Blender offers a number of projections (Box, Sphere...) that automatically apply a 2D image to a 3D object,
but these tend to only work for simple meshes. For more complex ones, you need to create a UV map instead.
This is a flat area where each face of the 3D object is laid out on the 2D image, specifying which part of the
image it should be textured with. This gives you complete control over the mapping process.
The name "UV" refers to the axes of the map: U for horizontal, V for vertical. These letters were chosen to
avoid confusion with "X" and "Y", which refer to axes in 3D space instead.
UVs Explained UVs Explained
============= =============
The best analogy to understanding UV mapping is cutting up a cardboard box. The best analogy to understand UV mapping is cutting up a cardboard box.
The box is a three-dimensional (3D) object, just like the mesh cube you add to your scene. If you were to take a pair of scissors and cut along its edges,
you would be able to spread it out flat on a tabletop. As you are looking down at the table,
If you were to take a pair of scissors and cut a seam or fold of the box,
you would be able to lay it flat on a tabletop. As you are looking down at the box on the table,
we could say that U is the left-right direction, and V is the up-down direction. we could say that U is the left-right direction, and V is the up-down direction.
This image is thus in two dimensions (2D). We use U and V to refer to these
"texture-space coordinates" instead of the normal X and Y, which are always used
(along with Z) to refer to the three-dimensional space (3D).
When the box is reassembled, a certain UV location on the paper is transferred to an (X, Y, Z) As a next step, you could put the spread-out box on top of a poster, cut the poster
location on the box. This is what the computer does with a 2D image in wrapping it around a 3D object. to match its shape, glue the poster to the box, and finally reassemble the box.
You now have a 3D box textured with a 2D image.
During the UV unwrapping process, you tell Blender exactly how to map the faces of your object (in this case, a box) A UV map describes how the box is cut up, and how it's laid out on the poster.
to a flat image in the UV Editor. You have complete freedom in how to do this. You have complete freedom in how to do this: if you wanted to, you could cut each individual
(Continuing our previous example, imagine that, having initially laid the box flat on the tabletop, side of the box and position, rotate, scale, and even skew it on the poster
you now cut it into smaller pieces, somehow stretch and/or shrink those pieces, independently of the other sides.
and then arrange them in some way upon a photograph that is also lying on that tabletop.)
Example Example
@ -49,46 +50,19 @@ Example
3D space (XYZ) versus UV space. 3D space (XYZ) versus UV space.
In this image you can easily see that the shape and In the above image, a dome in 3D space is flattened into a disc in UV space.
size of the marked face in 3D space is different in UV space. Each 3D face is then textured with the part of the image it covers in the UV map.
This difference is caused by the "stretching" (technically called mapping)
of the 3D part (XYZ) onto a 2D plane (i.e. the UV map).
If a 3D object has a UV map, then, in addition to the 3D coordinates X, Y, and Z, The image also demonstrates a common problem in UV maps: distortion. Notice how,
each point on the object will have corresponding U and V coordinates. even though the checkered squares in the 2D texture are all the same size,
they get different sizes when applied to the 3D dome (they're smaller at the base
than at the top). This is because the faces in the UV map have different relative
sizes than in 3D space, which is a result of the flattening process.
.. note:: You'll typically want to minimize this distortion by manually guiding and tweaking
the flattening, using :doc:`seams </modeling/meshes/uv/unwrapping/seams>` for example.
However, it's not always possible to eliminate it completely.
On more complex models (like seen in the sphere above)
there pops up an issue where the faces cannot be cut,
but instead they are stretched in order to make them flat.
This helps making easier UV maps, but sometimes adds distortion to the final mapped texture.
Advantages of UVs
=================
While procedural textures are useful -- they never repeat themselves and always "fit" 3D objects
-- they are not sufficient for more complex or natural objects.
For instance, the skin on a human head will never look quite right when procedurally generated.
Wrinkles on a human head, or scratches on a car do not occur in random places,
but depend on the shape of the model and its usage. Manually-painted images,
or images captured from the real world gives more control and realism.
For details such as book covers, tapestry, rugs, stains, and detailed props,
artists are able to control every pixel on the surface using a UV texture.
A UV map describes what part of the texture should be attached to each polygon in the model.
Each polygon's vertex gets assigned to 2D coordinates that define which part of the image gets mapped.
These 2D coordinates are called UVs (compare this to the XYZ coordinates in 3D).
The operation of generating these UV maps is also called "unwrap",
since it is as if the mesh were unfolded onto a 2D plane.
For most simple 3D models, Blender has an automatic set of unwrapping algorithms that you can easily apply.
For more complex 3D models, regular Cubic, Cylindrical or Spherical mapping, is usually not sufficient.
For even and accurate projection, use :doc:`seams </modeling/meshes/uv/unwrapping/seams>` to guide the UV mapping.
This can be used to apply textures to arbitrary and complex shapes,
like human heads or animals. Often these textures are painted images,
created in applications like the Gimp, Krita, or your favorite painting application.
Interface Interface
@ -104,7 +78,7 @@ Header
The header contains several menus and options for working with UVs. The header contains several menus and options for working with UVs.
Sync Selection Sync Selection
Syncs selection between the UV Editor and the 3D Viewport. Synchronizes the selection between the UV Editor and the 3D Viewport.
See :ref:`Sync Selection <bpy.types.ToolSettings.use_uv_select_sync>` for more details. See :ref:`Sync Selection <bpy.types.ToolSettings.use_uv_select_sync>` for more details.
Selection Mode Selection Mode
@ -112,7 +86,7 @@ Selection Mode
See :ref:`Selection Mode <bpy.types.ToolSettings.uv_select_mode>` for more details. See :ref:`Selection Mode <bpy.types.ToolSettings.uv_select_mode>` for more details.
Sticky Selection Mode Sticky Selection Mode
Option to automatically expand selection. Which other vertices to select automatically.
See :ref:`Sticky Selection Mode <bpy.types.ToolSettings.uv_sticky_select_mode>` for more details. See :ref:`Sticky Selection Mode <bpy.types.ToolSettings.uv_sticky_select_mode>` for more details.
View View
@ -120,33 +94,54 @@ View
See :doc:`/editors/uv/navigating`. See :doc:`/editors/uv/navigating`.
Select Select
Tools for :doc:`Selecting UVs </editors/uv/selecting>`. Tools for :doc:`selecting UVs </editors/uv/selecting>`.
Image Image
Tools for opening and manipulating images. Tools for opening and manipulating images.
See :doc:`/editors/image/editing`. See :doc:`/editors/image/editing`.
UV UV
Contains tools for :doc:`Unwrapping Meshes </modeling/meshes/uv/unwrapping/index>` Contains tools for :doc:`Unwrapping Meshes </modeling/meshes/uv/unwrapping/introduction>`
and :doc:`Editing UVs </modeling/meshes/uv/editing>`. and :doc:`Editing UVs </modeling/meshes/uv/editing>`.
Pivot :kbd:`Period`
See :doc:`/editors/3dview/controls/pivot_point/index`.
Snap :kbd:`Shift-Tab`
See :doc:`/editors/uv/controls/snapping`.
Proportional Editing :kbd:`O`
See :doc:`Proportional Editing </editors/3dview/controls/proportional_editing>`.
Image Image
A :ref:`data-block menu <ui-data-block>` used for selecting images. A :ref:`data-block menu <ui-data-block>` used for selecting images.
When an image has been loaded or created in the Image editor, When an image has been loaded or created in the UV Editor,
the Image panel appears in the *Sidebar region*. the :doc:`Image panel </editors/image/image_settings>` appears in the Sidebar region.
See :doc:`/editors/image/image_settings`.
Image Pin Image Pin
When enabled the current image remains visible regardless of the object selection. When enabled the current image remains visible regardless of the object selection.
This switching only happens if the 3D Viewport is in Edit Mode or Texture Paint Mode.
This can be useful to enable when an image is used as a reference. This can be useful to enable when an image is used as a reference.
Show Gizmo
Lets you show/hide all gizmos using the toggle button, or specific gizmos using
the drop-down arrow.
Navigate
Enable/disable the gizmos used to pan or zoom the 2D viewport.
See :ref:`Navigation Gizmos <editors-uv-navigate-gizmos>` for more information.
Show Overlays
Lets you show/hide all overlays using the toggle button, or specific overlays
using the drop-down arrow. See :doc:`/editors/uv/overlays`.
Active UV Loop Layer Active UV Loop Layer
Select which UV map to use. Select which UV map to use.
Viewport Gizmos Viewport Gizmos
Selectively show or hide specific gizmo controls that are displayed in the 2D viewport. Selectively show or hide specific gizmo controls that are displayed in the 2D viewport.
All gizmos can be hidden or shown at once with the toggle next to the pop-over arrow. All gizmos can be hidden or shown at once with the toggle next to the pop-over arrow.
Navigate Navigate
Enable/disable the gizmos used to pan or zoom the 2D viewport, Enable/disable the gizmos used to pan or zoom the 2D viewport,
@ -156,25 +151,13 @@ Display Channels
Select what color channels are displayed. Select what color channels are displayed.
:Color & Alpha: :Color & Alpha:
Replaces transparent pixels with background checkerboard, denoting the alpha channel. Enables transparency and shows a checkerboard behind the image.
:Color: :Color:
Display the colored image, without alpha channel. Displays the colored image, without alpha channel.
:Alpha: :Alpha:
Displays the Alpha channel a grayscale image. Displays the alpha channel as a grayscale image. White areas are opaque, black areas are transparent.
White areas are opaque, black areas have an alpha of 0.
:Z-Buffer: :Z-Buffer:
Display the depth from the camera, from Clip Start to Clip End, Displays the depth from the camera, from Clip Start to Clip End,
as specified in the :doc:`Camera settings </render/cameras>`. as specified in the :doc:`Camera settings </render/cameras>`.
:Red, Green, Blue: :Red, Green, Blue:
Single Color Channel visualized as a grayscale image. Single color channel visualized as a grayscale image.
Tool Settings
-------------
Pivot
Similar to working with pivot points in the 3D Viewport.
:doc:`UV Snapping </editors/uv/controls/snapping>`
Controls to snap UV points, similar to snapping in the 3D Viewport.
Proportional Editing
See :doc:`Proportional Editing </editors/3dview/controls/proportional_editing>`.

33
manual/editors/uv/navigating.rst
View File

@ -3,20 +3,12 @@
Navigating Navigating
********** **********
The UV Editor has a 2D cursor. Its position can be changed by :kbd:`LMB` clicking in the UV editor
while the cursor tool is active. You can also manually adjust its position in the Sidebar region.
The range by default is from 0.0 to 1.0 starting from the lower left corner.
By enabling :ref:`Pixel Coordinates <bpy.types.SpaceUVEditor.show_pixel_coords>`,
the coordinates match the pixels in your image with XY(0, 0) located in the lower left corner.
2D Viewport 2D Viewport
=========== ===========
Panning can be done by clicking the :kbd:`MMB` and dragging. Panning can be done by dragging with :kbd:`MMB`.
Zooming can be done by scrolling :kbd:`Wheel` up or down. Zooming can be done using :kbd:`Wheel` or :kbd:`NumpadPlus`/:kbd:`NumpadMinus`.
Also, as in the 3D Viewport, you can use :kbd:`NumpadPlus` or :kbd:`NumpadMinus` to zoom.
.. _editors-uv-navigate-gizmos: .. _editors-uv-navigate-gizmos:
@ -31,7 +23,24 @@ and zooming more comfortably when e.g. no mouse wheel is available.
View Menu View Menu
========= =========
Also see :doc:`/editors/image/navigating` in the Image editor. Also see :doc:`/editors/image/navigating` in the Image Editor.
Frame Selected :kbd:`NumpadPeriod` Frame Selected :kbd:`NumpadPeriod`
Change view so that all selected UV vertices are visible. Change the view so that all selected UV vertices are visible.
2D Cursor
=========
Just like the :doc:`3D Viewport </editors/3dview/3d_cursor>`, the UV Editor has a Cursor
that you can jump to (:menuselection:`View --> Center View to Cursor`). It can also serve as
a :doc:`pivot point </editors/3dview/controls/pivot_point/index>` and a
:ref:`snapping target <bpy.ops.uv.snap_selected>`.
To change the Cursor's position, either press :kbd:`LMB` with the Cursor tool selected,
or :kbd:`Shift-RMB` with any tool selected. You can also change the "Location X/Y" fields
in the *View* tab of the Sidebar, in either relative coordinates (0 to 1) or
:ref:`pixel coordinates <bpy.types.SpaceUVEditor.show_pixel_coords>`.
In both cases, the lower left corner of the image serves as the origin (0, 0).
You can press :kbd:`Shift-C` to move the Cursor to the center.

52
manual/editors/uv/overlays.rst
View File

@ -3,14 +3,17 @@
Overlays Overlays
******** ********
The Overlays popover configures the overlays that are displayed on top of images. .. figure:: /images/editors_uv_overlays.png
:align: right
The Overlays pop-over.
In the header, there is a button to turn off all overlays for the UV Editor. In the header, there is a button to turn off all overlays for the UV Editor.
This option also toggles the visibility of :doc:`/modeling/meshes/uv/workflows/udims` tile information. This option also toggles the visibility of :doc:`UDIM </modeling/meshes/uv/workflows/udims>`
The options that are visible in the pop-over depend on the UV Editor mode. tile information.
.. seealso:: The drop-down button opens a pop-over with more detailed settings.
The following categories are available:
Additional :doc:`View Properties </editors/uv/sidebar>` can be configured in the Sidebar.
Guides Guides
@ -19,26 +22,26 @@ Guides
.. _bpy.types.SpaceImageOverlay.show_grid_background: .. _bpy.types.SpaceImageOverlay.show_grid_background:
Grid Grid
Show the grid background and borders. Show the grid.
.. _bpy.types.SpaceUVEditor.show_grid_over_image: .. _bpy.types.SpaceUVEditor.show_grid_over_image:
Over Image Over Image
Allows the grid overlay to be shown on top of the image rather than behind it. Show the grid on top of the image rather than behind it.
.. _bpy.types.SpaceUVEditor.grid_shape_source: .. _bpy.types.SpaceUVEditor.grid_shape_source:
Grid Shape Source Grid Shape Source
How the size/subdivisions of grid cells are determined. How the row and column counts are determined.
:Dynamic: The grid subdivisions changes based on the zoom level. :Dynamic: The grid starts at 8×8 cells that are automatically subdivided further as you zoom in.
:Fixed: The grid subdivisions stays consistent based off the *Fixed Subdivisions* property. :Fixed: The row and column counts are fixed and can be configured manually.
:Pixel: The grid aligns with pixels from image so each grid cell represents one pixel. :Pixel: Each grid cell matches one image pixel.
.. _bpy.types.SpaceUVEditor.custom_grid_subdivisions: .. _bpy.types.SpaceUVEditor.custom_grid_subdivisions:
Fixed Subdivisions X, Y Fixed Subdivisions X, Y
Number of grid units in UV space that make one UV Unit. Number of columns/rows in the grid.
.. _bpy.types.SpaceUVEditor.tile_grid_shape: .. _bpy.types.SpaceUVEditor.tile_grid_shape:
@ -54,9 +57,9 @@ UV Editing
.. _bpy.types.SpaceUVEditor.show_stretch: .. _bpy.types.SpaceUVEditor.show_stretch:
Display Stretch Display Stretch
Shows how much of a difference there is between UV coordinates and 3D coordinates. Show how much of a shape difference there is between UV space and 3D space.
Blue means low distortion, while Red means high distortion. Blue means low distortion, red means high.
Choose to display the distortion of *Angles* or the *Area*. You can choose whether to display the distortion based on *Angle* or *Area*.
Geometry Geometry
@ -65,22 +68,22 @@ Geometry
.. _bpy.types.SpaceUVEditor.uv_opacity: .. _bpy.types.SpaceUVEditor.uv_opacity:
UV Opacity UV Opacity
Opacity of the above UV overlays. Opacity of edges and faces.
.. _bpy.types.SpaceUVEditor.edge_display_type: .. _bpy.types.SpaceUVEditor.edge_display_type:
Display As Display As
Controls how edges are shown. Control how edges are shown.
:Outline: Display white edges with black outline. :Outline: Display edges in gray with a black outline.
:Dash: Display dashed black-white edges. :Dash: Display edges as dashed black-gray lines.
:Black: Display black edges. :Black: Display edges in black.
:White: Display white edges. :White: Display edges in white.
.. _bpy.types.SpaceUVEditor.show_modified_edges: .. _bpy.types.SpaceUVEditor.show_modified_edges:
Modified Edges Modified Edges
Show results of modifiers in the UV display. Additionally show the edges as they look after applying modifiers (in gray).
.. _bpy.types.SpaceUVEditor.show_faces: .. _bpy.types.SpaceUVEditor.show_faces:
@ -92,4 +95,5 @@ Image
===== =====
Show Metadata Show Metadata
Displays the metadata if they were set in the render tab's :doc:`/render/output/properties/metadata` panel. Display metadata about the selected Render Result. See the Output tab's
:doc:`/render/output/properties/metadata` panel to change what metadata to include.

247
manual/editors/uv/selecting.rst
View File

@ -4,52 +4,39 @@
Selecting Selecting
********* *********
Selection tools are available in the *Select Menu* in the header, Much like the 3D Viewport, the UV Editor has selection mode buttons in the header,
and the shortcuts listed below. as well as a *Select* menu.
.. _bpy.types.ToolSettings.use_uv_select_sync: .. _bpy.types.ToolSettings.use_uv_select_sync:
Sync Selection Sync Selection
============== ==============
Turning on the *Sync Selection* button causes selection of components If turned off (the default), the UV Editor only shows the faces that are selected in the
in the 3D Viewport to sync with their corresponding elements in the UV editor. 3D Viewport. Selecting an item in one editor does not automatically select it in the other.
If off only the selected faces are displayed in the UV editor. If one 3D vertex/edge corresponds to multiple UV vertices/edges, you can select each
These two modes have very different results when transforming components in the UV editor. of those individually.
.. seealso::
:doc:`Selecting in the 3D Viewport </editors/3dview/selecting>`.
If turned on, the UV Editor always shows all faces. Selecting an item in one editor also
selects it in the other. If one 3D vertex/edge corresponds to multiple UV vertices/edges,
you can't select those individually (you can only select all of them).
.. _bpy.ops.uv.select_mode: .. _bpy.ops.uv.select_mode:
.. _bpy.types.ToolSettings.uv_select_mode: .. _bpy.types.ToolSettings.uv_select_mode:
Selection Modes Selection Mode
=============== ==============
Select Modes dependent on the Sync Selection. :Vertex: :kbd:`1` Select vertices.
:Edge: :kbd:`2` Select edges.
:Face: :kbd:`3` Select faces.
:Island: :kbd:`4` Select contiguous groups of faces. Only available if *Sync Selection* is disabled.
If *Sync Selection* is enabled, you can hold :kbd:`Shift` while clicking a selection mode to
activate multiple ones at the same time, or :kbd:`Ctrl` to expand/contract the selection.
Sync Selection Off .. seealso::
------------------ :doc:`Mesh Selection </modeling/meshes/selecting/introduction>`
:Vertex: Select individual vertices.
:Edge: Select edges.
:Face: Select faces.
:Island: Select contiguous groups of faces.
Sync Selection On
-----------------
When selecting UVs or Edges, it behaves like the *Shared Vertex* option of the *Sticky Selection Mode*.
When selecting Faces, it behaves like the *Disabled* option of the *Sticky Selection Mode*.
:Vertex: Select individual vertices.
:Edge: Select edges.
:Face: Select faces.
.. _bpy.types.ToolSettings.uv_sticky_select_mode: .. _bpy.types.ToolSettings.uv_sticky_select_mode:
@ -57,98 +44,97 @@ When selecting Faces, it behaves like the *Disabled* option of the *Sticky Selec
Sticky Selection Mode Sticky Selection Mode
===================== =====================
This selector lets you enable automatic additional selection. Options for automatically selecting additional UV vertices. Only available if *Sync Selection* is disabled.
:Shared Vertex: Disabled
Selects UVs that share a mesh vertex, even if they are in different UV locations. Each UV vertex can be selected independently of the others.
:Shared Location: Shared Location
Selects UVs that are in the same UV location and share a mesh vertex. Automatically select UV vertices that correspond to the same mesh vertex and have the same UV coordinates.
:Disabled: This is the default and gives the illusion that multiple faces in a UV map can share the same vertex;
Disables Sticky Selection. in reality, they have separate vertices that overlap.
When you move a UV in this mode, each face owns its own UVs, allowing them to be separated. Shared Vertex
Automatically select UV vertices that correspond to the same mesh vertex, even if they have different UV coordinates.
This is also the behavior when *Sync Selection* is enabled.
Select Menu
===========
Menu All :kbd:`A`
==== Selects all UV elements.
None :kbd:`Alt-A`
Box Select :kbd:`B` Deselects all UV elements.
Click and drag to box select UV coordinates. Invert :kbd:`Ctrl-I`
Alternatively, use :kbd:`B` to start :ref:`box selection <tool-select-box>`.
Box Select Pinned :kbd:`Ctrl-B`
Use the box lasso to select only pinned UV coordinates.
Circle Select
See :ref:`tool-select-circle`.
Select All :kbd:`A`
Selects all UV coordinates.
Select None :kbd:`Alt-A`
Deselects all UV coordinate.
Inverse :kbd:`Ctrl-I`
Inverts the current selection. Inverts the current selection.
Box Select :kbd:`B`
See :ref:`Box Select <bpy.ops.*.select_box>`.
Box Select Pinned :kbd:`Ctrl-B`
Like *Box Select*, but only selects :ref:`pinned <bpy.ops.uv.pin>` UV vertices.
Circle Select
See :ref:`Circle Select <bpy.ops.*.select_circle>`.
More/Less :kbd:`Ctrl-NumpadPlus`, :kbd:`Ctrl-NumpadMinus` More/Less :kbd:`Ctrl-NumpadPlus`, :kbd:`Ctrl-NumpadMinus`
Expands/Contracts the selection to/from the adjacent elements of the selection type. Expands/contracts the selection to/from the adjacent elements.
Select Pinned :kbd:`Shift-P` Select Pinned :kbd:`Shift-P`
Selects all :ref:`pinned <bpy.ops.uv.pin>` UVs. Selects all pinned UVs.
Select Linked Select Linked
Linked :kbd:`Ctrl-L` Linked :kbd:`Ctrl-L`
This operator selects all UVs that are connected to currently selected UVs. Selects all elements that are connected to the currently selected ones.
This works similarly to the tools in 3D Viewport.
Shortest Path Shortest Path
Path between two selected elements. Selects the path between two selected elements. (See below)
.. _bpy.ops.uv.select_similar: .. _bpy.ops.uv.select_similar:
Select Similar :kbd:`Shift-G` Select Similar :kbd:`Shift-G`
Selects UV vertices that have certain similar properties to the :term:`Active` vertex. Selects UV elements that are similar to the :term:`active` one in some way.
The :ref:`bpy.ops.screen.redo_last` panel provides several selection options: The :ref:`bpy.ops.screen.redo_last` panel provides several options:
Type Type
The property to compare against the active vertex. The property to compare. Which properties are available depends on the
The properties that are shown depend on the :ref:`Selection Mode <bpy.types.ToolSettings.uv_select_mode>`. :ref:`Selection Mode <bpy.types.ToolSettings.uv_select_mode>`.
Vertex Selection Mode: Vertex Selection Mode
:Pinned: Selects vertices with the same :ref:`pinned <bpy.ops.uv.pin>` state.
:Pinned: Selects vertices with the same :ref:`pinned <bpy.ops.uv.pin>` state as the active vertex. Edge Selection Mode
:Length: Selects edges with a similar length in the UV map.
:Length 3D: Selects edges with a similar length in the 3D mesh.
:Pinned: Selects edges with the same pinned state.
Edge Selection Mode: Face Selection Mode
:Area: Selects faces with a similar area in the UV map.
:Area 3D: Selects faces with a similar area in the 3D mesh.
:Material: Selects faces that have the same :doc:`Material </render/materials/index>`.
:Object:
Selects faces that belong to the same object. This is useful when multiple objects are in Edit mode at once.
:Polygon Sides: Selects faces with a similar number of edges.
:Winding: Select faces that have the same orientation (facing upwards or downwards in the UV map).
:Length: Selects edges with a similar length. Island Selection Mode
:Length 3D: Selects edges with a similar length in world space coordinates. :Area: Selects islands with a similar area in the UV map.
:Pinned: :Area 3D: Selects islands with a similar area in the 3D mesh.
Selects edges whose both vertices have the same :Amount of Faces in Island: Selects islands with a similar number of faces.
:ref:`pinned <bpy.ops.uv.pin>` state as the active vertex.
Face Selection Mode:
:Area: Selects faces with a similar area.
:Area 3D: Selects faces with a similar area in world space coordinates.
:Material: Selects faces that have the same :doc:`Material </render/materials/index>`.
:Object:
Selects faces which have the same object. This is useful when multiple objects are in Edit mode at once.
:Polygon Sides: Selects faces with the same number of edges per face.
:Winding: Select faces which are facing the same as the current face i.e. upwards or downwards.
Island Selection Mode:
:Area: Selects islands with a similar area.
:Area 3D: Selects islands with a similar area in world space coordinates.
:Amount of Face in Island: Selects islands with a similar number of faces per each island.
Compare Compare
For quantitative properties, this property selects the type of comparison to between the two numerical values. The comparison operator.
:Equal: Select items with the same value as the active item's chosen property. :Equal: Select elements whose value is equal.
:Greater: Select items with a larger value as the active item's chosen property. :Greater: Select elements whose value is greater or equal.
:Less: Select items with a smaller value as the active item's chosen property. :Less: Select elements whose value is less or equal.
Threshold Threshold
For quantitative properties, this property controls how Tolerance for values that are almost, but not quite the same. A higher threshold will select more elements.
close the property's values have to be in the comparison.
Select Split :kbd:`Y` Select Split :kbd:`Y`
Cuts apart the selected UVs from the map. Only those UVs which belong to "Detaches" the selected faces so they can be moved elsewhere without affecting their neighbors.
fully selected faces remain selected. As the name implies, this is particularly useful to
unlink faces and move them elsewhere. The hotkey is analogous to the mesh Split tool. .. hint::
Unlike :doc:`Split Selection </modeling/meshes/editing/mesh/split>` for meshes, which physically disconnects
faces, this is a pure selection operator. In UV space, the faces were never connected to begin with; it only seemed
that way because *Sticky Selection* automatically selected the vertices of the neighboring faces.
*Select Split* deselects those vertices again.
As an alternative to *Select Split*, you can set the *Sticky Selection Mode* to *Disabled*.
Select Overlap Select Overlap
Selects any UVs that are extended over other UVs while also selecting any underlying UVs. Selects all UV faces that overlap each other.
.. _bpy.ops.uv.shortest_path_select: .. _bpy.ops.uv.shortest_path_select:
@ -163,46 +149,73 @@ Shortest Path
:Menu: :menuselection:`Select --> Select Linked --> Shortest Path` :Menu: :menuselection:`Select --> Select Linked --> Shortest Path`
:Shortcut: :kbd:`Ctrl-LMB` :Shortcut: :kbd:`Ctrl-LMB`
Selects all UV components along the shortest path from Selects all the UV elements along the shortest path between two elements: the two selected elements when
the active component to the one which was selected. activated using the menu, or the active one and the clicked one when activated using the shortcut.
Face Stepping Face Stepping
Supports diagonal paths for vertices and faces, and For vertices: allows the path to step across faces, following their diagonal rather than
selects edge rings with edges. their edges.
For edges: selects disconnected edges that are perpendicular to the path (edge ring),
rather than connected edges along the path (edge loop).
For faces: allows the path to go through faces that only share a vertex, rather than an edge.
Topological Distance Topological Distance
Only takes into account the number of edges of the path and Calculates the distance by simply counting edges rather than measuring their lengths.
not the length of the edges to calculate the distances.
Fill Region :kbd:`Shift-Ctrl-LMB` Fill Region :kbd:`Shift-Ctrl-LMB`
Selects all elements in the shortest paths from the active selection to the clicked area. Selects all shortest paths (rather than just one).
Checker Deselect Options Dashed Line Options
Allows to quickly select alternate elements in a path. Allows to only select elements at regular intervals, creating a "dashed line" rather
than a continuous one.
Deselected Deselected
The number of deselected elements in the repetitive sequence. The number of deselected elements in the repetitive sequence.
Selected Selected
The number of selected elements in the repetitive sequence. The number of selected elements in the repetitive sequence.
Offset Offset
Offset from the starting point. The number of elements to offset the sequence by.
.. seealso:: .. seealso::
Mesh edit :ref:`Select Shortest Path <bpy.ops.mesh.shortest_path_select>`. Mesh edit :ref:`Select Shortest Path <bpy.ops.mesh.shortest_path_select>`.
.. _bpy.ops.uv.select_edge_loop:
.. _bpy.ops.uv.select_edge_ring: Select Edge Loop
================
Select Edge Loops
=================
.. reference:: .. reference::
:Mode: Edit Mode :Mode: Edit Mode
:Shortcut: :kbd:`Ctrl-Alt-LMB`, or :kbd:`Shift-Ctrl-Alt-LMB` for modifying existing selection. :Shortcut: :kbd:`Alt-LMB`, or :kbd:`Shift-Alt-LMB` for extending the existing selection.
Holding :kbd:`Ctrl-Alt` while selecting a UV component selects a loop of edges that are connected in Holding :kbd:`Alt` while clicking an edge selects that edge and then expands the selection as far as
a line end-to-end, passing through the edge under the mouse pointer. possible in the two directions parallel to it. (While this of course works for selecting edge "loops"
Holding :kbd:`Shift-Ctrl-Alt` while clicking adds to the current selection. that go all the way around a mesh, it also works if there's no loop.)
You can additionally hold :kbd:`Shift` to extend the current selection rather than replacing it.
.. seealso:: .. seealso::
Mesh edit :ref:`Select Edge Loops <bpy.ops.mesh.loop_multi_select>`. Mesh edit :ref:`Select Edge Loops <bpy.ops.mesh.loop_select>`.
.. _bpy.ops.uv.select_edge_ring:
Select Edge Ring
================
.. reference::
:Mode: Edit Mode
:Shortcut: :kbd:`Ctrl-Alt-LMB`, or :kbd:`Shift-Ctrl-Alt-LMB` for extending the existing selection.
Holding :kbd:`Ctrl-Alt` while clicking an edge selects that edge and then expands the selection
as far as possible in the two directions perpendicular to it. (While this of course works for selecting
edge "rings" that go all the way around a mesh, it also works if there's no ring.)
You can additionally hold :kbd:`Shift` to extend the current selection rather than replacing it.
.. seealso::
Mesh edit :ref:`Select Edge Rings <bpy.ops.mesh.select_edge_ring>`.

26
manual/editors/uv/sidebar.rst
View File

@ -9,7 +9,7 @@ Image Tab
UV Vertex UV Vertex
--------- ---------
Transform Properties :doc:`Selecting UVs </modeling/meshes/uv/editing>`. The averaged-out position of the selected UV vertices.
Image Image
@ -21,7 +21,7 @@ See :doc:`/editors/image/image_settings`.
UDIM Tiles UDIM Tiles
---------- ----------
Allows you to manage :doc:`UDIM Tiles </modeling/meshes/uv/workflows/udims>`. See :doc:`UDIM Tiles </modeling/meshes/uv/workflows/udims>`.
Tool Tab Tool Tab
@ -36,40 +36,34 @@ View Tab
Display Display
------- -------
You can set the editors display options in this panel. You can set the editor's display options in this panel.
.. figure:: /images/editors_uv_sidebar_display-panel.png Aspect Ratio X, Y
:align: right Display aspect for this image. Does not affect rendering.
Display panel: With both an image and UVs selected.
Aspect Ratio
Display Aspect for this image. Does not affect rendering.
Repeat Image Repeat Image
Duplicate the image until it is repeated to fill the main view. Tile the image so it completely fills the editor.
.. _bpy.types.SpaceUVEditor.show_pixel_coords: .. _bpy.types.SpaceUVEditor.show_pixel_coords:
Pixel Coordinates Pixel Coordinates
Display UV coordinates in pixels rather than from 0.0 to 1.0 Use pixel coordinates rather than relative coordinates (0 to 1) for the UV Vertex
and 2D Cursor Location fields.
2D Cursor 2D Cursor
--------- ---------
Location X, Y Location X, Y
Control 2D cursor location. View and change the location of the 2D Cursor.
Annotations Annotations
----------- -----------
Options for the :doc:`annotation tool </interface/annotate_tool>`. Options for the :doc:`Annotate tool </interface/annotate_tool>`.
.. (TODO add) images per type
Scopes Scopes
====== ======

2
manual/render/shader_nodes/textures/image.rst
View File

@ -63,7 +63,7 @@ Projection
this origin onto this sphere. This projection is, of course, perfect for spherical objects this origin onto this sphere. This projection is, of course, perfect for spherical objects
such as planets, and is also useful for organic objects. such as planets, and is also useful for organic objects.
:Tube: :Tube:
Wrap the image around a cylinder with origin (0.5, 0.5, 0) and height 1, and project the Wrap the image around a cylinder with base (0.5, 0.5, 0) and height 1, and project the
*Vector* horizontally from the central axis onto this cylinder. This projection is useful for *Vector* horizontally from the central axis onto this cylinder. This projection is useful for
a label on a bottle, for example. However, it's not suited for the top or bottom side of objects. a label on a bottle, for example. However, it's not suited for the top or bottom side of objects.