Class CinemachineCore
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.
Inherited Members
Namespace: Cinemachine
Assembly: solution.dll
Syntax
public sealed class CinemachineCoreFields
| Name | Description |
|---|---|
| CameraCutEvent | This event will fire after a brain updates its Camera |
| CameraUpdatedEvent | This event will fire after a brain updates its Camera |
| GetBlendOverride | Delegate for overriding a blend that is about to be applied to a transition. A handler can either return the default blend, or a new blend specific to current conditions. |
| GetInputAxis | 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. |
| UniformDeltaTimeOverride | If non-negative, cinemachine will update with this uniform delta time. Usage is for timelines in manual update mode. |
| kStreamingVersion | Data version string. Used to upgrade from legacy projects |
| kVersionString | Human-readable Cinemachine Version |
| sShowHiddenObjects | If true, show hidden Cinemachine objects, to make manual script mapping possible. |
Properties
| Name | Description |
|---|---|
| BrainCount | Access the array of active CinemachineBrains in the scene |
| Instance | Get the singleton instance |
| VirtualCameraCount | List of all active Cinemachine Virtual Cameras for all brains. This list is kept sorted by priority. |
Methods
| Name | Description |
|---|---|
| FindPotentialTargetBrain(CinemachineVirtualCameraBase) | 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 with the correct layer filter will be used. Brains with OutputCamera == null will not be returned. Final result may be null. |
| GenerateCameraActivationEvent(ICinemachineCamera, ICinemachineCamera) | Signal that the virtual has been activated. If the camera is live, then all CinemachineBrains that are showing it will send an activation event. |
| GenerateCameraCutEvent(ICinemachineCamera) | 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. |
| GetActiveBrain(int) | Access the array of active CinemachineBrains in the scene without gebnerating garbage |
| GetVirtualCamera(int) | Access the array of active ICinemachineCamera in the scene without gebnerating garbage |
| IsLive(ICinemachineCamera) | Is this virtual camera currently actively controlling any Camera? |