Wikitude Namespace Reference

Classes
class	CloudRecognitionService
	CloudRecognitionService is used to send image(s) taken by the camera to the Cloud Recognition Service. The server will then do the hard work of trying to match the image with your targets in the specified cloud archive. More...
class	CloudRecognitionServiceResponse
	The response received from the CloudRecognitionService after initiating a recognition request. More...
struct	Frame
	Structure containing the pointer to frame data, as well as additional information about the frame. More...
class	ImageTarget
	An image target contains information about a tracked target. More...
class	ImageTrackable
	Image Trackables are used by Image Trackers to specify which augmentations correspond to which targets. It also provides information about tracking status. More...
class	ImageTracker
	Image Trackers are used to recognize image targets bundled in .wtc files by using a TargetCollectionResource or from the cloud by using a CloudRecognitionService. More...
class	InstantTarget
	An instant target contains information about the tracked scene. More...
class	InstantTrackable
	Instant Trackables are used by Instant Trackers to specify which augmentations should be used during tracking. It also provides information about tracking status. More...
class	InstantTracker
	Instant Trackers provide markerless 3D tracking of a scene, allowing to place augmentations anywhere in the real world. An Instant Tracker can be in two states: Initializing, during which the tracking origin can be set; and Tracking, during which the scene is being tracker. More...
class	ObjectTarget
	An object target contains information about a tracked target. More...
class	ObjectTrackable
	Object Trackables are used by Object Trackers to specify which augmentations correspond to which targets. It also provides information about tracking status. More...
class	ObjectTracker
	Object Trackers are used to recognize and track objects defined in .wto files by using a TargetCollectionResource More...
class	PlatformBase
	Base class used for platform dependent compilation. For internal use only. More...
class	PluginManager
	The plugin manager allows you to get individual frames of the camera feed to do additional processing on it. More...
class	RecognizedTarget
	Base class for target classes. Intended for internal use only and should not be derived from. More...
class	SDKBuildInformation
	Encapsulates build information for the SDK. This information is only available when running on the device. More...
class	TargetCollectionResource
	Represents a resource that was initialized with a .wtc (Wikitude Target Collection) or .wto (Wikitude Object Collection) file. The file can be loaded either from the device, if it was stored in the StreamingAssets folder, or from a remote server. If the file was loaded from a server, no internet connection is required anymore after loading finished successfully. More...
class	TargetSource
	Base class for TargetCollectionResource and CloudRecognitionService. Intended for internal use only and should not be derived from. More...
class	Trackable
	Base class for trackable classes. Intended for internal use only and should not be derived from. More...
class	TrackableBehaviour
	Trackables are used by trackers to update 3D objects in Unity based on tracked targets. More...
class	TrackerBehaviour
	Base class for tracker classes. Intended for internal use only and should not be derived from. More...
class	TrackerManager
	Tracker manager handles messages from the native plugin. It is created and managed by the plugin and it should not be used directly. More...
class	WikitudeCamera
	The Wikitude camera handles the connection with the native plugins. More...

Enumerations

Enumeration Type Documentation

enum Wikitude.CaptureAutoFocusRestriction

strong

Enum indicating the restriction of the device's autofocus to a particular range of focus scan.

Currently only supported on iOS devices.

Enumerator
None	Indicates that the autofocus system should not restrict the focus range.
Near	Indicates that the autofocus system should restrict the focus range for subject matter that is near to the camera.
Far	Indicates that the autofocus system should restrict the focus range for subject matter that is far to the camera.

enum Wikitude.CaptureDeviceFramerate

strong

Enum indicating the desired framerate for the camera. The device camera might not support the selected framerate, so the closest supported framerate will be used.

Enumerator
Auto	Indicates that the SDK should pick the most appropriate framerate for the device.
Framerate_30	Indicates a desired framerate of 30 frames per second.
Framerate_60	Indicates a desired framerate of 60 frames per second.

enum Wikitude.CaptureDevicePosition

strong

Enum indicating the physical position of the capture device on the system.

Enumerator
Back	Indicates that the capture device is physically located on the back.
Front	Indicates that the capture device is physically located on the front.

enum Wikitude.CaptureDeviceResolution

strong

Enum indicating the desired resolution for the camera. The device camera might not support the selected resolution, so the closest supported resolution will be used.

Enumerator
Auto	Indicates that the SDK should pick the most appropriate resolution for the device.
SD	Indicates a desired resolution of 640 x 480.
HD	Indicates a desired resolution of 1280 x 720.
FullHD	Indicates a desired resolution of 1920 x 1080.

enum Wikitude.CaptureFlashMode

strong

Enum indicating the mode of the flash / torch on the device

Enumerator
Off	Indicates that the flash should always be off.
On	Indicates that the flash should always be on.

enum Wikitude.CaptureFocusMode

strong

Enum indicating the mode of the focus on the device.

Enumerator
Locked	Indicates that the focus should be locked at the lens' current position.
AutoFocus	Indicates that the device should autofocus once and then change the focus mode to Locked.
ContinuousAutoFocus	Indicates that the device should automatically focus when needed.

enum Wikitude.ExtendedTrackingQuality

strong

Enum indicating the quality of extended tracking.

Enumerator
Bad	Indicates that no extended tracking will work if the target moves outside the camera image.
Average	Indicates that extended tracking might work, but will not be very stable.
Good	Indicates that extended tracking will most likely work and it will be stable.

enum Wikitude.FrameColorSpace : int

strong

Color space of the frames used for Plugins and Input Plugins.

Enumerator
YUV_420_NV21	Represents a color space where image data is given in a YUV 420 format, arranged to be compliant to the NV21 standard.
YUV_420_YV12	Represents a color space where image data is given in a YUV 420 format, arranged to be compliant to the YV12 standard.
RGB	Represents a color space where image data is given in a RGB format. The data size is frame width * frame height * 3 (R, G and B channel). On iOS this is represented by the kCVPixelFormatType_24RGB constant On Android this is represented by the ImageFormat.FLEX_RGB_888 constant
RGBA	Represents a color space where image data is given in a RGBA format. The data size is frame width * frame height * 4 (R, G, B and A channel). This is only used for Input Plugins and is provided for convenience since this is the way Unity returns the pixels from a texture.

enum Wikitude.ImageRecognitionRangeExtension : int

strong

Defines if the ImageTracker should use an optimized algorithm to detect target images at greater distances. Extending the recognition range requires HD camera frames processing and therefore needs more CPU power than the default recognition range.

Enumerator
On	Image recognition range extension will be used regardless of the current device performance.
Off	Image recognition range extension will not be used even though the current device might support it.
Auto	Image recognition range extension will be used depending on the current device performance. 32 bit devices would turn this setting off while 64 bit devices would turn it on.

enum Wikitude.InstantTrackingPlaneOrientation

strong

Defines the orientation of the tracking plane during initialization.

Enumerator
Horizontal	The tracker starts with a horizontal tracking plane. This value corresponds to 0 degrees.
Vertical	The tracker starts with a vertical tracking plane. This value corresponds to 90 degrees.
Custom	The tracker will be initialized with a custom tracking plane angle, specified in degrees.

enum Wikitude.InstantTrackingState

strong

The state in which an Instant Tracker is currently in.

Enumerator
Initializing	The initializing state allows the user to set the tracking origin by pointing the device towards the desired area. In this state the user can also set the height / scale of the scene.
Tracking	During the tracking state, the scene is being tracker and any augmentations will appear to stay in place in the physical space.

enum Wikitude.TargetSourceType : int

strong

Specifies the kind of TargetSource. Used for custom inspectors.

Enumerator
TargetCollectionResource	Specifies a TargetCollectionResource TargetSource.
CloudRecognitionService	Specifies a CloudRecognitionService TargetSource.