CinemachineComponentBase Class

Cinemachine

previous page next page

CinemachineComponentBase Class

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
Copy
[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
  NameDescription
Protected methodCinemachineComponentBase
Top
Properties
  NameDescription
Public propertyFollowTarget
Returns the owner vcam's Follow target.
Public propertyIsValid
Returns true if this object is enabled and set up to produce results.
Public propertyLookAtTarget
Returns the owner vcam's LookAt target.
Public propertyStage
What part of the pipeline this fits into
Public propertyVcamState
Returns the owner vcam's CameraState.
Public propertyVirtualCamera
Get the associated CinemachineVirtualCameraBase
Top
Methods
  NameDescription
Public methodMutateCameraState
Mutates the camera state. This state will later be applied to the camera.
Public methodOnPositionDragged
API for the editor, to process a position drag from the user. Base class implementation does nothing.
Top
Fields
  NameDescription
Protected fieldStatic memberEpsilon
Useful constant for very small floats
Top
See Also
Inheritance Hierarchy
SystemObject
  Object
    Component
      Behaviour
        MonoBehaviour
          CinemachineCinemachineComponentBase
            CinemachineCinemachineBasicMultiChannelPerlin
            CinemachineCinemachineComposer
            CinemachineCinemachineFramingTransposer
            CinemachineCinemachineHardLockToTarget
            CinemachineCinemachineHardLookAt
            CinemachineCinemachinePOV
            CinemachineCinemachineTrackedDolly
            CinemachineCinemachineTransposer
previous page start next page