Class CinemachineStoryboard

An add-on module for Cinemachine Virtual Camera that places an image in screen space over the camera's output.

Inheritance

Object

Object

Component

Behaviour

MonoBehaviour

CinemachineExtension

CinemachineStoryboard

Inherited Members

CinemachineExtension.Epsilon

CinemachineExtension.VirtualCamera

CinemachineExtension.Awake()

CinemachineExtension.OnDestroy()

CinemachineExtension.InvokePostPipelineStageCallback(CinemachineVirtualCameraBase, CinemachineCore.Stage, CameraState, Single)

CinemachineExtension.OnTargetObjectWarped(Transform, Vector3)

CinemachineExtension.OnTransitionFromCamera(ICinemachineCamera, Vector3, Single)

CinemachineExtension.GetExtraState<T>(ICinemachineCamera)

CinemachineExtension.GetAllExtraStates<T>()

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(String, Single)

MonoBehaviour.InvokeRepeating(String, Single, Single)

MonoBehaviour.CancelInvoke(String)

MonoBehaviour.IsInvoking(String)

MonoBehaviour.StartCoroutine(String)

MonoBehaviour.StartCoroutine(String, Object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(String)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(Object)

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, Component)

Component.TryGetComponent<T>(T)

Component.GetComponent(String)

Component.GetComponentInChildren(Type, Boolean)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(Boolean)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, Boolean)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(Boolean)

Component.GetComponentsInChildren<T>(Boolean, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, Boolean)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(Boolean)

Component.GetComponentsInParent<T>(Boolean, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(String)

Component.SendMessageUpwards(String, Object, SendMessageOptions)

Component.SendMessageUpwards(String, Object)

Component.SendMessageUpwards(String)

Component.SendMessageUpwards(String, SendMessageOptions)

Component.SendMessage(String, Object)

Component.SendMessage(String)

Component.SendMessage(String, Object, SendMessageOptions)

Component.SendMessage(String, SendMessageOptions)

Component.BroadcastMessage(String, Object, SendMessageOptions)

Component.BroadcastMessage(String, Object)

Component.BroadcastMessage(String)

Component.BroadcastMessage(String, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Component.rigidbody

Component.rigidbody2D

Component.camera

Component.light

Component.animation

Component.constantForce

Component.renderer

Component.audio

Component.networkView

Component.collider

Component.collider2D

Component.hingeJoint

Component.particleSystem

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(Object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, Boolean)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, Boolean)

Object.Destroy(Object, Single)

Object.Destroy(Object)

Object.DestroyImmediate(Object, Boolean)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, Boolean)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, Single)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)

Object.FindObjectOfType<T>()

UnityEngine.Object.FindObjectOfType<T>(System.Boolean)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindObjectOfType(Type, Boolean)

Object.ToString()

Object.name

Object.hideFlags

Namespace: Cinemachine

Syntax

[DocumentationSorting(DocumentationSortingAttribute.Level.UserRef)]
[AddComponentMenu("")]
[ExecuteInEditMode]
public class CinemachineStoryboard : CinemachineExtension

Fields

m_Alpha

Declaration

[Tooltip("The opacity of the image.  0 is transparent, 1 is opaque")]
[Range(0F, 1F)]
public float m_Alpha

Field Value

Type	Description
Single

m_Aspect

Declaration

[Tooltip("How to handle differences between image aspect and screen aspect")]
public CinemachineStoryboard.FillStrategy m_Aspect

Field Value

Type	Description
CinemachineStoryboard.FillStrategy

m_Center

Declaration

[Tooltip("The screen-space position at which to display the image.  Zero is center")]
public Vector2 m_Center

Field Value

Type	Description
Vector2

m_Image

Declaration

[Tooltip("The image to display")]
public Texture m_Image

Field Value

Type	Description
Texture

m_MuteCamera

Declaration

[Tooltip("If checked, Camera transform will not be controlled by this virtual camera")]
public bool m_MuteCamera

Field Value

Type	Description
Boolean

m_Rotation

Declaration

[Tooltip("The screen-space rotation to apply to the image")]
public Vector3 m_Rotation

Field Value

Type	Description
Vector3

m_Scale

Declaration

[Tooltip("The screen-space scaling to apply to the image")]
public Vector2 m_Scale

Field Value

Type	Description
Vector2

m_ShowImage

Declaration

[Tooltip("If checked, the specified image will be displayed as an overlay over the virtual camera's output")]
public bool m_ShowImage

Field Value

Type	Description
Boolean

m_SplitView

Declaration

[Range(-1F, 1F)]
[Tooltip("Wipe the image on and off horizontally")]
public float m_SplitView

Field Value

Type	Description
Single

m_SyncScale

Declaration

[Tooltip("If checked, X and Y scale are synchronized")]
public bool m_SyncScale

Field Value

Type	Description
Boolean

s_StoryboardGlobalMute

Declaration

[Tooltip("If checked, all storyboards are globally muted")]
public static bool s_StoryboardGlobalMute

Field Value

Type	Description
Boolean

Methods

ConnectToVcam(Boolean)

Declaration

protected override void ConnectToVcam(bool connect)

Parameters

Type	Name	Description
Boolean	connect

Overrides

CinemachineExtension.ConnectToVcam(Boolean)

PostPipelineStageCallback(CinemachineVirtualCameraBase, CinemachineCore.Stage, ref CameraState, Single)

Standard CinemachineExtension callback

Declaration

protected override void PostPipelineStageCallback(CinemachineVirtualCameraBase vcam, CinemachineCore.Stage stage, ref CameraState state, float wipeAmountTime)

Parameters

Type	Name	Description
CinemachineVirtualCameraBase	vcam
CinemachineCore.Stage	stage
CameraState	state
Single	wipeAmountTime

Overrides

CinemachineExtension.PostPipelineStageCallback(CinemachineVirtualCameraBase, CinemachineCore.Stage, ref CameraState, Single)