docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class MeshSelection

    Provides helper functions for selecting Unity objects and ProBuilder mesh elements.

    Inheritance
    object
    MeshSelection
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEditor.ProBuilder
    Assembly: Unity.ProBuilder.Editor.dll
    Syntax
    [InitializeOnLoad]
    public static class MeshSelection

    Properties

    activeMesh

    Gets the ProBuilder mesh on the active selected GameObject.

    Declaration
    public static ProBuilderMesh activeMesh { get; }
    Property Value
    Type Description
    ProBuilderMesh

    bounds

    Gets the axis-aligned bounding box encompassing the selected elements.

    Declaration
    public static Bounds bounds { get; }
    Property Value
    Type Description
    Bounds

    deep

    Gets all selected ProBuilderMesh components, including those on the children of selected objects.

    Declaration
    public static IEnumerable<ProBuilderMesh> deep { get; }
    Property Value
    Type Description
    IEnumerable<ProBuilderMesh>

    All selected ProBuilderMesh components, including those on the children of selected objects.

    selectedEdgeCount

    Gets the sum of all currently selected edges on all currently selected ProBuilderMesh objects.

    Declaration
    public static int selectedEdgeCount { get; }
    Property Value
    Type Description
    int

    selectedFaceCount

    Gets the sum of all currently selected faces on all currently selected ProBuilderMesh objects.

    Declaration
    public static int selectedFaceCount { get; }
    Property Value
    Type Description
    int

    selectedObjectCount

    Gets how many ProBuilderMesh components are currently selected.

    Declaration
    public static int selectedObjectCount { get; }
    Property Value
    Type Description
    int

    selectedSharedVertexCount

    Gets the sum of all currently selected shared vertices on all currently selected ProBuilderMesh objects.

    Declaration
    public static int selectedSharedVertexCount { get; }
    Property Value
    Type Description
    int
    See Also
    selectedVertexCount

    selectedVertexCount

    Gets the sum of all currently selected vertices on all currently selected ProBuilderMesh objects.

    Declaration
    public static int selectedVertexCount { get; }
    Property Value
    Type Description
    int
    See Also
    selectedSharedVertexCount

    top

    Get all selected ProBuilderMesh components. Corresponds to Selection.gameObjects.Select(x => x.GetComponent<ProBuilderMesh>().Where(y => y != null);.

    Declaration
    public static IEnumerable<ProBuilderMesh> top { get; }
    Property Value
    Type Description
    IEnumerable<ProBuilderMesh>

    totalCommonVertexCount

    Gets the number of all selected vertices across the selected ProBuilder meshes, excluding coincident duplicates.

    Declaration
    public static int totalCommonVertexCount { get; }
    Property Value
    Type Description
    int

    totalEdgeCount

    Gets the sum of all selected ProBuilderMesh edges.

    Declaration
    public static int totalEdgeCount { get; }
    Property Value
    Type Description
    int

    totalFaceCount

    Gets the sum of all selected ProBuilderMesh faces.

    Declaration
    public static int totalFaceCount { get; }
    Property Value
    Type Description
    int

    totalTriangleCountCompiled

    Gets the sum of all selected ProBuilder compiled mesh triangles (3 indices make up a triangle, or 4 indices if topology is quad).

    Declaration
    public static int totalTriangleCountCompiled { get; }
    Property Value
    Type Description
    int

    totalVertexCount

    Gets the sum of the vertices across all selected meshes.

    Declaration
    public static int totalVertexCount { get; }
    Property Value
    Type Description
    int
    Remarks

    This is vertexCount, not vertexCount.

    Methods

    ClearElementAndObjectSelection()

    Clears both the objects and ProBuilder mesh attribute selections.

    Declaration
    public static void ClearElementAndObjectSelection()
    See Also
    ClearElementSelection()

    ClearElementSelection()

    Clears all selected mesh attributes in the current selection. This means triangles, faces, and edges, but not objects.

    Declaration
    public static void ClearElementSelection()
    See Also
    ClearElementAndObjectSelection()

    Events

    objectSelectionChanged

    Raised when the object selection changes.

    Declaration
    public static event Action objectSelectionChanged
    Event Type
    Type Description
    Action
    In This Article
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)