Interface INoiseType | Terrain Tools | 3.0.2-preview.3
docs.unity3d.com
    Show / Hide Table of Contents

    Interface INoiseType

    Namespace: UnityEditor.Experimental.TerrainAPI
    Syntax
    public interface INoiseType

    Methods

    DoGUI(String)

    Renders the GUI for the NoiseType implementation using the data provided by the serialized string.

    Declaration
    string DoGUI(string serializedString)
    Parameters
    Type Name Description
    String serializedString

    A string for the serialized data used by the NoiseType implementation

    Returns
    Type Description
    String

    A string for the NoiseType implementation's serialized data after having gone through possible changes from user interaction with the GUI

    FromSerializedString(String)

    When overidden, converts a string representing the data for the NoiseType implementation into an an actual object reference to be used with said NoiseType implementation.

    Declaration
    object FromSerializedString(string serializedString)
    Parameters
    Type Name Description
    String serializedString

    A string representing a serialized object that is used by the NoiseType implementation

    Returns
    Type Description
    Object

    An object deserialized from the provided string

    GetDefaultSerializedString()

    Returns a string representing the default state of the data that this NoiseType implementation uses.

    Declaration
    string GetDefaultSerializedString()
    Returns
    Type Description
    String

    GetDescription()

    Returns a description of the NoiseType implementation

    Declaration
    NoiseTypeDescriptor GetDescription()
    Returns
    Type Description
    NoiseTypeDescriptor

    SetupMaterial(Material, String)

    Sets up a Material to be used with the NoiseType implementation. This function is called from within NoiseSettings.SetupMaterial( Material mat )

    Declaration
    void SetupMaterial(Material mat, string serializedString)
    Parameters
    Type Name Description
    Material mat

    The Material to setup for use with this NoiseType implementation

    String serializedString

    The serialized string representing the NoiseType data to be used when setting up the provided Material

    ToSerializedString(Object)

    When overidden, converts an object representing the data for a NoiseType implementation to a string. This is later serialized and stored in a NoiseSettings Asset.

    Declaration
    string ToSerializedString(object target)
    Parameters
    Type Name Description
    Object target

    The data representation for the NoiseType implementation to be converted into a string

    Returns
    Type Description
    String

    The string representation of the provided target object

    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