Struct AutoUnwrapSettings | ProBuilder | 4.3.1
docs.unity3d.com
    Show / Hide Table of Contents

    Struct AutoUnwrapSettings

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

    Namespace: UnityEngine.ProBuilder
    Syntax
    [Serializable]
    public struct AutoUnwrapSettings

    Constructors

    AutoUnwrapSettings(AutoUnwrapSettings)

    A copy constructor.

    Declaration
    public AutoUnwrapSettings(AutoUnwrapSettings unwrapSettings)
    Parameters
    Type Name Description
    AutoUnwrapSettings unwrapSettings

    The settings to copy to this new instance.

    Properties

    anchor

    The starting point from which UV transform operations will be performed.

    Declaration
    public AutoUnwrapSettings.Anchor anchor { get; set; }
    Property Value
    Type Description
    AutoUnwrapSettings.Anchor

    defaultAutoUnwrapSettings

    Declaration
    public static AutoUnwrapSettings defaultAutoUnwrapSettings { get; }
    Property Value
    Type Description
    AutoUnwrapSettings

    fill

    The @"UnityEngine.ProBuilder.AutoUnwrapSettings.Fill" mode.

    Declaration
    public AutoUnwrapSettings.Fill fill { get; set; }
    Property Value
    Type Description
    AutoUnwrapSettings.Fill

    fit

    Get a set of unwrap parameters that strectches the face texture to fill a normalized coordinate space, maintaining th aspect ratio.

    Declaration
    public static AutoUnwrapSettings fit { get; }
    Property Value
    Type Description
    AutoUnwrapSettings

    flipU

    When enabled UV coordinates will be inverted horizontally.

    Declaration
    public bool flipU { get; set; }
    Property Value
    Type Description
    Boolean

    flipV

    When enabled UV coordinates will be inverted vertically.

    Declaration
    public bool flipV { get; set; }
    Property Value
    Type Description
    Boolean

    offset

    Added to UV coordinates after projection and anchor settings.

    Declaration
    public Vector2 offset { get; set; }
    Property Value
    Type Description
    Vector2

    rotation

    An amount in degrees that UV coordinates are to be rotated clockwise.

    Declaration
    public float rotation { get; set; }
    Property Value
    Type Description
    Single

    scale

    Coordinates are multiplied by this value after projection and anchor settings.

    Declaration
    public Vector2 scale { get; set; }
    Property Value
    Type Description
    Vector2

    stretch

    Get a set of unwrap parameters that strectches the face texture to fill a normalized coordinate space, disregarding the aspect ratio.

    Declaration
    public static AutoUnwrapSettings stretch { get; }
    Property Value
    Type Description
    AutoUnwrapSettings

    swapUV

    When enabled the coordinates will have their U and V parameters exchanged.

    Declaration
    public bool swapUV { get; set; }
    Property Value
    Type Description
    Boolean
    Examples

    {U, V} becomes {V, U}

    tile

    Get a set of unwrap parameters that tiles UVs.

    Declaration
    public static AutoUnwrapSettings tile { get; }
    Property Value
    Type Description
    AutoUnwrapSettings

    useWorldSpace

    By default, UVs are project in local (or model) coordinates. Enable useWorldSpace to transform vertex positions into world space for UV projection.

    Declaration
    public bool useWorldSpace { get; set; }
    Property Value
    Type Description
    Boolean

    Methods

    Reset()

    Resets all parameters to default values.

    Declaration
    public void Reset()

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    String
    Overrides
    ValueType.ToString()
    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