CinemachinePOV Class

Cinemachine

previous page next page

Cinemachine

CinemachinePOV Class

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 Hierarchy

SystemObject  Object
    Component
      Behaviour
        MonoBehaviour
          CinemachineCinemachineComponentBase
            CinemachineCinemachinePOV

Namespace: Cinemachine
Assembly: Cinemachine (in Cinemachine.dll) Version: 2.0.0.0 (2.0.0.0)

Syntax

JavaScript

Copy

[DocumentationSortingAttribute(23f, DocumentationSortingAttributeLevel.UserRef)]
[AddComponentMenu("")]
[RequireComponent(typeof(CinemachinePipeline))]
[SaveDuringPlayAttribute]
public class CinemachinePOV : CinemachineComponentBase

Cinemachine.CinemachinePOV = function();

Type.createClass(
	'Cinemachine.CinemachinePOV',
	Cinemachine.CinemachineComponentBase);

The CinemachinePOV type exposes the following members.

Constructors

	Name	Description
	CinemachinePOV

Top

Properties

	Name	Description
	FollowTarget	Returns the owner vcam's Follow target. (Inherited from CinemachineComponentBase.)
	IsValid	True if component is enabled and has a LookAt defined (Overrides CinemachineComponentBaseIsValid.)
	LookAtTarget	Returns the owner vcam's LookAt target. (Inherited from CinemachineComponentBase.)
	Stage	Get the Cinemachine Pipeline stage that this component implements. Always returns the Aim stage (Overrides CinemachineComponentBaseStage.)
	VcamState	Returns the owner vcam's CameraState. (Inherited from CinemachineComponentBase.)
	VirtualCamera	Get the associated CinemachineVirtualCameraBase (Inherited from CinemachineComponentBase.)

Top

Methods

	Name	Description
	MutateCameraState	Applies the axis values and orients the camera accordingly (Overrides CinemachineComponentBaseMutateCameraState(CameraState, Single).)
	OnPositionDragged	API for the editor, to process a position drag from the user. Base class implementation does nothing. (Inherited from CinemachineComponentBase.)

Top

Fields

	Name	Description
	m_HorizontalAxis	The Horizontal axis. Value is -180..180. Controls the horizontal orientation
	m_VerticalAxis	The Vertical axis. Value is -90..90. Controls the vertical orientation

Top

Reference

Cinemachine Namespace

Visit the Cinemachine Forum

https://unity3d.com/legal/terms-of-service

previous page start next page