Namespace UnityEngine.ProBuilder | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Namespace UnityEngine.ProBuilder

    Classes

    ActionResult

    Contains information about a ProBuilder action (success, failure, notification, etc)

    BuiltinMaterials

    Access the built-in materials that ProBuilder uses.

    Face

    A face is composed of a set of triangles, and a material.
    Triangle indexes may point to the same vertex index as long as the vertices are unique to the face. Ie, every vertex that a face references should only be used by that face's indices. To associate vertices that share common attributes (usually position), use the @"UnityEngine.ProBuilder.ProBuilderMesh.sharedIndexes" property.
    ProBuilder automatically manages condensing common vertices in the EditorMeshUtility.Optimize function.

    HandleUtility

    Static methods for working with ProBuilderMesh objects in an editor.

    Math

    A collection of math functions that are useful when working with 3d meshes.

    MeshUtility

    Functions for generating mesh attributes and various other mesh utilities.

    Normals

    ProBuilderMesh

    This component is responsible for storing all the data necessary for editing and compiling UnityEngine.Mesh objects.

    Projection

    Functions for projecting 3d points to 2d space.

    SceneSelection

    SelectionPicker

    Functions for picking mesh elements in a view. Can either render a texture to test, or cast a ray. Prefer this over calling SelectionPickerRenderer directly.

    ShapeGenerator

    Functions for creating ProBuilderMesh primitives.

    SharedVertex

    Defines associations between vertex positions that are coincident. The indexes stored in this collection correspond to the ProBuilderMesh.positions array.

    Coincident vertices are vertices that despite sharing the same coordinate position, are separate entries in the vertex array.

    Smoothing

    Utilities for working with smoothing groups. Smoothing groups are how ProBuilder defines hard and soft edges. ProBuilder calculates vertex normals by first calculating the normal for every face, which in turn is applied to each vertex that makes up the face. Afterwards, each vertex normal is averaged with coincident vertices belonging to the same smoothing group.

    Submesh

    A set of indexes and material.

    TransformUtility

    Helper functions for working with transforms.

    UnwrapParameters

    Store UV2 unwrapping parameters.

    Vertex

    Holds information about a single vertex, and provides methods for averaging between many. All values are optional. Where not present a default value will be substituted if necessary.

    VertexPositioning

    A set of commonly used functions for modifying mesh positions.

    WingedEdge

    A winged-edge data structure holds references to an edge, the previous and next edge in it's triangle, it's connected face, and the opposite edge (common).

    WingedEdgeEnumerator

    Enumerator for WingedEdge. Enumerates by walking the WingedEdge.next property.

    Structs

    AutoUnwrapSettings

    A collection of settings describing how to project UV coordinates for a @"UnityEngine.ProBuilder.Face".

    Edge

    An edge connecting two vertices. May point to an index in the vertices or the sharedIndexes array (local / common in ProBuilder terminology).

    EdgeLookup

    An edge composed of both the local index and common index.

    This is useful when comparing vertex indexes that are coincident. Coincident vertices are defined as vertices that are share the same coordinate space, but are separate values in the vertex array. ProBuilder tracks these coincident values in the @"UnityEngine.ProBuilder.ProBuilderMesh.sharedIndexes" array. A "common" (also called "shared") index is the index of a vertex in the sharedIndexes array.

    Normal

    A container for normal, tangent, and bitangent values.

    PickerOptions

    A collection of settings defining how mesh element picking behaves.

    SimpleTuple<T1, T2>

    A bare-bones Tuple class. Holds 2 items, does not implement equality, comparison, or anything else.

    Enums

    ActionResult.Status

    Describes the results of an action.

    AutoUnwrapSettings.Anchor

    The point from which UV transform operations will be performed.
    After the initial projection into 2d space, UVs will be translated to the anchor position. Next, the offset and rotation are applied, followed by the various other settings.

    AutoUnwrapSettings.Fill

    Describes how the projected UV bounds are optionally stretched to fill normalized coordinate space.

    Axis

    Human readable axis enum.

    CullingMode

    A flag which sets the triangle culling mode.

    ExtrudeMethod

    Describes the different methods of face extrusion.

    HandleOrientation

    How the handle gizmo is oriented with regards to the current element selection.

    MeshArrays

    Mesh attributes bitmask.

    MeshSyncState

    Describes why a @"UnityEngine.ProBuilder.ProBuilderMesh" is considered to be out of sync with it's UnityEngine.MeshFilter component.

    PivotLocation

    Describes the type of pivot ProBuilder would automatically assign on primitive creation.

    PivotPoint

    ProjectionAxis

    Axis used in projecting UVs.

    RectSelectMode

    Defines the behavior of drag selection in the scene view for mesh elements.

    RefreshMask

    Selectively rebuild and apply mesh attributes to the UnityEngine.Mesh asset.

    SelectionModifierBehavior

    When drag selecting mesh elements, this defines how the Shift key will modify the selection.

    SelectMode

    Defines what objects are selectable for the scene tool.

    ShapeType

    Describes each primitive ProBuilder can create by default. Pass to @"UnityEngine.ProBuilder.ShapeGenerator.CreateShape" to get a primitive with default parameters.

    SortMethod

    Describes methods of sorting points in 2d space.

    WindingOrder

    Describes the winding order of mesh triangles.

    In This Article
    • Classes
    • Structs
    • Enums
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023