using UnityEngine;
namespace Unity.Cinemachine
{
///
/// This component will generate camera-specific activation and deactivation events.
/// Add it to a Cinemachine Camera.
///
[AddComponentMenu("Cinemachine/Helpers/Cinemachine Camera Events")]
[SaveDuringPlay]
[HelpURL(Documentation.BaseURL + "manual/CinemachineCameraEvents.html")]
public class CinemachineCameraEvents : MonoBehaviour
{
///
/// This is the object whose events are being monitored. If null and the current
/// GameObject has a CinemachineVirtualCameraBase component, that component will be used.
///
[Tooltip("This is the object whose events are being monitored. If null and the current "
+ "GameObject has a CinemachineVirtualCameraBase component, that component will be used.")]
public CinemachineVirtualCameraBase EventTarget;
///
/// This is the object emitting the events.
/// If a blend is involved, it will be fired at the start of the blend.
///
[Space]
[Tooltip("This event will fire whenever a virtual camera becomes active in the context of a mixer. "
+ "If a blend is involved, then the event will fire on the first frame of the blend.")]
public CinemachineCore.CameraEvent CameraActivatedEvent = new ();
///
/// This event will fire whenever a virtual stops being live.
/// If a blend is involved, then the event will fire after the last frame of the blend.
///
[Tooltip("This event will fire whenever a virtual stops being live. If a blend is "
+ "involved, then the event will fire after the last frame of the blend.")]
public CinemachineCore.CameraEvent CameraDeactivatedEvent = new ();
///
/// This event will fire whenever a blend is created that involves this camera.
/// The handler can modify any settings in the blend, except the cameras themselves.
///
[Tooltip("This event will fire whenever a blend is created that involves this camera. "
+ "The handler can modify any settings in the blend, except the cameras themselves.")]
public CinemachineCore.BlendEvent BlendCreatedEvent = new ();
///
/// This event will fire whenever a virtual camera finishes blending in.
/// It will not fire if the blend length is zero.
///
[Tooltip("This event will fire whenever a virtual camera finishes blending in. "
+ "It will not fire if the blend length is zero.")]
public CinemachineCore.CameraEvent BlendFinishedEvent = new ();
void OnEnable()
{
if (EventTarget == null)
TryGetComponent(out EventTarget);
if (EventTarget != null)
{
CinemachineCore.CameraActivatedEvent.AddListener(OnCameraActivated);
CinemachineCore.CameraDeactivatedEvent.AddListener(OnCameraDeactivated);
CinemachineCore.BlendCreatedEvent.AddListener(OnBlendCreated);
CinemachineCore.BlendFinishedEvent.AddListener(OnBlendFinished);
}
}
void OnDisable()
{
CinemachineCore.CameraActivatedEvent.RemoveListener(OnCameraActivated);
CinemachineCore.CameraDeactivatedEvent.RemoveListener(OnCameraDeactivated);
CinemachineCore.BlendCreatedEvent.RemoveListener(OnBlendCreated);
CinemachineCore.BlendFinishedEvent.RemoveListener(OnBlendFinished);
}
void OnCameraActivated(ICinemachineCamera.ActivationEventParams evt)
{
if (evt.IncomingCamera == (ICinemachineCamera)EventTarget)
CameraActivatedEvent.Invoke(evt.Origin, evt.IncomingCamera);
}
void OnBlendCreated(CinemachineCore.BlendEventParams evt)
{
if (evt.Blend.CamA == (ICinemachineCamera)EventTarget || evt.Blend.CamB == (ICinemachineCamera)EventTarget)
BlendCreatedEvent.Invoke(evt);
}
void OnBlendFinished(ICinemachineMixer mixer, ICinemachineCamera cam)
{
if (cam == (ICinemachineCamera)EventTarget)
BlendFinishedEvent.Invoke(mixer, cam);
}
void OnCameraDeactivated(ICinemachineMixer mixer, ICinemachineCamera cam)
{
if (cam == (ICinemachineCamera)EventTarget)
CameraActivatedEvent.Invoke(mixer, cam);
}
}
}