Class NoiseSettings | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class NoiseSettings

    This is an asset that defines a noise profile. A noise profile is the shape of the noise as a function of time. You can build arbitrarily complex shapes by combining different base perlin noise frequencies at different amplitudes.

    The frequencies and amplitudes should be chosen with care, to ensure an interesting noise quality that is not obviously repetitive.

    As a mathematical side-note, any arbitrary periodic curve can be broken down into a series of fixed-amplitude sine-waves added together. This is called fourier decomposition, and is the basis of much signal processing. It doesn't really have much to do with this asset, but it's super interesting!

    Inheritance
    ScriptableObject
    NoiseSettings
    Namespace: Cinemachine
    Syntax
    [DocumentationSorting(DocumentationSortingAttribute.Level.UserRef)]
    public sealed class NoiseSettings : ScriptableObject

    Properties

    OrientationNoise

    Gets the array of orientation noise channels for this NoiseSettings

    Declaration
    public NoiseSettings.TransformNoiseParams[] OrientationNoise { get; }
    Property Value
    Type Description
    NoiseSettings.TransformNoiseParams[]

    PositionNoise

    Gets the array of positional noise channels for this NoiseSettings

    Declaration
    public NoiseSettings.TransformNoiseParams[] PositionNoise { get; }
    Property Value
    Type Description
    NoiseSettings.TransformNoiseParams[]

    Methods

    CopyFrom(NoiseSettings)

    Clones the contents of the other asset into this one

    Declaration
    public void CopyFrom(NoiseSettings other)
    Parameters
    Type Name Description
    NoiseSettings other

    GetCombinedFilterResults(NoiseSettings.TransformNoiseParams[], Single, Vector3)

    Get the noise signal value at a specific time

    Declaration
    public static Vector3 GetCombinedFilterResults(NoiseSettings.TransformNoiseParams[] noiseParams, float time, Vector3 timeOffsets)
    Parameters
    Type Name Description
    NoiseSettings.TransformNoiseParams[] noiseParams

    The parameters that define the noise function

    System.Single time

    The time at which to sample the noise function

    Vector3 timeOffsets

    Start time offset for each channel

    Returns
    Type Description
    Vector3

    The 3-channel noise signal value at the specified time

    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