CinemachineCore Class

Cinemachine

CinemachineCore Class

A singleton that manages complete lists of CinemachineBrain and, Cinemachine Virtual Cameras, and the priority queue. Provides services to keeping track of whether Cinemachine Virtual Cameras have been updated each frame.
Inheritance Hierarchy
SystemObject  CinemachineCinemachineCore

Namespace:  Cinemachine
Assembly:  Cinemachine (in Cinemachine.dll) Version: 2.0.0.0 (2.0.0.0)
Syntax
public sealed class CinemachineCore
Cinemachine.CinemachineCore = function();

Type.createClass(
	'Cinemachine.CinemachineCore');

The CinemachineCore type exposes the following members.

Constructors
  NameDescription
Public methodCinemachineCore
Top
Properties
  NameDescription
Public propertyBrainCount
Access the array of active CinemachineBrains in the scene
Public propertyStatic memberInstance
Get the singleton instance
Public propertyVirtualCameraCount
List of all active Cinemachine Virtual Cameras for all brains. This list is kept sorted by priority.
Top
Methods
  NameDescription
Public methodFindPotentialTargetBrain
Try to find a CinemachineBrain to associate with a Cinemachine Virtual Camera. The first CinemachineBrain in which this Cinemachine Virtual Camera is live will be used. If none, then the first active CinemachineBrain will be used. Brains with OutputCamera == null will not be returned. Final result may be null.
Public methodGenerateCameraActivationEvent
Signal that the virtual has been activated. If the camera is live, then all CinemachineBrains that are showing it will send an activation event.
Public methodGenerateCameraCutEvent
Signal that the virtual camera's content is discontinuous WRT the previous frame. If the camera is live, then all CinemachineBrains that are showing it will send a cut event.
Public methodGetActiveBrain
Access the array of active CinemachineBrains in the scene without gebnerating garbage
Public methodGetVcamUpdateStatus
Internal use only
Public methodGetVirtualCamera
Access the array of active ICinemachineCamera in the scene without gebnerating garbage
Public methodIsLive
Is this virtual camera currently actively controlling any Camera?
Top
Fields
  NameDescription
Public fieldStatic memberGetInputAxis
Delegate for overriding Unity's default input system. If you set this, then your delegate will be called instead of System.Input.GetAxis(axisName) whenever in-game user input is needed.
Public fieldStatic memberkStreamingVersion
Data version string. Used to upgrade from legacy projects
Public fieldStatic memberkVersionString
Human-readable Cinemachine Version
Public fieldStatic membersShowHiddenObjects
If true, show hidden Cinemachine objects, to make manual script mapping possible.
Top
See Also