iOS-specific Platform Controller

Classes
struct	VuPlatformARKitInfo
	ARKit-specific info for the platform-based Vuforia Fusion Provider. More...

Functions
VuResult	vuPlatformControllerGetARKitInfo (const VuController *controller, VuPlatformARKitInfo *arkitInfo)
	Get information about the ARKit Fusion Provider Platform. More...
VuResult	vuPlatformControllerSetARKitConfig (VuController *controller, const void *config)
	Set ARKit platform fusion provider configuration. More...

Detailed Description

iOS platform-specific platform functionality accessed via the PlatformController

Function Documentation

vuPlatformControllerGetARKitInfo()

VuResult vuPlatformControllerGetARKitInfo	(	const VuController *	controller,
		VuPlatformARKitInfo *	arkitInfo
	)

Get information about the ARKit Fusion Provider Platform.

The information contained in the returned struct can be used to allow applications to interact with the underlying ARKit session to gain access to functionality not currently available through the Vuforia API. For example additional lighting information or plane boundaries.

Note

Call this function after Vuforia Engine has been started and the Vuforia State contains a camera frame.

Parameters

controller	Plaform controller retrieved from Engine (see vuEngineGetPlatformController)
arkitInfo	ARKit-specific info for the platform-based Vuforia Fusion Provider

Returns

VU_FAILED if Vuforia is not running, is not using the ARKit Fusion Provider Platform, or if the ARKit pointers are not ready to be retrieved yet, VU_SUCCESS otherwise

vuPlatformControllerSetARKitConfig()

VuResult vuPlatformControllerSetARKitConfig	(	VuController *	controller,
		const void *	config
	)

Set ARKit platform fusion provider configuration.

This function is used to configure the ARKit session that will be used. An instance of the class ARWorldTrackingConfiguration should be created and its parameters should be set as desired. The pointer to said instance should be passed into this function. Vuforia Engine then inspects the configuration values and takes a copy of the ones that are appropriate to use with Vuforia Engine

Note

Call this function before vuPlatformControllerGetARKitInfo is called for the first time.

Important to notice that the setting has no effect until vuPlatformControllerGetARKitInfo is called.

Currently Vuforia Engine only uses the AREnvironmentTexturing option of the ARWorldTrackingConfiguration instance supplied to this call. All other configuration options are managed by Vuforia Engine.

The current configuration can be found by acquiring the ARSession by using vuPlatformControllerGetARKitInfo and querying the configuration from it.

Parameters

controller	Platform controller retrieved from Engine (see vuEngineGetPlatformController)
config	Configuration pointer of type ARWorldTrackingConfiguration