Class CinemachineStoryboard
An add-on module for Cinemachine Virtual Camera that places an image in screen space over the camera's output.
Inheritance
CinemachineStoryboard
Inherited Members
UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
Namespace: Cinemachine
Syntax
[DocumentationSorting(DocumentationSortingAttribute.Level.UserRef)]
[AddComponentMenu("")]
[ExecuteInEditMode]
public class CinemachineStoryboard : CinemachineExtensionFields
m_Alpha
Declaration
[Tooltip("The opacity of the image. 0 is transparent, 1 is opaque")]
[Range(0F, 1F)]
public float m_AlphaField Value
| Type | Description |
|---|---|
| Single |
m_Aspect
Declaration
[Tooltip("How to handle differences between image aspect and screen aspect")]
public CinemachineStoryboard.FillStrategy m_AspectField 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_CenterField Value
| Type | Description |
|---|---|
| Vector2 |
m_Image
Declaration
[Tooltip("The image to display")]
public Texture m_ImageField Value
| Type | Description |
|---|---|
| Texture |
m_MuteCamera
Declaration
[Tooltip("If checked, Camera transform will not be controlled by this virtual camera")]
public bool m_MuteCameraField Value
| Type | Description |
|---|---|
| Boolean |
m_Rotation
Declaration
[Tooltip("The screen-space rotation to apply to the image")]
public Vector3 m_RotationField Value
| Type | Description |
|---|---|
| Vector3 |
m_Scale
Declaration
[Tooltip("The screen-space scaling to apply to the image")]
public Vector2 m_ScaleField 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_ShowImageField Value
| Type | Description |
|---|---|
| Boolean |
m_SplitView
Declaration
[Range(-1F, 1F)]
[Tooltip("Wipe the image on and off horizontally")]
public float m_SplitViewField Value
| Type | Description |
|---|---|
| Single |
m_SyncScale
Declaration
[Tooltip("If checked, X and Y scale are synchronized")]
public bool m_SyncScaleField Value
| Type | Description |
|---|---|
| Boolean |
s_StoryboardGlobalMute
Declaration
[Tooltip("If checked, all storyboards are globally muted")]
public static bool s_StoryboardGlobalMuteField Value
| Type | Description |
|---|---|
| Boolean |
Methods
ConnectToVcam(Boolean)
Declaration
protected override void ConnectToVcam(bool connect)Parameters
| Type | Name | Description |
|---|---|---|
| Boolean | connect |
Overrides
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 |