Wikitude SDK API Reference

API Docs for: 8.2.0
Show:

CONST Class

Module: AR

A static class containing constant values. The Singleton instance of CONST will automatically be created on startup.

Properties

ANIMATION_GROUP_TYPE

Object

The property holds various animation group types as string properties.

The following Animation Group types are defined:

ConstantString Representation
PARALLELparallel
SEQUENTIALsequential

One can access it by writing e.g. AR.CONST.ANIMATION_GROUP_TYPE.PARALLEL

CAMERA_FOCUS_MODE

Object

Possible autofocus modes for the camera.

The following autofocus modes are defined:

  • ONCE - The camera performs one more autofocus operation and stays at that autofocus setting. Subsequent calls with this setting will refocus the camera every time.
  • CONTINUOUS - The camera constantly adjust the autofocus
  • OFF - The camera disables autofocus

CAMERA_POSITION

Object

Possible positions of the camera on the device

The following camera positions are defined:

  • FRONT - Front facing camera
  • BACK - Back facing camera

CLICK_BEHAVIOR

Object

The different click behaviors available

The following click behaviors are defined:

  • CLICK
  • TOUCH_UP
  • TOUCH_DOWN

See AR.context.clickBehavior for details.

CLOUD_RECOGNITION_SERVER_REGION

Object deprecated

Deprecated: Use CLOUD_RECOGNITION_SERVER_URL instead

Possible server regions to choose

The following server regions are defined:

  • AMERICAS - Indicates that the SDK connects with the cloud recognition server in the Americas region.
  • EUROPE - Indicates that the SDK connects with the cloud recognition server in Europe.

CLOUD_RECOGNITION_SERVER_URL

String

Possible region depending server urls

The following server urls are defined:

  • AMERICAS - Indicates that the SDK connects with the cloud recognition server in the Americas region.
  • EUROPE - Indicates that the SDK connects with the cloud recognition server in Europe.

EASING_CURVE_TYPE

Object

The property holds various easing curve types as string properties.

The following Easing Curve types are defined:

ConstantString Representation
LINEARlinear
EASE_IN_QUADeaseInQuad
EASE_OUT_QUADeaseOutQuad
EASE_IN_OUT_QUADeaseInOutQuad
EASE_OUT_IN_QUADeaseOutInQuad
EASE_IN_CUBICeaseInCubic
EASE_OUT_CUBICeaseOutCubic
EASE_IN_OUT_CUBICeaseInOutCubic
EASE_OUT_IN_CUBICeaseOutInCubic
EASE_IN_QUATeaseInQuat
EASE_OUT_QUATeaseOutQuat
EASE_IN_OUT_QUATeaseInOutQuat
EASE_OUT_IN_QUATeaseOutInQuat
EASE_IN_QUINTeaseInQuint
EASE_OUT_QUINTeaseOutQuint
EASE_IN_OUT_QUINTeaseInOutQuint
EASE_OUT_IN_QUINTeaseOutInQuint
EASE_IN_ELASTICeaseInElastic
EASE_OUT_ELASTICeaseOutElastic
EASE_IN_OUT_ELASTICeaseInOutElastic
EASE_OUT_IN_ELASTICeaseOutInElastic
EASE_IN_BACKeaseInBack
EASE_OUT_BACKeaseOutBack
EASE_IN_OUT_BACKeaseInOutBack
EASE_OUT_IN_BACKeaseOutInBack
EASE_IN_SINEeaseInSine
EASE_OUT_SINEeaseOutSine
EASE_IN_OUT_SINEeaseInOutSine
EASE_OUT_IN_SINEeaseOutInSine
EASE_IN_EXPOeaseInExpo
EASE_OUT_EXPOeaseOutExpo
EASE_IN_OUT_EXPOeaseInOutExpo
EASE_OUT_IN_EXPOeaseOutInExpo
EASE_IN_CIRCeaseInCirc
EASE_OUT_CIRCeaseOutCirc
EASE_IN_OUT_CIRCeaseInOutCirc
EASE_OUT_IN_CIRCeaseOutInCirc
EASE_IN_BOUNCEeaseInBounce
EASE_OUT_BOUNCEeaseOutBounce
EASE_IN_OUT_BOUNCEeaseInOutBounce
EASE_OUT_IN_BOUNCEeaseOutInBounce
EASE_IN_CURVEeaseInCurve
EASE_OUT_CURVEeaseOutCurve

A detailed description on the various easing curve types are described here.

One can access it by writing e.g. AR.CONST.EASING_CURVE_TYPE.LINEAR

FONT_STYLE

Object

The property holds various font styles as string properties.

The following font styles are defined:

  • NORMAL
  • BOLD
  • ITALIC

One can access it by writing e.g. AR.CONST.FONT_STYLE.NORMAL

HORIZONTAL_ANCHOR

Object

The property holds various horizontal anchors as int properties.

The following horizontal anchors are defined:

  • LEFT
  • CENTER
  • RIGHT

One can access it by writing e.g. AR.CONST.HORIZONTAL_ANCHOR.LEFT

IMAGE_RECOGNITION_RANGE_EXTENSION

Object

Defines if the ImageTracker should use an optimized algorithm to detect target images in a greater distance to the camera.

Extending the recognition range requires HD camera frame processing and therefore needs more CPU power than the default recognition range.

The following options are defined:

  • ON
  • OFF
  • AUTO

INITIAL_INSTANT_TRACKING_PLANE_ORIENTATION

: object

Constants for the orientation of the InstantTracking plane.

The following InstantTracking plane orientations are defined:

  • HORIZONTAL - Indicates that the InstantTracking plane is horizontal (floor-aligned).
  • VERTICAL - Indicates that the InstantTracking plane is vertical (wall-aligned).

INSTANT_TARGET_EXPANSION_POLICY

Object

Defines if a loaded instant target may be expanded.

The following options are defined:

  • ALLOW_EXPANSION
  • DISALLOW_EXPANSION

LOCATION_ACCURACY

Object

The level of accuracy of a location reported back from the system. The property holds various accuracy levels as int properties.

The following accuracy levels are defined:

  • HIGH - the reported location is very accurate with a potential inaccuracy of up to 10 meters
  • MEDIUM - the reported location is fairly accurate with a potential inaccuracy between 10 and 35 meters
  • LOW - the reported location is inaccurate with a potential inaccuracy of more than 35 meters

One can access it by writing e.g. AR.CONST.LOCATION_ACCURACY.LOW

STATE

Object

The property holds various states as int properties.

The following states are defined:

  • INITIALIZED - The object is initialized, but no data is loaded.
  • LOADING - The data is currently being loaded.
  • LOADED - The data is loaded.
  • PLAYING - The file is currently being played.
  • ERROR - The file cannot be loaded or played. This can have various reasons, including the data not being fetchable, the file being corrupt etc.

One can access it by writing e.g. AR.CONST.STATE.INITIALIZED

TRACKER_EFFICIENCY_MODE

Object

Defines the efficiency mode in which a tracker is running.

The following options are defined:

  • HIGH_ACCURACY - The best result is calculated in the shortest amount of time for every frame which results in higher CPU usage
  • ENERGY_EFFICIENCY - Less energy is needed because the calculations are not as accurate as with the HighAccuracy setting and not every frame is considered

UNKNOWN_ALTITUDE

Number

The value indicating that the altitude is unknown or cannot be fetched.

It is set to -32768 meters. This altitude-level is impossible on the earth's surface.

In case a GeoLocation has set its altitude to UNKNOWN_ALTITUDE, the true altitude will be assumed to be on the same altitude level as the user.

VERTICAL_ANCHOR

Object

The property holds various vertical anchors as int properties.

The following vertical anchors are defined:

  • TOP
  • MIDDLE
  • BOTTOM

One can access it by writing e.g. AR.CONST.VERTICAL_ANCHOR.TOP