Class CinemachineStoryboard

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

Inheritance

Object

CinemachineExtension

CinemachineStoryboard

Inherited Members

CinemachineExtension.Epsilon

CinemachineExtension.VirtualCamera

CinemachineExtension.Awake()

CinemachineExtension.OnEnable()

CinemachineExtension.OnDestroy()

CinemachineExtension.PrePipelineMutateCameraStateCallback(CinemachineVirtualCameraBase, CameraState, Single)

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

CinemachineExtension.OnTargetObjectWarped(Transform, Vector3)

CinemachineExtension.ForceCameraPosition(Vector3, Quaternion)

CinemachineExtension.OnTransitionFromCamera(ICinemachineCamera, Vector3, Single)

CinemachineExtension.GetMaxDampTime()

CinemachineExtension.GetExtraState<T>(ICinemachineCamera)

CinemachineExtension.GetAllExtraStates<T>()

Namespace: Cinemachine

Syntax

public class CinemachineStoryboard : CinemachineExtension

Fields

m_Alpha

The opacity of the image. 0 is transparent, 1 is opaque

Declaration

public float m_Alpha

Field Value

Type	Description
Single

m_Aspect

How to handle differences between image aspect and screen aspect

Declaration

public CinemachineStoryboard.FillStrategy m_Aspect

Field Value

Type	Description
CinemachineStoryboard.FillStrategy

m_Center

The screen-space position at which to display the image. Zero is center

Declaration

public Vector2 m_Center

Field Value

Type	Description
Vector2

m_Image

The image to display

Declaration

public Texture m_Image

Field Value

Type	Description
Texture

m_MuteCamera

If checked, Camera transform will not be controlled by this virtual camera

Declaration

public bool m_MuteCamera

Field Value

Type	Description
Boolean

m_Rotation

The screen-space rotation to apply to the image

Declaration

public Vector3 m_Rotation

Field Value

Type	Description
Vector3

m_Scale

The screen-space scaling to apply to the image

Declaration

public Vector2 m_Scale

Field Value

Type	Description
Vector2

m_ShowImage

If checked, the specified image will be displayed as an overlay over the virtual camera's output

Declaration

public bool m_ShowImage

Field Value

Type	Description
Boolean

m_SplitView

Wipe the image on and off horizontally

Declaration

public float m_SplitView

Field Value

Type	Description
Single

m_SyncScale

If checked, X and Y scale are synchronized

Declaration

public bool m_SyncScale

Field Value

Type	Description
Boolean

s_StoryboardGlobalMute

If checked, all storyboards are globally muted

Declaration

public static bool s_StoryboardGlobalMute

Field Value

Type	Description
Boolean

Methods

ConnectToVcam(Boolean)

Connect to virtual camera. Adds/removes listener

Declaration

protected override void ConnectToVcam(bool connect)

Parameters

Type	Name	Description
Boolean	connect	True if connecting, false if disconnecting

Overrides

CinemachineExtension.ConnectToVcam(Boolean)

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

Callback to display the image

Declaration

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

Parameters

Type	Name	Description
CinemachineVirtualCameraBase	vcam	The virtual camera being processed
CinemachineCore.Stage	stage	The current pipeline stage
CameraState	state	The current virtual camera state
Single	deltaTime	The current applicable deltaTime

Overrides

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