com.wikitude.architect

Class StartupConfiguration

java.lang.Object

com.wikitude.architect.StartupConfiguration

public class StartupConfiguration
extends java.lang.Object

Configuration object class for the ARchitect SDK

This class encapsulates information needed for internal initialization of the Wikitude SDK.
Set which features are required by your AR experience (Geo / 2D Tracking or both) and which camera should be used. (front or back)
Note: The Origin Strings are used by our Phonegap/Xamarin/Titanium Plugins, you probably do not need to use them.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StartupConfiguration.CameraPosition Use the CameraPosition type to define which camera should be used.
static interface	StartupConfiguration.Features Helper class to define the required features bitmap.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ORIGIN_DEFAULT
static java.lang.String	ORIGIN_PHONEGAP
static java.lang.String	ORIGIN_TITANIUM
static java.lang.String	ORIGIN_XAMARIN

Constructor Summary

Constructors

Constructor and Description
StartupConfiguration(java.lang.String key) Constructor for the Architect configuration object Minimal configuration leave all configuration defaulted
StartupConfiguration(java.lang.String key, int features) Constructor for the Architect configuration object Define which features are required by your AR experience, leave other configurations defaulted.
StartupConfiguration(java.lang.String key, int features, StartupConfiguration.CameraPosition cameraMode) Constructor for the Architect configuration object Define which features are required by your AR experience, and which camera (front or back) should be used.

Method Summary

Modifier and Type	Method and Description
StartupConfiguration.CameraPosition	getCameraMode() Get the camera mode of the application
int	getFeatures() Get the required Features of the application
java.lang.String	getKey() Get the Api-key of the application
protected java.lang.String	getOrigin() Get the Origin of the application
void	setOrigin(java.lang.String origin) Use this only if you are implementing your OWN Wikitude Plugin for Cordova, Titanium etc.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ORIGIN_PHONEGAP

public static final java.lang.String ORIGIN_PHONEGAP

See Also:

Constant Field Values

ORIGIN_TITANIUM

public static final java.lang.String ORIGIN_TITANIUM

See Also:

Constant Field Values

ORIGIN_XAMARIN

public static final java.lang.String ORIGIN_XAMARIN

See Also:

Constant Field Values

ORIGIN_DEFAULT

public static final java.lang.String ORIGIN_DEFAULT

See Also:

Constant Field Values

Constructor Detail

StartupConfiguration

public StartupConfiguration(java.lang.String key)

Constructor for the Architect configuration object
Minimal configuration leave all configuration defaulted

Parameters:

key - API key for SDK

StartupConfiguration

public StartupConfiguration(java.lang.String key,
                            int features)

Constructor for the Architect configuration object
Define which features are required by your AR experience, leave other configurations defaulted.

Parameters:

key - API key for SDK

features - BitMap which defines if Geo, 2DTracking or both are required

StartupConfiguration

public StartupConfiguration(java.lang.String key,
                            int features,
                            StartupConfiguration.CameraPosition cameraMode)

Constructor for the Architect configuration object
Define which features are required by your AR experience, and which camera (front or back) should be used.

Parameters:

key - API key for SDK

features - BitMap which defines if Geo, 2DTracking or both are required

cameraMode - Defines if front or back camera should be used

Method Detail

getOrigin

protected java.lang.String getOrigin()

Get the Origin of the application

Returns:

origin as string

setOrigin

public void setOrigin(java.lang.String origin)

Use this only if you are implementing your OWN Wikitude Plugin for Cordova, Titanium etc.

Parameters:

one - of the predefined origin strings

getKey

public java.lang.String getKey()

Get the Api-key of the application

Returns:

key as string

getFeatures

public int getFeatures()

Get the required Features of the application

Returns:

feature bitmap

getCameraMode

public StartupConfiguration.CameraPosition getCameraMode()

Get the camera mode of the application

Returns:

camera position front or back