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

    Class CinemachinePOV

    This is a CinemachineComponent in the Aim section of the component pipeline. Its job is to aim the camera in response to the user's mouse or joystick input.

    The composer does not change the camera's position. It will only pan and tilt the camera where it is, in order to get the desired framing. To move the camera, you have to use the virtual camera's Body section.

    Inheritance
    MonoBehaviour
    CinemachineComponentBase
    CinemachinePOV
    Inherited Members
    CinemachineComponentBase.Epsilon
    CinemachineComponentBase.VirtualCamera
    CinemachineComponentBase.FollowTarget
    CinemachineComponentBase.LookAtTarget
    CinemachineComponentBase.FollowTargetPosition
    CinemachineComponentBase.FollowTargetRotation
    CinemachineComponentBase.LookAtTargetPosition
    CinemachineComponentBase.LookAtTargetRotation
    CinemachineComponentBase.VcamState
    CinemachineComponentBase.PrePipelineMutateCameraState(CameraState)
    CinemachineComponentBase.OnTargetObjectWarped(Transform, Vector3)
    Namespace: Cinemachine
    Syntax
    [DocumentationSorting(DocumentationSortingAttribute.Level.UserRef)]
    public class CinemachinePOV : CinemachineComponentBase

    Fields

    m_HorizontalAxis

    The Horizontal axis. Value is -180..180. Controls the horizontal orientation

    Declaration
    public AxisState m_HorizontalAxis
    Field Value
    Type Description
    AxisState

    m_HorizontalRecentering

    Controls how automatic recentering of the Horizontal axis is accomplished

    Declaration
    public AxisState.Recentering m_HorizontalRecentering
    Field Value
    Type Description
    AxisState.Recentering

    m_VerticalAxis

    The Vertical axis. Value is -90..90. Controls the vertical orientation

    Declaration
    public AxisState m_VerticalAxis
    Field Value
    Type Description
    AxisState

    m_VerticalRecentering

    Controls how automatic recentering of the Vertical axis is accomplished

    Declaration
    public AxisState.Recentering m_VerticalRecentering
    Field Value
    Type Description
    AxisState.Recentering

    Properties

    IsValid

    True if component is enabled and has a LookAt defined

    Declaration
    public override bool IsValid { get; }
    Property Value
    Type Description
    System.Boolean
    Overrides
    CinemachineComponentBase.IsValid

    Stage

    Get the Cinemachine Pipeline stage that this component implements. Always returns the Aim stage

    Declaration
    public override CinemachineCore.Stage Stage { get; }
    Property Value
    Type Description
    CinemachineCore.Stage
    Overrides
    CinemachineComponentBase.Stage

    Methods

    MutateCameraState(ref CameraState, Single)

    Applies the axis values and orients the camera accordingly

    Declaration
    public override void MutateCameraState(ref CameraState curState, float deltaTime)
    Parameters
    Type Name Description
    CameraState curState

    The current camera state

    System.Single deltaTime

    Used for calculating damping. Not used.

    Overrides
    CinemachineComponentBase.MutateCameraState(ref CameraState, Single)
    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