Wikitude Unity Expert Edition
Properties | List of all members
Wikitude.LivePreview Class Reference

The LivePreview components allows the Wikitude SDK to connect to various sources of image data inside the Unity Editor and enables all tracking features to be tested in Play Mode. More...

Inherits MonoBehaviour.

Properties

LivePreviewMode LivePreviewMode [get, set]
 Gets or sets which Live Preview mode should be used. More...
 
Texture2D StaticImage [get, set]
 Gets or sets which Image should be used in the Live Preview mode. The selected image should have the Read / Write settings enabled. More...
 
String WebCamName [get, set]
 Gets or sets which WebCam should be used in the Live Preview mode. More...
 
bool WebCamIsMirrored [get, set]
 Gets or sets if the WebCam should be mirrored. More...
 
CaptureDevicePosition RemoteCameraPosition [get, set]
 Gets or sets which camera position to use in the Live Preview mode when using the Unity Remote app. More...
 
float CameraToHorizonAngle [get, set]
 Gets or sets the angle between the forward vector of the camera and the horizontal plane. A value of 0 indicates that the camera is pointed directly forward, while a value of 90 means that the camera is pointed directly down to the ground. When using static images or webcams, there is no sensor data to indicate how the ground plane is oriented in the image, but this is crucial for Instant Tracking to work correctly. More...
 
VideoClip VideoClip [get, set]
 Gets or sets which video should be used in the Live Preview mode. More...
 
bool VideoLoop [get, set]
 Gets or sets if the video should be looped for the corresponding Live Preview mode. More...
 
float VideoSpeed [get, set]
 Gets or sets the speed of the video for the corresponding Live Preview mode. More...
 
bool ForceResendData [get, set]
 When set to true, it will force resending the same image data, even if it didn't change. The value will revert to false when after the data was resent. More...
 

Detailed Description

The LivePreview components allows the Wikitude SDK to connect to various sources of image data inside the Unity Editor and enables all tracking features to be tested in Play Mode.

Property Documentation

float Wikitude.LivePreview.CameraToHorizonAngle
getset

Gets or sets the angle between the forward vector of the camera and the horizontal plane. A value of 0 indicates that the camera is pointed directly forward, while a value of 90 means that the camera is pointed directly down to the ground. When using static images or webcams, there is no sensor data to indicate how the ground plane is oriented in the image, but this is crucial for Instant Tracking to work correctly.

bool Wikitude.LivePreview.ForceResendData
getset

When set to true, it will force resending the same image data, even if it didn't change. The value will revert to false when after the data was resent.

LivePreviewMode Wikitude.LivePreview.LivePreviewMode
getset

Gets or sets which Live Preview mode should be used.

CaptureDevicePosition Wikitude.LivePreview.RemoteCameraPosition
getset

Gets or sets which camera position to use in the Live Preview mode when using the Unity Remote app.

Texture2D Wikitude.LivePreview.StaticImage
getset

Gets or sets which Image should be used in the Live Preview mode. The selected image should have the Read / Write settings enabled.

VideoClip Wikitude.LivePreview.VideoClip
getset

Gets or sets which video should be used in the Live Preview mode.

bool Wikitude.LivePreview.VideoLoop
getset

Gets or sets if the video should be looped for the corresponding Live Preview mode.

float Wikitude.LivePreview.VideoSpeed
getset

Gets or sets the speed of the video for the corresponding Live Preview mode.

bool Wikitude.LivePreview.WebCamIsMirrored
getset

Gets or sets if the WebCam should be mirrored.

String Wikitude.LivePreview.WebCamName
getset

Gets or sets which WebCam should be used in the Live Preview mode.