Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
17abd9a
Quick push as backup
suearkinunity Aug 19, 2024
61f3433
Found a new action
suearkinunity Aug 19, 2024
1009495
Starting to come to grips with the table
suearkinunity Aug 19, 2024
31f7fe7
Getting ready for a PR
suearkinunity Aug 22, 2024
0d4811d
Title fix
suearkinunity Aug 22, 2024
12d54ec
Grow Selection page and image
suearkinunity Aug 23, 2024
872e8ae
Trying a whole new thing
suearkinunity Aug 27, 2024
2613b2e
Select Hole update
suearkinunity Aug 28, 2024
a807b57
Fill Hole
suearkinunity Aug 28, 2024
b02d590
Having fun with the ring/loop options
suearkinunity Aug 29, 2024
8b5877c
Didn't add the pages
suearkinunity Aug 29, 2024
1afa800
Very, very bad TOC
suearkinunity Aug 29, 2024
3621572
Holding this for a moment
suearkinunity Sep 2, 2024
ce35b2a
Emptying the original section
suearkinunity Sep 3, 2024
e8d27df
That was wrong
suearkinunity Sep 3, 2024
50ac6db
Merge pull request #563 from Unity-Technologies/suarkin-DOCATT-5849-4
suearkinunity Sep 4, 2024
b36c055
Merge pull request #561 from Unity-Technologies/suearkin-DOCATT-5849-3
suearkinunity Sep 4, 2024
70a7da7
Update Documentation~/CenterPivot.md
suearkinunity Sep 4, 2024
88c61f7
Merge branch 'suearkinunity-DOCATT-5849' into suearking-DOCATT-5849-2
suearkinunity Sep 4, 2024
15e9f5e
No Shift feature
suearkinunity Sep 4, 2024
c20e69a
Moving ProBuilderize out to Creating
suearkinunity Sep 4, 2024
27325df
Update TableOfContents.md
suearkinunity Sep 5, 2024
ab34dc2
Basically stashing without stashing
suearkinunity Sep 6, 2024
0aa8a7e
Select vertex color
suearkinunity Sep 6, 2024
2c522b4
Tidying up a bit
suearkinunity Sep 9, 2024
c455091
Fixing nesting in TOC
suearkinunity Sep 9, 2024
8ee2214
Tidying up TOC
suearkinunity Sep 10, 2024
4b13314
Extrude Faces update
suearkinunity Sep 10, 2024
f6207f3
Lightmap UVs action doesn't exist
suearkinunity Sep 10, 2024
20e8e2c
Removing notes to self
suearkinunity Sep 10, 2024
7963ccf
Update Content/Resources/Materials/FacePicker.mat
suearkinunity Oct 11, 2024
99e25f8
Update Face_Extrude.md
suearkinunity Oct 11, 2024
398afbe
Merge branch 'suearking-DOCATT-5849-2' into suearkin-DOCATT-5849-5
suearkinunity Oct 14, 2024
a960836
Merge pull request #568 from Unity-Technologies/suearkin-DOCATT-5849-5
suearkinunity Oct 14, 2024
b256370
Update ProBuilderDefault.mat
suearkinunity Oct 14, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions Documentation~/CenterPivot.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
# ![Center Pivot icon](images/icons/CenterPivot.png) Center Pivot
# Center Pivot

The __Center Pivot__ action moves the pivot point for the Mesh to the center of the object’s bounds. For example, if you move a lot of vertices on one side of your Mesh, when you try to rotate the object, it rotates around a point outside of the Mesh.
The __Center Pivot__ action moves the pivot point for a mesh to the center of the object’s bounds. You might want to do this if you have elongated the vertices on one side of your mesh, which pushes the bounds on that side far from the original center.

From the main menu, select **Tools** > **ProBuilder** > **Object** > **Center Pivot**.
To center the pivot point:

![Center Pivot example](images/CenterPivot_Example.png)
1. Select one or more objects.
> **Note:** If you have multiple objects selected, each object's new pivot point is the center of that object, regardless of the position of any other object.
1. From the main menu, select **Tools** > **ProBuilder** > **Object** > **Center Pivot**.
If you are in the GameObject context, you can also right-click (macOS: **Ctrl**+click) the object and select **ProBuilder** > **Center Pivot**.

![Center Pivot example. The mesh on the left side is above and to the right of its pivot. The mesh on the right has its pivot at its center.](images/CenterPivot_Example.png)


> **Note:** If you have multiple objects selected, each object's new pivot point becomes the center of each object, regardless of the position of any other object.
You can also set the pivot to the center of selected edges, faces, and vertices. Refer to the [Set Pivot](SetPivot.md) action for more information.
1 change: 1 addition & 0 deletions Documentation~/Edge_Bevel.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ To bevel edges or faces:
1. Do one of the following:
* Right-click (macOS: **Ctrl**+click) on the selected face or edge and select **Bevel Edges**.
* From the main menu, select **Tools** > **ProBuilder** > **Geometry** > **Bevel Edges**.
1. The **Bevel Edges** overlay opens and a new face is created.

## Bevel Edges options

Expand Down
2 changes: 1 addition & 1 deletion Documentation~/Edge_Connect.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Connect Edges icon](images/icons/Edge_Connect.png) Connect Edges
# Connect Edges

The __Connect Edges__ action inserts an edge that connects the centers of each selected edge.

Expand Down
2 changes: 1 addition & 1 deletion Documentation~/Edge_Extrude.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Extrude Edges icon](images/icons/Edge_Extrude.png) Extrude Edges
# Extrude Edges

The __Extrude Edges__ action pushes a new edge out from each selected edge, connected by a new face for each edge. This action only works on open edges (that is, an edge that has no connected face on one side). However, you can override this restriction with the [Allow non-manifold actions](preferences.md#bridge) option.

Expand Down
15 changes: 0 additions & 15 deletions Documentation~/Edge_FillHole.md

This file was deleted.

2 changes: 1 addition & 1 deletion Documentation~/Edge_InsertLoop.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Insert Edge Loop icon](images/icons/Edge_InsertLoop.png) Insert Edge Loop
# Insert Edge Loop

The __Insert Edge Loop__ action adds a new edge loop from the selected edge(s). An edge loop is a series of edges that are directly connected. They often encircle a 3D object and connect back at the origin point.

Expand Down
15 changes: 0 additions & 15 deletions Documentation~/Edge_SetPivot.md

This file was deleted.

2 changes: 1 addition & 1 deletion Documentation~/Edge_Subdivide.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Subdivide Edge icon](images/icons/Edge_Subdivide.png) Subdivide Edges
# Subdivide Edges

The __Subdivide Edges__ action divides the selected edge(s) into multiple edges. By default, ProBuilder splits the edge in two, but in the Options window, you can set your own number of __Subdivisions__.

Expand Down
2 changes: 1 addition & 1 deletion Documentation~/Entity_Trigger.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Entity icon](images/icons/Entity_Trigger.png) Entity type actions
# Entity type actions

ProBuilder provides some default "entity" behaviors. These are MonoBehaviours that provide some commonly used functionality.

Expand Down
2 changes: 1 addition & 1 deletion Documentation~/Face_ConformNormals.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Conform Normals Icon](images/icons/Face_ConformNormals.png) Conform Normals (Faces)
# Conform Normals (Faces)

The __Conform Normals__ action sets all normals on the selected face(s) to the same relative direction.

Expand Down
2 changes: 1 addition & 1 deletion Documentation~/Face_Delete.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Delete Faces icon](images/icons/Face_Delete.png) Delete Faces
# Delete Faces

The __Delete Faces__ replace deletes the selected face(s).

Expand Down
2 changes: 1 addition & 1 deletion Documentation~/Face_Detach.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Detach Face icon](images/icons/Face_Detach.png) Detach Faces
# Detach Faces

The __Detach Faces__ action detaches the selected face(s) from the rest of the Mesh.

Expand Down
2 changes: 1 addition & 1 deletion Documentation~/Face_Duplicate.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Duplicate Faces icon](images/icons/Face_Duplicate.png) Duplicate Faces
# Duplicate Faces

The __Duplicate Faces__ action copies each selected face and either creates a new Mesh or leaves it in the same GameObject as a sub-Mesh, depending on the default options.

Expand Down
45 changes: 23 additions & 22 deletions Documentation~/Face_Extrude.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,34 @@
# ![Extrude Face icon](images/icons/Face_Extrude.png) Extrude Faces
# Extrude Faces

The __Extrude Faces__ action creates a new face. To do this, it pulls out the currently selected face, and attaches sides to each edge.
The **Extrude Faces** action adds a section to your mesh by moving away the selected face and adding sides to connect it to the mesh from its new position. You can then either:

By default, each new face follows the direction of its vertex normals, but you can change this with the **Extrude By** option.
* Move the new section farther out and in any direction to make the shape larger.
* Inset the new section to create an interior space. For example, if you inset a face on a cube, you create a box with an open side and a false bottom.

![Extrude from inset face on top of cube](images/ExtrudeFace_Example.png)
![On the left, the cube's top face has a central section selected. On the right, that central section is extruded.](images/ExtrudeFace_Example.png)

You can invoke this action in either way:

- Select one or more face(s) and click **Extrude Faces**. By default, the distance of the extrusion is **0.5**, but you can change that with the **Distance** option.

> **Tip:** You can also use this action with the **Ctrl/Cmd+E** shortcut, or from the ProBuilder menu (**Tools** > **ProBuilder** > **Geometry** > **Extrude**).

- Select one or more face(s) and then hold **Shift** while moving, rotating, or scaling the selected face(s). This method ignores the options but provides greater control, especially with the direction of the extrusion.

When you use this method with the scaling control, it creates an inset.
To extrude a face:

1. In the **Tools** overlay, select the **ProBuilder** context.
1. In the **Tool Settings** overlay, select the **Face** edit mode.
1. Select the face to extrude. Hold **Shift** to select multiple faces.
1. Do one of the following:
* Right-click (macOS: **Ctrl**+click) on the selected face and select **Extrude Faces**.
* From the main menu, select **Tools** > **ProBuilder** > **Geometry** > **Extrude**.
1. The **Extrude Faces** overlay opens and a new face is created.
* By default, the new face follows the direction of its vertex normals. You can change this with the **Extrude By** option.
* By default, the distance of the extrusion is **0.5**. You can change this with the **Distance** option. A negative value creates an inset.
* You can use the Transform tools to move, rotate, or scale the new face instead of using the options in the overlay. Hold **Shift** for greater control.


## Extrude Faces Options

These options only apply if you are using the **Extrude Faces** button or the **Ctrl/Cmd+E** shortcut.
| **Property** | | **Description** |
| :--- | --- | --- |
| **Extrude By** | | When you extrude more than one face, and those faces share an edge, set how the new faces behave along the shared edge. |
| | ![](images/extrude_face_normals.png) **Face Normals** | Each new face follows the direction of its original face, and the faces are connected to each other. |
| | ![](images/extrude_vertex_normal.png) **Vertex Normals** | The edges of the new faces farthest from the joint edge follow the direction of the original faces. However, the faces move toward the shared edge rather than follow the original direction for their whole length. |
| | ![](images/extrude_individual_faces.png) **Individual Faces** | Each new face follows the direction of its original face, but the faces aren't connected to each other. |
| **Distance** | | Distance to extrude the faces(s). Use negative values to inset the face, and define inset. |

![Extrude Face options](images/Face_Extrude_props.png)

| **Property:** | | **Description:** |
| :-------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| **Extrude By** | | Direction for extruding each selected face. |
| | ![FaceNormalsIcon](images/icons/ExtrudeFace_FaceNormals.png) **Face Normals** | Use the selected face's own surface direction. Adjacent faces remain connected. |
| | ![FaceNormalsIcon](images/icons/ExtrudeFace_VertexNormals.png) **Vertex Normals** | Use the selected face's Vertex normals. Adjacent faces remain connected. <br />This is the default. |
| | ![FaceNormalsIcon](images/icons/ExtrudeFace_Individual.png) **Individual Faces** | Use the selected face's own surface direction. However, adjacent faces do *not* remain connected. |
| __Distance__ | | Distance to extrude the faces(s). <br />Both positive and negative values are valid. |
2 changes: 1 addition & 1 deletion Documentation~/Face_FlipNormals.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Flip Normals icon](images/icons/Face_FlipNormals.png) Flip Face Normals
# Flip Face Normals

The __Flip Face Normals__ action flips the normals only on the selected face(s).

Expand Down
15 changes: 0 additions & 15 deletions Documentation~/Face_FlipTri.md

This file was deleted.

2 changes: 1 addition & 1 deletion Documentation~/Face_Merge.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Merge Faces icon](images/icons/Face_Merge.png) Merge Faces
# Merge Faces

The __Merge Faces__ action merges selected faces into a single face, and removes any dividing edges.

Expand Down
14 changes: 0 additions & 14 deletions Documentation~/Face_SetPivot.md

This file was deleted.

2 changes: 1 addition & 1 deletion Documentation~/Face_Subdivide.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Subdivide Face icon](images/icons/Face_Subdivide.png) Subdivide Face
# Subdivide Face

The __Subdivide Face__ action splits each selected face. To do this, it adds a vertex at the center of each edge and connects them in the center.

Expand Down
2 changes: 1 addition & 1 deletion Documentation~/Face_Triangulate.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Triangulate Faces icon](images/icons/Face_Triangulate.png) Triangulate Faces
# Triangulate Faces

The __Triangulate Faces__ action reduces selected faces to their base triangles. This creates a faceted, non-smooth appearance.

Expand Down
21 changes: 21 additions & 0 deletions Documentation~/FillHole.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Fill Hole

In ProBuilder, a hole is a missing face. The **Fill Hole** action creates a face between existing edges or vertices that touch the selected hole.

> **Tip:** You don't need to select all edges or vertices around a hole. Selecting only one edge or vertex is enough to fill the hole.

To fill a hole:

1. In the **Tools** overlay, select the **ProBuilder** context.
1. In the **Tool Settings** overlay, select either:
* The **Vertex** edit mode.
* The **Edge** edit mode.
1. Select an edge or vertex along the hole. <!--the tooltip on Fille Entire Hole says you can get all the holes at once by not selecting anything - same as Select Hole - but I can't get the Fill Hole option clickable without selecting something-->
1. Do one of the following:
* Right-click (macOS: **Ctrl**+click) select **Fill Hole**.
* From the main menu, select **Tools** > **ProBuilder** > **Geometry** > **Select Hole**.
1. The **Fill Hole Options** overlay opens.
By default, ProBuilder fills the entire hole. If you want to fill only part of the hole, disable the **Fill Entire Hole** option and select the edges you want to build along.
For example, if you have a missing quad, and select to adjacent edges, ProBuilder creates a triangular polygon that covers half of the hole.

![On the right is a shape with a hole. On the left, the hole is filled.](images/FillHole_Example.png)
2 changes: 1 addition & 1 deletion Documentation~/Freeze_Transform.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Freeze Transform icon](images/icons/Freeze_Transform.png) Freeze Transform
# Freeze Transform

The __Freeze Transform__ action sets the selected object's position, rotation, and scale to world-relative origin (**{0,0,0}**) without changing any vertex positions. That means it resets the pivot location and clears all Transform values, but doesn't change the size, shape, or location of the object in the Scene.

Expand Down
2 changes: 1 addition & 1 deletion Documentation~/HandleAlign.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Orientation](images/icons/HandleAlign_Local.png) Orientation
# Orientation

The __Orientation__ action sets the orientation of scene handles when you select [objects and elements](modes.md). Click the __Orientation__ button to switch between the three states: __Global__, __Local__, or __Normal__.

Expand Down
2 changes: 1 addition & 1 deletion Documentation~/Object_ConformNormals.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Conform Normals icon](images/icons/Object_ConformNormals.png) Conform Normals (Objects)
# Conform Normals (Objects)

The __Conform Normals__ action sets all face normals on the selected object to the same relative direction.

Expand Down
2 changes: 1 addition & 1 deletion Documentation~/Object_Export.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Export icon](images/icons/Object_Export.png) Export
# Export

The __Export__ action [exports](workflow-exporting.md#export) the selected ProBuilder object(s) to a 3D Model file.

Expand Down
2 changes: 1 addition & 1 deletion Documentation~/Object_FlipNormals.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Flip Normals icon](images/icons/Object_FlipNormals.png) Flip Normals
# Flip Normals

The __Flip Normals__ action flips the normals of all faces on the selected object(s). This is especially useful if you want to convert an exterior-modeled shape into an interior space.

Expand Down
2 changes: 1 addition & 1 deletion Documentation~/Object_LightmapUVs.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Lightmap UVs icon](images/icons/Object_LightmapUVs.png) Lightmap UVs
# Lightmap UVs

Use the __Lightmap UVs__ action to manually generate any missing lightmap UVs. This works on each Mesh in every open scene that is missing lightmap UVs.

Expand Down
2 changes: 1 addition & 1 deletion Documentation~/Object_Merge.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Merge Objects icon](images/icons/Object_Merge.png) Merge Objects
# Merge Objects

The __Merge Objects__ action merges two or more selected ProBuilder GameObjects into a single ProBuilder GameObject.

Expand Down
2 changes: 1 addition & 1 deletion Documentation~/Object_Mirror.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Mirror Objects icon](images/icons/Object_Mirror.png) Mirror Objects
# Mirror Objects

The __Mirror Objects__ action creates mirrored copies of objects.

Expand Down
2 changes: 1 addition & 1 deletion Documentation~/Object_ProBuilderize.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![ProBuilderize icon](images/icons/Object_ProBuilderize.png) ProBuilderize
# ProBuilderize

The __ProBuilderize__ action converts the selected object(s) into ProBuilder-editable objects.

Expand Down
2 changes: 1 addition & 1 deletion Documentation~/Object_Subdivide.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Subdivide Object icon](images/icons/Object_Subdivide.png) Subdivide Object
# Subdivide Object

The __Subdivide Object__ action divides every face on selected objects, allowing for greater levels of detail when modeling.

Expand Down
2 changes: 1 addition & 1 deletion Documentation~/Object_Triangulate.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Triangulate icon](images/icons/Object_Triangulate.png) Triangulate (Objects)
# Triangulate (Objects)

The __Triangulate__ action reduces all polygons to their base triangles. This creates a sharp, faceted appearance.

Expand Down
2 changes: 1 addition & 1 deletion Documentation~/Offset_Elements.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ![Offset Elements icon](images/icons/Offset_Elements.png) Offset Elements
# Offset Elements

The __Offset Elements__ action moves the selected element(s) according to the default values. You can change the default values with the **Offset Settings**.

Expand Down
23 changes: 23 additions & 0 deletions Documentation~/Selection_EdgeLoopRing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Select Edge Loop or Edge Ring

To add edges to a selection, you can use the **Select Edge Loop** or **Select Edge Ring** actions:

* The **Select Edge Loop** action adds edges that touch your selected edge.

![On the left, a single edge is selected. On the right, all touching edges are selected, forming a closed loop.](images/Selection_LoopExample.png)

* The **Select Edge Ring** action adds edges that touch the same faces as your selected edge, but that don't touch the selected edge itself.

![On the left, a single edge is selected along two faces. On the right, all edges that touch the same two faces are selected.](images/Selection_RingExample.png)

To grow an edge selection:

1. In the **Tools** overlay, select the **ProBuilder** context.
1. In the **Tool Settings** overlay, select the **Edge** edit mode.
1. Select an edge.
1. Do one of the following:
* Right-click (macOS: **Ctrl**+click) and click **Select** > **Select Edge Loop** or **Select Edge Ring**.
* From the main menu, select **Tools** > **ProBuilder** > **Selection** > **Select Loop** or **Select Ring** (these option names don't include the word "Edge").
1. The **Select Edge Ring** or **Select Edge Loop** overlay opens and the selection is expanded to match the default settings.
The **Iterative Selection** option is available for both actions. When you select it, the selection grows to include edges that are next to the edges it just added, and not just the edges next to the original selection.

Loading