Class vCast_Fader

vCast Fader for transition.
vCast 過場器，用於過場。

Inheritance

System.Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

vCast_Fader

Namespace: Votanic.vXR.vCast

Assembly: Votanic.vXR.dll

Syntax

[AddComponentMenu("")]
public class vCast_Fader : MonoBehaviour

Fields

fadeColor

The default color when fade out.
預設淡出顏色。

Declaration

[Tooltip("The default color when fade out.\n預設淡出顏色。")]
public Color fadeColor

Field Value

Type	Description
UnityEngine.Color

isFading

Return true if transiting.
當過場時傳回 true。

Declaration

[Header("[Status]")]
[Tooltip("Return true if transiting.\n當過場時傳回 true。")]
public bool isFading

Field Value

Type	Description
System.Boolean

isPaused

Return true if the transition is paused.
當過場被暫停時傳回 true。

Declaration

[Tooltip("Return true if the transition is paused.\n當過場被暫停時傳回 true。")]
public bool isPaused

Field Value

Type	Description
System.Boolean

isRendering

Return true if fader is displaying.
當過場器為顯示狀態時傳回 true。

Declaration

[Tooltip("Return true if fader is displaying.\n當過場器為顯示狀態時傳回 true。")]
public bool isRendering

Field Value

Type	Description
System.Boolean

renderQueue

The Render Queue of fader materials.
過場器物料渲染隊列。

Declaration

[Tooltip("The Render Queue of fader materials.\n過場器物料渲染隊列。")]
public int renderQueue

Field Value

Type	Description
System.Int32

transition

Transition setting.
過場設定。

Declaration

[Header("[Settings]")]
[Tooltip("Transition setting.\n過場設定。")]
public Fader transition

Field Value

Type	Description
Fader

Methods

Fade(Color, Single, Single, Single, MotionParameter)

Apply custom fade.
使用自定義過場。

Fade(Color.black, 8, 0, 0, MotionParameter.Velocity)

Declaration

public void Fade(Color color, float factor, float accel, float decel, MotionParameter parameter)

Parameters

Type	Name	Description
UnityEngine.Color	color	Target Color 目標顏色
System.Single	factor	Transition factor value 過場因子
System.Single	accel	Transition accelerating value 過場加速值
System.Single	decel	Transition decelerating value 過場減速值
MotionParameter	parameter	Transition calculation parameter 過場計算參數

FadeIn()

Apply Fade In of fader.
使用過場器的淡入。

Declaration

public void FadeIn()

FadeOut()

Apply Fade Out of fader.
使用過場器的淡出。

Declaration

public void FadeOut()

Pause()

Pause the current transition.
暫停目前過場。

Declaration

public void Pause()

RenderQueue(Int32)

Set the Render Queue of fader materials.
設定過場器物料的渲染隊列。

RenderQueue(3000)

Declaration

public void RenderQueue(int renderQueue)

Parameters

Type	Name	Description
System.Int32	renderQueue	Target queue 目標隊列

UnPause()

UnPause the current transition.
取消暫停目前過場。

Declaration

public void UnPause()

Events

OnRenderQueueChanged

Render Queue change action.
渲染隊列變更動作。

Declaration

public event Action<vCast_Fader, int> OnRenderQueueChanged

Event Type

Type	Description
System.Action<vCast_Fader, System.Int32>