Class vGear_Reporter

Reporter tool of vGear controller.
vGear 控制器的報告工具。

Inheritance

System.Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

vCast_Device

vCast_ControllerTool

vGear_Reporter

Namespace: Votanic.vXR.vGear

Assembly: Votanic.vXR.dll

Syntax

[AddComponentMenu("")]
public class vGear_Reporter : vCast_ControllerTool

Fields

cam

The camera component of reporter tool.
報告工具的相機組件。

Declaration

[Header("[Components]")]
[Tooltip("The camera component of reporter tool.\n報告工具的相機組件。")]
public Camera cam

Field Value

Type	Description
UnityEngine.Camera

cameraAngle

Angle of camera lens.
鏡頭角度。

Declaration

[Range(15F, 120F)]
[Tooltip("Angle of camera lens.\n鏡頭角度。")]
public float cameraAngle

Field Value

Type	Description
System.Single

captureSFX

Sound effect of capture action.
捕捉畫面時的音效。

Declaration

[Tooltip("Sound effect of capture action.\n捕捉畫面時的音效。")]
public AudioSource captureSFX

Field Value

Type	Description
UnityEngine.AudioSource

isRealTime

Return true if the view finder is real time rendering.
當取景器實時取景時傳回 true。

Declaration

[Tooltip("Return true if the view finder is real time rendering.\n當取景器實時取景時傳回 true。")]
public bool isRealTime

Field Value

Type	Description
System.Boolean

isShowing

Return true if the reporter tool is showing.
當報告工具顯示時傳回 true。

Declaration

[Tooltip("Return true if the reporter tool is showing.\n當報告工具顯示時傳回 true。")]
public bool isShowing

Field Value

Type	Description
System.Boolean

outputDirectory

Directory for storing captured images.
儲存已拍攝的影像。

Declaration

[Header("[Settings]")]
[Tooltip("Directory for storing captured images.\n儲存已拍攝的影像。")]
public string outputDirectory

Field Value

Type	Description
System.String

realTime

Default open tool real time mode.
預設打開工具的實時模式。

Declaration

[Tooltip("Default open tool real time mode.\n預設打開工具的實時模式。")]
public bool realTime

Field Value

Type	Description
System.Boolean

recordPrefab

The prefab for captured record. If it is not null, a record object will be created by every capture action. The image will be render to the first child object.
捕捉的記錄預製件。當它不是空時，每捕捉一個影像將會生成一個記錄物件，並且顯示在第一個子物件中。

Declaration

[Tooltip("The prefab for captured record. If it is not null, a record object will be created by every capture action. The image will be render to the first child object.\n捕捉的記錄預製件。當它不是空時，每捕捉一個影像將會生成一個記錄物件，並且顯示在第一個子物件中。")]
public GameObject recordPrefab

Field Value

Type	Description
UnityEngine.GameObject

remarkPrefab

The prefab for panel of remark. If it is not null, a remark panel will be created by every captured record created.
備註面板預製件。 當它不是空時，每生成一個記錄物件將會生成一個備註面板。

Declaration

[Tooltip("The prefab for panel of remark. If it is not null, a remark panel will be created by every captured record created.\n備註面板預製件。當它不是空時，每生成一個記錄物件將會生成一個備註面板。")]
public GameObject remarkPrefab

Field Value

Type	Description
UnityEngine.GameObject

remarkSetting

Remark setting of reporter.
報告工具備註設定。

Declaration

[Tooltip("Remark setting of reporter.\n報告工具備註設定。")]
public ReporterRemark remarkSetting

Field Value

Type	Description
ReporterRemark

reportSFX

Sound effect of report action.
產生報告時的音效。

Declaration

[Tooltip("Sound effect of report action.\n產生報告時的音效。")]
public AudioSource reportSFX

Field Value

Type	Description
UnityEngine.AudioSource

reportTitle

Title of report.
報告標題。

Declaration

[Tooltip("Title of report.\n報告標題。")]
public string reportTitle

Field Value

Type	Description
System.String

savePanel

Save panel of reporter.
報告工具儲存面板。

Declaration

[Tooltip("Save panel of reporter.\n報告工具儲存面板。")]
public vGear_Panel savePanel

Field Value

Type	Description
vGear_Panel

textureSize

Size of texture on reporter planes.
報告工具平面的紋理大小。

Declaration

[Tooltip("Size of texture on reporter planes.\n報告工具平面的紋理大小。")]
public Vector2Int textureSize

Field Value

Type	Description
UnityEngine.Vector2Int

viewFinder

The view finder of camera.
相機的取景器。

Declaration

[Tooltip("The view finder of camera.\n相機的取景器。")]
public Renderer viewFinder

Field Value

Type	Description
UnityEngine.Renderer

zoom

Zoom value of reporter tool.
報告工具變焦值。

Declaration

[Header("[Status]")]
[Tooltip("Zoom value of reporter tool.\n報告工具變焦值。")]
public float zoom

Field Value

Type	Description
System.Single

zoomSpeed

Zooming speed of the camera.
變焦速度。

Declaration

[Tooltip("Zooming speed of the camera.\n變焦速度。")]
public float zoomSpeed

Field Value

Type	Description
System.Single

Properties

recorded

Number of current record.
目前已記錄的數目。

Declaration

public int recorded { get; }

Property Value

Type	Description
System.Int32

Methods

Capture()

Capture image.
拍攝影像。

Declaration

public void Capture()

Clear()

Clear all locus of this brush tool.
清除這個畫筆工具的所有筆跡。

Declaration

public void Clear()

GenerateReport()

Generate a PDF report of current session.
為這次場節產生一個報告。

Declaration

public void GenerateReport()

Mount(Transform, Boolean, Boolean)

Mount the reporter tool to target transform.
將報告工具依附在目標 Transform。

Mount(transform, true, false)

Declaration

public void Mount(Transform target, bool show = true, bool realTime = false)

Parameters

Type	Name	Description
UnityEngine.Transform	target	Target transform 目標 Transform
System.Boolean	show	Show if true 當 true 時顯示
System.Boolean	realTime	Turn on view finder if true 當 true 時打開取景器

Mount(Vector3, Vector3, Boolean, Boolean)

Mount the reporter tool to target posiiton and euler angles.
將報告工具依附在目標位置及角度。

Mount(Vector3.zero, Vector3.zero, true, false)

Declaration

public void Mount(Vector3 position, Vector3 eulerAngles, bool show = true, bool realTime = false)

Parameters

Type	Name	Description
UnityEngine.Vector3	position	Target position 目標位置
UnityEngine.Vector3	eulerAngles	Target euler angles 目標角度
System.Boolean	show	Show if true 當 true 時顯示
System.Boolean	realTime	Turn on view finder if true 當 true 時打開取景器

Remove(Int32)

Remove a record of this reporter tool.
移除這個報告工具的一個記錄。

Remove(0)

Declaration

public void Remove(int index)

Parameters

Type	Name	Description
System.Int32	index	Record index 記錄編號

Show(Boolean, Boolean)

Show or hide reporter tool.
顯示或隱藏報告工具。

Show(true, false)

Declaration

public void Show(bool show = true, bool realTime = false)

Parameters

Type	Name	Description
System.Boolean	show	Show if true 當 true 時顯示
System.Boolean	realTime	Turn on view finder if true 當 true 時打開取景器

ShowRemark(Int32)

Show the remark of a capture record.
顯示捕捉記錄的備註。

ShowRemark(0)

Declaration

public void ShowRemark(int index)

Parameters

Type	Name	Description
System.Int32	index	Record index 記錄編號

ViewFinder(Boolean)

Turn on or off the view finder.
開啟或關閉取景器。

ViewFinder(true)

Declaration

public void ViewFinder(bool turnOn = true)

Parameters

Type	Name	Description
System.Boolean	turnOn	Turn on if true 當 true 時打開