Wikitude.WikitudeSDK Class Reference

The WikitudeSDK object handles the connection with the native plugins. More...

Inherits MonoBehaviour, and Wikitude.IWikitudeSDK.

Public Member Functions
void	ExplicitUpdate ()
	If the UpdateMode is set to UpdateMode.Explicit, this method should be called to trigger an SDK update. More...

Public Attributes
const int	RecommendedNumberOfConcurrentTargets = 5
	The recommended maximum number of concurrent targets. Specifying a larger value could lead to performance issues. More...
OnSDKInitializedEvent	OnSDKInitialized = new OnSDKInitializedEvent()
	Called after the SDK finished initialization. More...

Properties
static SDKBuildInformation	BuildInformation [get]
	Gets SDK build and version information. More...
string	WikitudeLicenseKey [get, set]
	Gets or sets the Wikitude license key. More...
Camera	ARCamera [get, set]
	The camera that will be used to render the augmentations. In case ARBridge is enabled, this camera is positioned according to the movement of the physical camera in the world. More...
Transform	AROrigin [get, set]
	Optional parameter that modifies the origin of the coordinate system, if required. More...
ArBridgeProvider	ArBridge [get, set]
	Specifies if ARBridge is enabled. More...
bool	LoggingEnabled [get, set]
	Specifies if logging is enabled. More...
LoggingLevel	LoggingLevel [get, set]
	Specifies the logging level. More...
bool	PluginArBridgeDrivesCameraPose [get, set]
	Specifies if the SDK should also position the ARCamera in case a plugin implementation of ARBridge is used. If set to false, it is assumed that the plugin will handle this. More...
ArBridgeAvailability	ArBridgeAvailability [get, set]
	Checks ARBridge is available on the current device. Only applicable if the Internal ArBridgeProvider is used. More...
bool	PrintErrorsToConsole = ArBridgeAvailability.CheckingQueryOngoing [get, set]
	Automatically print all errors encountered by the SDK to the console. More...
UpdateMode	UpdateMode = true [get, set]
	Sets the preferred mode to update the SDK. More...

Detailed Description

The WikitudeSDK object handles the connection with the native plugins.

When the Start function is called on it, the native plugin is initialized. When the WikitudeSDK it is destroyed, the plugin is also destroyed.

Member Function Documentation

void Wikitude.WikitudeSDK.ExplicitUpdate ( )

inline

If the UpdateMode is set to UpdateMode.Explicit, this method should be called to trigger an SDK update.

Member Data Documentation

OnSDKInitializedEvent Wikitude.WikitudeSDK.OnSDKInitialized = new OnSDKInitializedEvent()

Called after the SDK finished initialization.

const int Wikitude.WikitudeSDK.RecommendedNumberOfConcurrentTargets = 5

The recommended maximum number of concurrent targets. Specifying a larger value could lead to performance issues.

Property Documentation

ArBridgeProvider Wikitude.WikitudeSDK.ArBridge

getset

Specifies if ARBridge is enabled.

ArBridgeAvailability Wikitude.WikitudeSDK.ArBridgeAvailability

getset

Checks ARBridge is available on the current device. Only applicable if the Internal ArBridgeProvider is used.

Camera Wikitude.WikitudeSDK.ARCamera

getset

The camera that will be used to render the augmentations. In case ARBridge is enabled, this camera is positioned according to the movement of the physical camera in the world.

Transform Wikitude.WikitudeSDK.AROrigin

getset

Optional parameter that modifies the origin of the coordinate system, if required.

SDKBuildInformation Wikitude.WikitudeSDK.BuildInformation

staticget

Gets SDK build and version information.

bool Wikitude.WikitudeSDK.LoggingEnabled

getset

Specifies if logging is enabled.

LoggingLevel Wikitude.WikitudeSDK.LoggingLevel

getset

Specifies the logging level.

bool Wikitude.WikitudeSDK.PluginArBridgeDrivesCameraPose

getset

Specifies if the SDK should also position the ARCamera in case a plugin implementation of ARBridge is used. If set to false, it is assumed that the plugin will handle this.

bool Wikitude.WikitudeSDK.PrintErrorsToConsole = ArBridgeAvailability.CheckingQueryOngoing

getset

Automatically print all errors encountered by the SDK to the console.

UpdateMode Wikitude.WikitudeSDK.UpdateMode = true

getset

Sets the preferred mode to update the SDK.

string Wikitude.WikitudeSDK.WikitudeLicenseKey

getset

Gets or sets the Wikitude license key.

The wikitude license key.