Table of Contents

Class CineblendMaster

Namespace
Gasimo.CineBlend
Assembly
Cineblend.CSharp.dll

Camera Controller. Manages camera transitions and blending and applies them to the Main Camera this script is attached to.

[RequireActor(typeof(Camera))]
[ExecuteInEditMode]
[Category("Cineblend")]
public class CineblendMaster : Script, ICineCamera
Inheritance
object
Object
SceneObject
Script
CineblendMaster
Implements

Properties

DefaultBlendTime

Default blend time for camera transitions

[Tooltip("Default blend time for camera transitions")]
public float DefaultBlendTime { get; set; }

Property Value

float

FinalProperties

This Cameras processed final properties.

public CameraProperties FinalProperties { get; }

Property Value

CameraProperties

Instance 

public static CineblendMaster Instance { get; }

Property Value

CineblendMaster

Modules

This Camera's active modules.

public Dictionary<Type, ICameraModule> Modules { get; }

Property Value

Dictionary<Type, ICameraModule>

Name

Name of the camera. Used to improve readability in the editor.

public string Name { get; }

Property Value

string

Priority

The priority of the camera. The camera with the highest priority will be the active camera unless overriden by solo.

public int Priority { get; }

Property Value

int

Properties

This Camera's Properties.

public CameraProperties Properties { get; }

Property Value

CameraProperties

currentVirtualCamera

Current active Virtual Camera

public ICineCamera currentVirtualCamera { get; }

Property Value

ICineCamera

Methods

ClearSolo() 

public void ClearSolo()

OnStart()

Called when a script is enabled just before any of the Update methods is called for the first time.

public override void OnStart()

OnUpdate()

Called every frame if object is enabled.

public override void OnUpdate()

RegisterVirtualCamera(ICineCamera) 

public void RegisterVirtualCamera(ICineCamera virtualCamera)

Parameters

virtualCamera ICineCamera

SetSolo(ICineCamera) 

public void SetSolo(ICineCamera camera)

Parameters

camera ICineCamera

Transition(ICineCamera, ICineCamera, float)

Transitions from one camera to another

public void Transition(ICineCamera fromCamera, ICineCamera toCamera, float blendTime = 1)

Parameters

fromCamera ICineCamera
toCamera ICineCamera
blendTime float

Transition(ICineCamera, float)

Transitions to the selected camera

public void Transition(ICineCamera toCamera, float blendTime = 1)

Parameters

toCamera ICineCamera
blendTime float

UnregisterVirtualCamera(ICineCamera) 

public void UnregisterVirtualCamera(ICineCamera virtualCamera)

Parameters

virtualCamera ICineCamera

UpdateVirtualCameraPriority(VirtualCamera, int, int) 

public void UpdateVirtualCameraPriority(VirtualCamera virtualCamera, int oldPriority, int newPriority)

Parameters

virtualCamera VirtualCamera
oldPriority int
newPriority int