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

    Class NoiseSettings

    A data class that can be used to define various types of noise.

    Inheritance
    Object
    Object
    ScriptableObject
    NoiseSettings
    Inherited Members
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(String)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(Object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, Boolean)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectOfType<T>()
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.ToString()
    Object.name
    Object.hideFlags
    Namespace: UnityEditor.Experimental.TerrainAPI
    Syntax
    [Serializable]
    public class NoiseSettings : ScriptableObject

    Fields

    domainSettings

    The domain settings for the defined noise field. Contains serialized data defining the NoiseType and FractalType for this NoiseSettings instance.

    Declaration
    [Tooltip("Settings for noise domain")]
    public NoiseSettings.NoiseDomainSettings domainSettings
    Field Value
    Type Description
    NoiseSettings.NoiseDomainSettings

    positionTexture

    Declaration
    public Texture positionTexture
    Field Value
    Type Description
    Texture

    transformSettings

    The transform settings for the defined noise field

    Declaration
    [Tooltip("Settings for noise transform and coordinate space")]
    public NoiseSettings.NoiseTransformSettings transformSettings
    Field Value
    Type Description
    NoiseSettings.NoiseTransformSettings

    useTextureForPositions

    Declaration
    public bool useTextureForPositions
    Field Value
    Type Description
    Boolean

    Properties

    trs

    The noise field's TRS transformation Matrix

    Declaration
    public Matrix4x4 trs { get; }
    Property Value
    Type Description
    Matrix4x4

    A Matrix4x4 for the noise field's TRS matrix

    Methods

    Copy(NoiseSettings)

    Copies the runtime information from a provided NoiseSettings instance.

    Declaration
    public void Copy(NoiseSettings noiseSettings)
    Parameters
    Type Name Description
    NoiseSettings noiseSettings

    The NoiseSettings instance to copy from

    CopySerialized(NoiseSettings)

    Copies the serialized information from a provided NoiseSettings instance

    Declaration
    public void CopySerialized(NoiseSettings noiseSettings)
    Parameters
    Type Name Description
    NoiseSettings noiseSettings

    The NoiseSettings instance to copy from

    Reset()

    Resets this NoiseSettings instance to have the default settings

    Declaration
    public void Reset()

    SetupMaterial(Material)

    Sets up the provided Material to be used with this NoiseSettings instance. Some assumptions are made here as far as definitions and variable declarations in the Material's Shader go. float4 _NoiseTranslation, float4 _NoiseRotation, float4 _NoiseScale, and float4x4 _NoiseTransform are assumed to be declared. Sets up the Material using the NoiseType and FractalType SetupMaterial functions.

    Declaration
    public void SetupMaterial(Material mat)
    Parameters
    Type Name Description
    Material mat

    The Material to set up for use with this NoiseSettings instance

    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