Skip navigation links
C D E F G I M N O P R S T U V W 

C

cameraFrameAvailable(Frame) - Method in class com.wikitude.common.plugins.Plugin
Will be called every time the Wikitude Enigine receives a new camera frame from the platform camera.
CameraManager - Interface in com.wikitude.camera
Interface to control the camera
CameraManagerListener - Interface in com.wikitude.camera
The CameraManagerListener defines callbacks that can be used to react on camera related events.
CameraSettings - Class in com.wikitude.common.camera
 
CameraSettings() - Constructor for class com.wikitude.common.camera.CameraSettings
 
CameraSettings.CameraFocusMode - Enum in com.wikitude.common.camera
Use the CameraPosition type to define which camera focus mode should be used.
ONCE means that the camera focuses once automatically and then stays at this
focus until the camera is stopped or a new focus mode is set. CONTINUOUS means that the camera will continuously try to find the best focus. OFF has different meanings based on which camera api is used:
Camera : The SDK will fix the focus, which is usually at hyperfocal distance Camera2 : The auto-focus routine does not control the lens, the focus distance can be controlled on devices which support manual focus.
CameraSettings.CameraPosition - Enum in com.wikitude.common.camera
Use the CameraPosition type to define which camera should be used.
CameraSettings.CameraResolution - Enum in com.wikitude.common.camera
Use the CameraResolution type to define which camera resolution should be used.
CameraSize - Class in com.wikitude.common.camera
class for describing width and height dimensions in pixels.
CameraSize(int, int) - Constructor for class com.wikitude.common.camera.CameraSize
Create a new CameraSize instance.
cancel() - Method in interface com.wikitude.tracker.TargetCollectionResource
Cancels loading of the file if it didn't already finish loading
checkPermissions(Activity, String[], int, PermissionManager.PermissionManagerCallback) - Method in interface com.wikitude.common.permission.PermissionManager
Checks it the requested permissions are granted and requests missing permissions.
clearCache() - Method in class com.wikitude.WikitudeSDK
Deletes all cached files of this instance of the ArchitectView.
ClientTracker - Interface in com.wikitude.tracker
Deprecated.
ClientTrackers have been deprecated since Native SDK 2.0.0. Please use ImageTracker and TargetCollectionResource instead.
ClientTrackerEventListener - Interface in com.wikitude.tracker
Deprecated.
ClientTrackers have been deprecated since Native SDK 2.0.0. Please use ImageTrackerListener instead.
CloudRecognitionService - Interface in com.wikitude.tracker
Interface to control CloudRecognitionServices CloudRecognitionServices allow ImageTrackers to interact with the cloud recognition service
CloudRecognitionServiceInitializationCallback - Interface in com.wikitude.tracker
Callback class for CloudRecognitionService initialization
CloudRecognitionServiceListener - Interface in com.wikitude.tracker
Callback class for CloudRecognitionService recognition
CloudRecognitionServiceResponse - Class in com.wikitude.tracker
Provides additional information for targets recognized using the CloudRecognitionService
CloudRecognitionServiceResponse(boolean, HashMap<String, String>, HashMap<String, String>) - Constructor for class com.wikitude.tracker.CloudRecognitionServiceResponse
 
CloudTracker - Interface in com.wikitude.tracker
Deprecated.
CloudTrackers have been deprecated since Native SDK 2.0.0. Please use ImageTracker and CloudRecognitionService instead.
CloudTrackerEventListener - Interface in com.wikitude.tracker
Deprecated.
CloudTrackers have been deprecated since Native SDK 2.0.0. Please use ImageTrackerListener and instead.
com.wikitude - package com.wikitude
 
com.wikitude.camera - package com.wikitude.camera
 
com.wikitude.common.camera - package com.wikitude.common.camera
 
com.wikitude.common.permission - package com.wikitude.common.permission
 
com.wikitude.common.plugins - package com.wikitude.common.plugins
 
com.wikitude.common.rendering - package com.wikitude.common.rendering
 
com.wikitude.common.startup - package com.wikitude.common.startup
 
com.wikitude.common.tracking - package com.wikitude.common.tracking
 
com.wikitude.common.util - package com.wikitude.common.util
 
com.wikitude.rendering - package com.wikitude.rendering
 
com.wikitude.tracker - package com.wikitude.tracker
 
ContinuousCloudRecognitionServiceInterruptionListener - Interface in com.wikitude.tracker
Callback class for CloudRecognitionService continuous recognition interruption
create2dClientTracker(String) - Method in interface com.wikitude.tracker.TrackerManager
create2dClientTracker(String, String[]) - Method in interface com.wikitude.tracker.TrackerManager
create2dCloudTracker(String, String) - Method in interface com.wikitude.tracker.TrackerManager
create2dCloudTracker(String, String, String[]) - Method in interface com.wikitude.tracker.TrackerManager
create3dClientTracker(String) - Method in interface com.wikitude.tracker.TrackerManager
createCloudRecognitionService(String, String, CloudRecognitionServiceInitializationCallback) - Method in interface com.wikitude.tracker.TrackerManager
Creates a new CloudRecognitionService with the passed authentication details
createImageTracker(TargetCollectionResource, ImageTrackerListener, ImageTrackerConfiguration) - Method in interface com.wikitude.tracker.TrackerManager
Creates a new ImageTracker with a TargetCollectionResource
createImageTracker(CloudRecognitionService, ImageTrackerListener, ImageTrackerConfiguration) - Method in interface com.wikitude.tracker.TrackerManager
Creates a new ImageTracker with a CloudRecognitionService
createInstantTracker(InstantTrackerListener, Object) - Method in interface com.wikitude.tracker.TrackerManager
Creates a new InstantTracker
createObjectTracker(TargetCollectionResource, ObjectTrackerListener, Object) - Method in interface com.wikitude.tracker.TrackerManager
Creates a new ObjectTracker with a TargetCollectionResource
createTargetCollectionResource(String, TargetCollectionResourceLoadingCallback) - Method in interface com.wikitude.tracker.TrackerManager
Creates a new target collection resource from the passed url

D

deactivateContinuousRecognitionHandling() - Method in interface com.wikitude.tracker.CloudTracker
Deprecated.
Deactivates the automatic continuous recognition handling, this means the CloudTracker won't stop to try recognizing new targets even if it already tracking.
deleteRootCacheDirectory(Context) - Static method in class com.wikitude.WikitudeSDK
Deletes the root cache directory of the SDK.
destroy() - Method in class com.wikitude.common.plugins.Plugin
Will be called when the Wikitude Engine shuts down.
destroyCloudRecognitionService(CloudRecognitionService) - Method in interface com.wikitude.tracker.TrackerManager
Destroys a CloudRecognitionService.
destroyImageTracker(ImageTracker) - Method in interface com.wikitude.tracker.TrackerManager
Destroys an ImageTracker
destroyInstantTracker(InstantTracker) - Method in interface com.wikitude.tracker.TrackerManager
Destroys an InstantTracker
destroyObjectTracker(ObjectTracker) - Method in interface com.wikitude.tracker.TrackerManager
Destroys an ObjectTracker
destroyTargetCollectionResource(TargetCollectionResource) - Method in interface com.wikitude.tracker.TrackerManager
Destroys a TargetCollectionResource.
destroyTracker(Tracker) - Method in interface com.wikitude.tracker.TrackerManager
disableCameraFlashLight() - Method in interface com.wikitude.camera.CameraManager
Call to turn off the device flash light

E

enableCameraFlashLight() - Method in interface com.wikitude.camera.CameraManager
Call to turn on the device flash light
endRender() - Method in class com.wikitude.common.plugins.Plugin
Will be called right after any Wikitude SDK internal rendering is done.
ExternalRendering - Interface in com.wikitude.rendering
External rendering marker interface

F

Frame - Class in com.wikitude.common.tracking
 
Frame(byte[], FrameSize) - Constructor for class com.wikitude.common.tracking.Frame
 
FrameSize - Class in com.wikitude.common.tracking
 
FrameSize(int, int) - Constructor for class com.wikitude.common.tracking.FrameSize
 

G

getAuthenticationToken() - Method in interface com.wikitude.tracker.CloudTracker
Deprecated.
Getter for the authentication token of this CloudTracker
getBuildConfiguration() - Method in interface com.wikitude.common.util.SDKBuildInformation
Returns in which configuration the sdk was built ( release / debug / ..
getBuildDate() - Method in interface com.wikitude.common.util.SDKBuildInformation
Returns the date of the sdk build.
getBuildNumber() - Method in interface com.wikitude.common.util.SDKBuildInformation
Returns the build number of the CI build.
getCameraFocusMode() - Method in class com.wikitude.common.startup.StartupConfiguration
Get which camera focus mode should be used by the Wikitude SDK for the camera startup.
getCameraManager() - Method in class com.wikitude.WikitudeSDK
 
getCameraManualFocusDistance() - Method in class com.wikitude.common.startup.StartupConfiguration
Get the initial camera manual focus distance in %.
0 = Shortest distance from frontmost surface of the lens that can be brought into sharp focus.
1 = Infinity Focus.
getCameraPosition() - Method in interface com.wikitude.camera.CameraManager
Call to get the current camera position
getCameraPosition() - Method in class com.wikitude.common.startup.StartupConfiguration
Get which camera position should be used by the Wikitude SDK for the camera startup.
getCameraResolution() - Method in class com.wikitude.common.startup.StartupConfiguration
Get the Size of the camera preview in pixel.
getClientToken() - Method in interface com.wikitude.tracker.CloudRecognitionService
 
getCollectionId() - Method in interface com.wikitude.tracker.CloudTracker
Deprecated.
Getter for the collection id of this CloudTracker
getCurrentZoomLevel() - Method in interface com.wikitude.camera.CameraManager
Call to get the currently set zoom level
getData() - Method in class com.wikitude.common.tracking.Frame
 
getDefaultOrigin() - Method in class com.wikitude.common.startup.StartupConfiguration
 
getDefaultOrigin() - Method in class com.wikitude.NativeStartupConfiguration
 
getDistanceToTarget() - Method in class com.wikitude.common.tracking.RecognizedTarget
Getter for the distance from the device to this target in the current camera frame.
getDistanceToTarget() - Method in interface com.wikitude.tracker.ImageTarget
 
getExtendedTargets() - Method in class com.wikitude.tracker.ImageTrackerConfiguration
 
getFocusMode() - Method in interface com.wikitude.camera.CameraManager
Call to get the currently set focus mode
getHeight() - Method in class com.wikitude.common.camera.CameraSize
Get the height of the size (in pixels).
getHeight() - Method in class com.wikitude.common.tracking.FrameSize
 
getHeight() - Method in class com.wikitude.common.tracking.Size
 
getIdentifier() - Method in class com.wikitude.common.plugins.Plugin
Returns the identifier of this particular plugin.
getKey() - Method in class com.wikitude.common.startup.StartupConfiguration
Deprecated.
getLicenseKey() - Method in class com.wikitude.common.startup.StartupConfiguration
Get the current Wikitude SDK licence key.
getListener() - Method in interface com.wikitude.camera.CameraManager
Returns the currently registered listener object.
getManualFocusDistance() - Method in interface com.wikitude.camera.CameraManager
Get the camera focus distance in %.
0 = Shortest distance from frontmost surface of the lens that can be brought into sharp focus.
1 = Infinity Focus.
getMaxZoomLevel() - Method in interface com.wikitude.camera.CameraManager
Call to check the maximum zoom level, should be called before setting the zoom level
getMetadata() - Method in class com.wikitude.tracker.CloudRecognitionServiceResponse
 
getModelViewProjectionMatrix() - Method in class com.wikitude.common.tracking.RecognizedTarget
Getter for the model view projection matrix
getModelViewProjectionMatrix() - Method in interface com.wikitude.tracker.Target
 
getName() - Method in class com.wikitude.common.tracking.RecognizedTarget
Getter for the name of the target
getName() - Method in interface com.wikitude.tracker.ImageTarget
 
getOrigin() - Method in class com.wikitude.common.startup.StartupConfiguration
Get the Origin of the application
getOrigin() - Method in class com.wikitude.common.tracking.Rectangle
 
getPermissionManager() - Static method in class com.wikitude.WikitudeSDK
Returns an static object of Type PermissionManager which can be used to handle Androids runtime permissions.
getPluginManager() - Method in class com.wikitude.WikitudeSDK
 
getProjectionMatrix() - Method in class com.wikitude.common.tracking.RecognizedTarget
Getter for the projection matrix
getProjectionMatrix() - Method in interface com.wikitude.tracker.Target
 
getRenderingAPI() - Method in class com.wikitude.NativeStartupConfiguration
Get which RenderingAPIs are used by the Wikitude SDK.
getSDKBuildInformation() - Static method in class com.wikitude.WikitudeSDK
Returns an object of Type SDKBuildInformation
which can be used to get information of the sdk build.

This information is helpful when reporting bugs in the sdk.
getSDKVersion() - Static method in class com.wikitude.WikitudeSDK
Returns the SDK version in the format Major.Minor.Bugfix.
getSize() - Method in class com.wikitude.common.tracking.Frame
 
getSize() - Method in class com.wikitude.common.tracking.Rectangle
 
getTargetCollectionId() - Method in interface com.wikitude.tracker.CloudRecognitionService
 
getTargetInformations() - Method in class com.wikitude.tracker.CloudRecognitionServiceResponse
 
getTargetPositionInCameraFrame() - Method in class com.wikitude.common.tracking.RecognizedTarget
Getter for a Rectangle object, defining the position of this target in the current camera frame.
getTargetPositionInCameraFrame() - Method in interface com.wikitude.tracker.ImageTarget
 
getTextureId() - Method in class com.wikitude.NativeStartupConfiguration
 
getTrackerManager() - Method in class com.wikitude.WikitudeSDK
 
getTrackingMapRecorder() - Method in class com.wikitude.WikitudeSDK
 
getTrackingType() - Method in interface com.wikitude.tracker.Tracker
Deprecated.
Get the tracking type of this tracker
getURL() - Method in interface com.wikitude.tracker.TargetCollectionResource
 
getValue() - Method in enum com.wikitude.tracker.InstantTrackingState
 
getVersion() - Method in class com.wikitude.WikitudeSDK
Deprecated.
getViewMatrix() - Method in class com.wikitude.common.tracking.RecognizedTarget
Getter for the model view matrix, of this target
getViewMatrix() - Method in interface com.wikitude.tracker.Target
 
getWidth() - Method in class com.wikitude.common.camera.CameraSize
Get the width of the size (in pixels).
getWidth() - Method in class com.wikitude.common.tracking.FrameSize
 
getWidth() - Method in class com.wikitude.common.tracking.Size
 
getX() - Method in class com.wikitude.common.tracking.Point
 
getY() - Method in class com.wikitude.common.tracking.Point
 

I

ImageTarget - Interface in com.wikitude.tracker
ImageTarget represents a target recognized by an Image Tracker
ImageTracker - Interface in com.wikitude.tracker
Interface to control Image Trackers
ImageTrackerConfiguration - Class in com.wikitude.tracker
Configuration class for Image Trackers
ImageTrackerConfiguration() - Constructor for class com.wikitude.tracker.ImageTrackerConfiguration
 
ImageTrackerListener - Interface in com.wikitude.tracker
Defines all necessary callbacks for ImageTrackers
InitializationPose - Interface in com.wikitude.tracker
Contains tracking information when an InstantTracker is running in Initialization mode
initialize() - Method in class com.wikitude.common.plugins.Plugin
Will be called once after your Plugin was successfully added to the Wikitude Engine.
InstantTarget - Interface in com.wikitude.tracker
ImageTarget represents a target recognized by an Image Tracker
InstantTracker - Interface in com.wikitude.tracker
Interface to control Instant Trackers
InstantTrackerListener - Interface in com.wikitude.tracker
Defines all necessary callbacks for InstantTrackers
InstantTrackingState - Enum in com.wikitude.tracker
Enum specifying in which state the InstantTracker should run.
InternalRendering - Interface in com.wikitude.common.rendering
Internal rendering marker interface
InternalRendering - Interface in com.wikitude.rendering
Deprecated.
use InternalRendering instead.
isCamera2Enabled() - Method in class com.wikitude.common.startup.StartupConfiguration
Get if the wikitude sdk may use the android camera2 api on devices with android version 5.1 or higher.
The default value is false.
isCameraFlashLightEnabled() - Method in interface com.wikitude.camera.CameraManager
Call check the state of the flash light
isEnabled() - Method in class com.wikitude.common.plugins.Plugin
Return the enabled state of this particular plugin.
isExtendedTrackingActive() - Method in interface com.wikitude.tracker.ImageTracker
 
isInitialized() - Method in interface com.wikitude.tracker.CloudRecognitionService
 
isLoading() - Method in interface com.wikitude.tracker.TargetCollectionResource
 
isManualFocusAvailable() - Method in interface com.wikitude.camera.CameraManager
Checks if the currently active camera is supporting setting the focus distance manually.
isRecognized() - Method in class com.wikitude.tracker.CloudRecognitionServiceResponse
 
isValidOrigin() - Method in class com.wikitude.common.startup.StartupConfiguration
 
isValidOrigin() - Method in class com.wikitude.NativeStartupConfiguration
 

M

mOrigin - Variable in class com.wikitude.common.startup.StartupConfiguration
 

N

NativeStartupConfiguration - Class in com.wikitude
Configuration object class for the Wikitude Native SDK.
NativeStartupConfiguration() - Constructor for class com.wikitude.NativeStartupConfiguration
 

O

onCameraOpen() - Method in interface com.wikitude.camera.CameraManagerListener
Will be called once the Wikitude Native SDK successfully opened it's internal camera.
onCameraOpenFailure() - Method in interface com.wikitude.camera.CameraManagerListener
Will be called if the internal Wikitude Native SDK camera was interrupted during it's initialization.
onCameraReleased() - Method in interface com.wikitude.camera.CameraManagerListener
Will be called once the Wikitude Native SDK released it's internal camera.
onCreate(Context, Context, NativeStartupConfiguration) - Method in class com.wikitude.WikitudeSDK
 
onDestroy() - Method in class com.wikitude.WikitudeSDK
 
onError(int, String) - Method in interface com.wikitude.tracker.CloudRecognitionServiceInitializationCallback
Called when an error was encountered during initialization of the CloudRecognitionService
onError(int, String) - Method in interface com.wikitude.tracker.CloudRecognitionServiceListener
Called when an error was encountered when trying to recognize a target with a CloudRecognitionService
onError(int, String) - Method in interface com.wikitude.tracker.TargetCollectionResourceLoadingCallback
Called when an error was encountered during loading of the resource
onErrorLoading(ClientTracker, String) - Method in interface com.wikitude.tracker.ClientTrackerEventListener
Deprecated.
Will be called if there was an error loading the ClientTracker
onErrorLoadingTargets(ImageTracker, int, String) - Method in interface com.wikitude.tracker.ImageTrackerListener
Will be called if there was an error when loading the targets
onExtendedTrackingQualityChanged(ImageTracker, String, int, int) - Method in interface com.wikitude.tracker.ImageTrackerListener
Called when the tracker is running in extended mode and the quality of the tracking changed
onExtendedTrackingQualityUpdate(Tracker, String, int, int) - Method in interface com.wikitude.tracker.TrackerEventListener
Deprecated.
Will be called regularly to indicate current extended tracking quality.
onFinish() - Method in interface com.wikitude.tracker.TargetCollectionResourceLoadingCallback
Called when the resource was loaded successfully
onImageLost(ImageTracker, String) - Method in interface com.wikitude.tracker.ImageTrackerListener
Will be called when an image target is lost by the target
onImageRecognized(ImageTracker, String) - Method in interface com.wikitude.tracker.ImageTrackerListener
Will be called when an image target is first recognized by the tracker
onImageTracked(ImageTracker, ImageTarget) - Method in interface com.wikitude.tracker.ImageTrackerListener
Called repeatedly when the image target is tracked by the tracker
onInitializationPoseChanged(InstantTracker, InitializationPose) - Method in interface com.wikitude.tracker.InstantTrackerListener
Called repeatedly during the initialization phase with information about the tracking plane
onInitialized() - Method in interface com.wikitude.tracker.CloudRecognitionServiceInitializationCallback
Called when the CloudRecognitionService was initialized successfully
onInterruption(int) - Method in interface com.wikitude.tracker.ContinuousCloudRecognitionServiceInterruptionListener
onPause() - Method in interface com.wikitude.common.rendering.RenderExtension
 
onPause() - Method in class com.wikitude.common.rendering.RenderSurfaceView
 
onPause() - Method in class com.wikitude.WikitudeSDK
 
onRecognitionFailed(CloudTracker, int, String) - Method in interface com.wikitude.tracker.CloudTrackerEventListener
Deprecated.
Will be called if the CloudTracker couldn't recognize the target in the last recognition attempt
onRecognitionInterruption(CloudTracker, double) - Method in interface com.wikitude.tracker.CloudTrackerEventListener
Deprecated.
Will be called if the set recognition interval was set too high for the current network speed
onRecognitionSuccessful(CloudTracker, boolean, JSONObject) - Method in interface com.wikitude.tracker.CloudTrackerEventListener
Deprecated.
Will be called once when the CloudTracker recognizes a new target
onRegisterError(int, String) - Method in interface com.wikitude.common.plugins.PluginManager.PluginErrorCallback
Will be called if there was an error when registering the plugin
onRenderExtensionCreated(RenderExtension) - Method in interface com.wikitude.rendering.ExternalRendering
Will be called by the WikitudeSDK when the Wikitude RenderExtension has been created.
onRenderingApiInstanceCreated(RenderSettings.RenderingAPI) - Method in interface com.wikitude.common.rendering.InternalRendering
Will be called once a rendering api instance is created.
onRequestPermissionsResult(int, String[], int[]) - Method in interface com.wikitude.common.permission.PermissionManager
This needs to be called in the Activity.onRequestPermissionsResult(int, java.lang.String[], int[]) to pass the result to the Wikitude SDK.
onResponse(CloudRecognitionServiceResponse) - Method in interface com.wikitude.tracker.CloudRecognitionServiceListener
Called when a response from the server is received
onResume() - Method in interface com.wikitude.common.rendering.RenderExtension
 
onResume() - Method in class com.wikitude.common.rendering.RenderSurfaceView
 
onResume() - Method in class com.wikitude.WikitudeSDK
 
onStateChanged(InstantTracker, InstantTrackingState) - Method in interface com.wikitude.tracker.InstantTrackerListener
Will be called when the state of the tracker was changed internally.
onTargetLost(Tracker, String) - Method in interface com.wikitude.tracker.TrackerEventListener
Deprecated.
Will be called on the first frame the tracker can't recognize a tracked target anymore
onTargetRecognized(Tracker, String) - Method in interface com.wikitude.tracker.TrackerEventListener
Deprecated.
Will be called once when the tracker recognizes a new target
onTargetsLoaded(ImageTracker) - Method in interface com.wikitude.tracker.ImageTrackerListener
Will be called when the tracker successfully loaded the targets
onTracked(InstantTracker, InstantTarget) - Method in interface com.wikitude.tracker.InstantTrackerListener
Called repeatedly during the tracking phase.
onTrackerFinishedLoading(ClientTracker, String) - Method in interface com.wikitude.tracker.ClientTrackerEventListener
Deprecated.
Will be called when the ClientTracker successfully loaded
onTrackerFinishedLoading(CloudTracker) - Method in interface com.wikitude.tracker.CloudTrackerEventListener
Deprecated.
Will be called when the CloudTracker was loaded successfully
onTrackerLoadingError(CloudTracker, String) - Method in interface com.wikitude.tracker.CloudTrackerEventListener
Deprecated.
Will be called when the CloudTracker couldn't be loaded
onTracking(Tracker, RecognizedTarget) - Method in interface com.wikitude.tracker.TrackerEventListener
Deprecated.
Will be called for every frame in which the tracker can recognize the target
onTrackingStarted(InstantTracker) - Method in interface com.wikitude.tracker.InstantTrackerListener
Will be called when tracking is started.
onTrackingStopped(InstantTracker) - Method in interface com.wikitude.tracker.InstantTrackerListener
Will be called when tracking of the scene is lost
ORIGIN_DEFAULT - Static variable in class com.wikitude.NativeStartupConfiguration
 
ORIGIN_UNITY - Static variable in class com.wikitude.NativeStartupConfiguration
 

P

pause() - Method in class com.wikitude.common.plugins.Plugin
Will be called every time the Wikitude Engine pauses.
PermissionManager - Interface in com.wikitude.common.permission
Interface to the Wikitude permission manager.
This can be used to check for runtime permissions.
PermissionManager.PermissionManagerCallback - Interface in com.wikitude.common.permission
permissionsDenied(String[]) - Method in interface com.wikitude.common.permission.PermissionManager.PermissionManagerCallback
One or more requested permissions were denied.
permissionsGranted(int) - Method in interface com.wikitude.common.permission.PermissionManager.PermissionManagerCallback
Requested permissions were granted.
Plugin - Class in com.wikitude.common.plugins
 
Plugin(String) - Constructor for class com.wikitude.common.plugins.Plugin
Constructor, pass a unique identifier for each of your plugins.
PLUGIN_ERROR_IDENTIFIER_INVALID - Static variable in interface com.wikitude.common.plugins.PluginManager.PluginErrorCallback
 
PLUGIN_ERROR_LOADING_LIBRARY - Static variable in interface com.wikitude.common.plugins.PluginManager.PluginErrorCallback
 
PLUGIN_ERROR_PLUGIN_WITH_SAME_IDENTIFIER_ALREADY_REGISTERED - Static variable in interface com.wikitude.common.plugins.PluginManager.PluginErrorCallback
 
PLUGIN_ERROR_RENDERING_API_MISMATCH - Static variable in interface com.wikitude.common.plugins.PluginManager.PluginErrorCallback
 
PLUGIN_ERROR_WRONG_LIFECYCLE_STATE - Static variable in interface com.wikitude.common.plugins.PluginManager.PluginErrorCallback
 
PluginManager - Interface in com.wikitude.common.plugins
 
PluginManager.PluginErrorCallback - Interface in com.wikitude.common.plugins
Defines all necessary callbacks for plugin errors
Point - Class in com.wikitude.common.tracking
 
Point() - Constructor for class com.wikitude.common.tracking.Point
 
positiveRationaleResult(int, String[]) - Method in interface com.wikitude.common.permission.PermissionManager
This needs to be called if the user decides to grant the permissions after they were denied before.
provideRenderExtension() - Method in interface com.wikitude.common.rendering.InternalRendering
Will be called once by the WikitudeSDK when setting up the OpenGL surface view

R

recognize(CloudRecognitionServiceListener) - Method in interface com.wikitude.tracker.CloudRecognitionService
Starts a single recognition attempt
recognize() - Method in interface com.wikitude.tracker.CloudTracker
Deprecated.
Starts a single recognition attempt
RecognizedTarget - Class in com.wikitude.common.tracking
 
RecognizedTarget() - Constructor for class com.wikitude.common.tracking.RecognizedTarget
 
Rectangle - Class in com.wikitude.common.tracking
 
Rectangle() - Constructor for class com.wikitude.common.tracking.Rectangle
 
registerNativePlugins(String, PluginManager.PluginErrorCallback) - Method in interface com.wikitude.common.plugins.PluginManager
Use this method to register (a) C++ plugin(s).
registerNativePlugins(String) - Method in interface com.wikitude.common.plugins.PluginManager
registerNativePlugins(String, String, PluginManager.PluginErrorCallback) - Method in interface com.wikitude.common.plugins.PluginManager
Use this method to register a C++ plugin.
registerNativePlugins(String, String) - Method in interface com.wikitude.common.plugins.PluginManager
registerPlugin(Plugin, PluginManager.PluginErrorCallback) - Method in interface com.wikitude.common.plugins.PluginManager
Use this method to register a Java plugin with the Wikitude SDK.
registerPlugin(Plugin) - Method in interface com.wikitude.common.plugins.PluginManager
registerTrackerEventListener(ListenerType) - Method in interface com.wikitude.tracker.Tracker
Deprecated.
Register a tracker event listener implementing Cloud-/ClientTrackerEventListener
RenderExtension - Interface in com.wikitude.common.rendering
 
RenderSettings - Class in com.wikitude.common.rendering
 
RenderSettings() - Constructor for class com.wikitude.common.rendering.RenderSettings
 
RenderSettings.RenderingAPI - Enum in com.wikitude.common.rendering
Use the RenderingAPI type to define which rendering API should be used.
OPENGL_ES_2 Internal Rendering: The SDK will create an OpenGL ES 2 context and will use OpenGL ES 2 internally. External Rendering: The SDK will expect an OpenGL ES 2 context and will use OpenGL ES 2 internally. OPENGL_ES_3 Internal Rendering: The SDK will create an OpenGL ES 3 context and will use OpenGL ES 3 internally. External Rendering: The SDK will expect an OpenGL ES 3 context and will use OpenGL ES 3 internally.
RenderSurfaceView - Class in com.wikitude.common.rendering
 
RenderSurfaceView(Context, GLRenderer) - Constructor for class com.wikitude.common.rendering.RenderSurfaceView
 
RenderSurfaceView(Context, GLRenderer, InternalRendering, List<RenderSettings.RenderingAPI>) - Constructor for class com.wikitude.common.rendering.RenderSurfaceView
 
resolveCameraResolution(Context, CameraSettings.CameraResolution, CameraSettings.CameraPosition, boolean) - Static method in class com.wikitude.WikitudeSDK
 
resume(long) - Method in class com.wikitude.common.plugins.Plugin
Will be called when the Wikitude Engine starts for the first time and after every pause.

S

SDKBuildInformation - Interface in com.wikitude.common.util
Interface to get information about the sdk build.
setCamera2Enabled(boolean) - Method in class com.wikitude.common.startup.StartupConfiguration
Sets if the wikitude sdk may use the android camera2 api on devices with android version 5.1 or higher.
The default value is false.
setCameraFocusMode(CameraSettings.CameraFocusMode) - Method in class com.wikitude.common.startup.StartupConfiguration
Get which camera focus mode should be used by the Wikitude SDK for the camera startup.
setCameraManualFocusDistance(float) - Method in class com.wikitude.common.startup.StartupConfiguration
Set the initial camera manual focus distance in %.
0 = Shortest distance from frontmost surface of the lens that can be brought into sharp focus.
1 = Infinity Focus.
If setting the focus distance is not supported by the camera this value will be internally set to 1.
setCameraPosition(CameraSettings.CameraPosition) - Method in interface com.wikitude.camera.CameraManager
Call to change which camera should be used (front, back)
setCameraPosition(CameraSettings.CameraPosition) - Method in class com.wikitude.common.startup.StartupConfiguration
Set which camera position should be used by the Wikitude SDK for the camera startup.
setCameraResolution(CameraSettings.CameraResolution) - Method in class com.wikitude.common.startup.StartupConfiguration
Sets which resolution the camera should use.
The wikitude sdk will choose a resolution closest to the given size.
It is not guaranteed that the chosen size is used since some android devices may not support it.
This is CameraSettings.CameraResolution#SD_640x480 by default.
setCloudRecognitionServerRegion(TrackerManager.ServerRegion) - Method in interface com.wikitude.tracker.TrackerManager
Set which server CloudTrackers created with the TrackingManger should use.
setData(byte[]) - Method in class com.wikitude.common.tracking.Frame
 
setDeviceHeightAboveGround(float) - Method in interface com.wikitude.tracker.InstantTracker
Sets the current height at which the device is being held above the ground or other desired tracking surface (e.g.
setDistanceToTarget(int) - Method in class com.wikitude.common.tracking.RecognizedTarget
 
setEnabled(boolean) - Method in class com.wikitude.common.plugins.Plugin
Set's this plugin enabled or not.
setExtendedTargets(String[]) - Method in interface com.wikitude.tracker.ImageTracker
Sets the targets for which the extended tracking should be enabled.
setExtendedTargets(String[]) - Method in class com.wikitude.tracker.ImageTrackerConfiguration
 
setFocusMode(CameraSettings.CameraFocusMode) - Method in interface com.wikitude.camera.CameraManager
Call to change the focus mode of the camera (once, continuous)
setHeight(int) - Method in class com.wikitude.common.tracking.FrameSize
 
setHeight(int) - Method in class com.wikitude.common.tracking.Size
 
setLicenseKey(String) - Method in class com.wikitude.common.startup.StartupConfiguration
Set your Wikitude SDK licence key.
setListener(CameraManagerListener) - Method in interface com.wikitude.camera.CameraManager
Call to set a listener object.
setManualFocusDistance(float) - Method in interface com.wikitude.camera.CameraManager
Set the camera focus distance.
0 = Shortest distance from frontmost surface of the lens that can be brought into sharp focus.
1 = Infinity Focus.
If setting the focus distance is not supported by the camera this value will be internally set to 0.
setModelViewProjectionMatrix(float[]) - Method in class com.wikitude.common.tracking.RecognizedTarget
 
setName(String) - Method in class com.wikitude.common.tracking.RecognizedTarget
 
setOrigin(String) - Method in class com.wikitude.common.startup.StartupConfiguration
Use this only if you are implementing your OWN Wikitude Plugin for Cordova, Titanium etc.
setOrigin(Point) - Method in class com.wikitude.common.tracking.Rectangle
 
setProjectionMatrix(float[]) - Method in class com.wikitude.common.tracking.RecognizedTarget
 
setRenderingAPI(RenderSettings.RenderingAPI...) - Method in class com.wikitude.NativeStartupConfiguration
Sets the RenderingAPIs the Wikitude SDK should use.
setSize(FrameSize) - Method in class com.wikitude.common.tracking.Frame
 
setSize(Size) - Method in class com.wikitude.common.tracking.Rectangle
 
setState(InstantTrackingState) - Method in interface com.wikitude.tracker.InstantTracker
Changes the state in which the tracker should run in
setTargetPositionInCameraFrame(Rectangle) - Method in class com.wikitude.common.tracking.RecognizedTarget
 
setTextureId(int) - Method in interface com.wikitude.camera.CameraManager
For internal use only.
setTextureId(int) - Method in class com.wikitude.NativeStartupConfiguration
 
setupWikitudeGLSurfaceView() - Method in class com.wikitude.WikitudeSDK
 
setViewMatrix(float[]) - Method in class com.wikitude.common.tracking.RecognizedTarget
 
setWidth(int) - Method in class com.wikitude.common.tracking.FrameSize
 
setWidth(int) - Method in class com.wikitude.common.tracking.Size
 
setX(int) - Method in class com.wikitude.common.tracking.Point
 
setY(int) - Method in class com.wikitude.common.tracking.Point
 
setZoomLevel(float) - Method in interface com.wikitude.camera.CameraManager
Call to set the zoom in or zoom out, call getMaxZoomLevel first to get the maximum possible value
showPermissionRationale(int, String[]) - Method in interface com.wikitude.common.permission.PermissionManager.PermissionManagerCallback
User denied the permission request before, explain why the app needs the permissions.
If the user wants to grant the permissions call PermissionManager.positiveRationaleResult(int, java.lang.String[]).
Size - Class in com.wikitude.common.tracking
 
Size() - Constructor for class com.wikitude.common.tracking.Size
 
startContinuousRecognition(double, ContinuousCloudRecognitionServiceInterruptionListener, CloudRecognitionServiceListener) - Method in interface com.wikitude.tracker.CloudRecognitionService
Starts the continuous recognition mode
startContinuousRecognition(double) - Method in interface com.wikitude.tracker.CloudTracker
Deprecated.
Starts the continuous recognition mode
startRender() - Method in class com.wikitude.common.plugins.Plugin
Will be called before any Wikitude SDK internal rendering is done.
StartupConfiguration - Class in com.wikitude.common.startup
 
StartupConfiguration() - Constructor for class com.wikitude.common.startup.StartupConfiguration
 
stopContinuousRecognition() - Method in interface com.wikitude.tracker.CloudRecognitionService
Stops the continuous recognition mode
stopContinuousRecognition() - Method in interface com.wikitude.tracker.CloudTracker
Deprecated.
Stops the continuous recognition mode
stopExtendedTracking() - Method in interface com.wikitude.tracker.ImageTracker
Immediately stops the extended tracking mode.
stopExtendedTracking() - Method in interface com.wikitude.tracker.Tracker
Deprecated.
Stop the extended tracking mode for all defined extended targets

T

TAG - Static variable in class com.wikitude.common.rendering.RenderSurfaceView
 
Target - Interface in com.wikitude.tracker
Target is the base class for any target that can be recognized by the SDK.
TargetCollectionResource - Interface in com.wikitude.tracker
Interface to control TargetCollectionResources TargetCollectionResources load image or object target collections either from local storage or from a remote server TargetCollectionResources can be used with ImageTrackers and ObjectTrackers
TargetCollectionResourceLoadingCallback - Interface in com.wikitude.tracker
Callback class for TargetCollectionResource loading
toJSONString() - Method in interface com.wikitude.common.util.SDKBuildInformation
Returns the sdk build information in a JSON format string.
Tracker<ListenerType extends TrackerEventListener> - Interface in com.wikitude.tracker
Deprecated.
Use either ImageTracker or InstantTracker
Generic base class of Client- and CloudTracker
Tracker.TrackingType - Enum in com.wikitude.tracker
Deprecated. 
TrackerEventListener - Interface in com.wikitude.tracker
Deprecated.
ClientTrackers and CloudTrackers have been deprecated since Native SDK 2.0.0.
TrackerManager - Interface in com.wikitude.tracker
Interface to control the TrackerManager
TrackerManager.ServerRegion - Enum in com.wikitude.tracker
 
Tracking - Class in com.wikitude.tracker
Deprecated. 
Tracking() - Constructor for class com.wikitude.tracker.Tracking
Deprecated.
 
Tracking.Type - Enum in com.wikitude.tracker
Deprecated.
Defines the type of tracker

U

update(RecognizedTarget[]) - Method in class com.wikitude.common.plugins.Plugin
Will be called after every image recognition cycle.
useSeparatedRenderAndLogicUpdates() - Method in interface com.wikitude.common.rendering.RenderExtension
Until Wikitude SDK version 2.1 onDrawFrame triggered also a logic update inside the SDK core.

V

valueOf(String) - Static method in enum com.wikitude.common.camera.CameraSettings.CameraFocusMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.wikitude.common.camera.CameraSettings.CameraPosition
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.wikitude.common.camera.CameraSettings.CameraResolution
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.wikitude.common.rendering.RenderSettings.RenderingAPI
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.wikitude.tracker.InstantTrackingState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.wikitude.tracker.Tracker.TrackingType
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.wikitude.tracker.TrackerManager.ServerRegion
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.wikitude.tracker.Tracking.Type
Deprecated.
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.wikitude.common.camera.CameraSettings.CameraFocusMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.wikitude.common.camera.CameraSettings.CameraPosition
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.wikitude.common.camera.CameraSettings.CameraResolution
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.wikitude.common.rendering.RenderSettings.RenderingAPI
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.wikitude.tracker.InstantTrackingState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.wikitude.tracker.Tracker.TrackingType
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.wikitude.tracker.TrackerManager.ServerRegion
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.wikitude.tracker.Tracking.Type
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.

W

WIKITUDE_PERMISSION_REQUEST - Static variable in interface com.wikitude.common.permission.PermissionManager
 
WikitudeSDK - Class in com.wikitude
 
WikitudeSDK(InternalRendering) - Constructor for class com.wikitude.WikitudeSDK
 
WikitudeSDK(ExternalRendering) - Constructor for class com.wikitude.WikitudeSDK
 
C D E F G I M N O P R S T U V W 
Skip navigation links