CinemachineComponentBase Class

previous page next page

Cinemachine

An abstract representation of a mutator acting on a Cinemachine Virtual Camera

Inheritance Hierarchy

SystemObject  Object
    Component
      Behaviour
        MonoBehaviour
          CinemachineCinemachineComponentBase
            More...

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

Syntax

[DocumentationSortingAttribute(24f, DocumentationSortingAttributeLevel.API)]
public abstract class CinemachineComponentBase : MonoBehaviour

Cinemachine.CinemachineComponentBase = function();

Type.createClass(
	'Cinemachine.CinemachineComponentBase',
	UnityEngine.MonoBehaviour);

The CinemachineComponentBase type exposes the following members.

Constructors

	Name	Description
	CinemachineComponentBase

Properties

	Name	Description
	FollowTarget	Returns the owner vcam's Follow target.
	IsValid	Returns true if this object is enabled and set up to produce results.
	LookAtTarget	Returns the owner vcam's LookAt target.
	Stage	What part of the pipeline this fits into
	VcamState	Returns the owner vcam's CameraState.
	VirtualCamera	Get the associated CinemachineVirtualCameraBase

Methods

	Name	Description
	MutateCameraState	Mutates the camera state. This state will later be applied to the camera.
	OnPositionDragged	API for the editor, to process a position drag from the user. Base class implementation does nothing.

Fields

	Name	Description
	Epsilon	Useful constant for very small floats

Inheritance Hierarchy

SystemObject
  Object
    Component
      Behaviour
        MonoBehaviour
          CinemachineCinemachineComponentBase
            CinemachineCinemachineBasicMultiChannelPerlin
            CinemachineCinemachineComposer
            CinemachineCinemachineFramingTransposer
            CinemachineCinemachineHardLockToTarget
            CinemachineCinemachineHardLookAt
            CinemachineCinemachinePOV
            CinemachineCinemachineTrackedDolly
            CinemachineCinemachineTransposer

previous page start next page