docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class CinemachineFreeLookModifier.Modifier

    Interface for an object that will modify some aspect of a FreeLook camera based on the vertical axis value.

    Inheritance
    object
    CinemachineFreeLookModifier.Modifier
    CinemachineFreeLookModifier.ComponentModifier<T>
    CinemachineFreeLookModifier.LensModifier
    CinemachineFreeLookModifier.TiltModifier
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Unity.Cinemachine
    Assembly: solution.dll
    Syntax
    [Serializable]
    public abstract class CinemachineFreeLookModifier.Modifier

    Properties

    Name Description
    CachedComponentType

    Type of the cached component (null if no cached component). If this modifier targets specific components, this value indicates the type of that component. The modifier should cache the component, for performance.

    HasRequiredComponent

    Return true if cached vcam component is present or not required

    Methods

    Name Description
    AfterPipeline(CinemachineVirtualCameraBase, ref CameraState, float, float)

    Called from extension's PostPipelineStageCallback(Finalize). Perform any necessary actions to state, and restore any camera parameters changed in BeforePipeline(CinemachineVirtualCameraBase, ref CameraState, float, float).

    BeforePipeline(CinemachineVirtualCameraBase, ref CameraState, float, float)

    Called from extension's PrePipelineMutateCameraState(). Perform any necessary actions to modify relevant camera settings. Original camera settings should be restored in AfterPipeline(CinemachineVirtualCameraBase, ref CameraState, float, float).

    RefreshCache(CinemachineVirtualCameraBase)

    Called from OnEnable and from the inspector. Refresh any performance-sensitive stuff.

    Reset(CinemachineVirtualCameraBase)

    Called when the modifier is created. Initialize fields with appropriate values.

    Validate(CinemachineVirtualCameraBase)

    Called from OnValidate in the editor. Validate and sanitize the fields.

    In This Article
    Back to top
    Copyright © 2023 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)