com.wikitude.tracker

Class InstantTrackerConfiguration

java.lang.Object

com.wikitude.tracker.InstantTrackerConfiguration

public final class InstantTrackerConfiguration
extends Object

Configuration class for Instant Trackers

Field Summary

Fields

Modifier and Type	Field and Description
static float	TRACKING_PLANE_ORIENTATION_HORIZONTAL Constant for an horizontal instant tracking initialisation plane orientation.
static float	TRACKING_PLANE_ORIENTATION_VERTICAL Constant for a vertical instant tracking initialisation plane orientation.

Constructor Summary

Constructors

Constructor and Description
InstantTrackerConfiguration()

Method Summary

Modifier and Type	Method and Description
void	enablePlaneDetection(PlaneDetectionConfiguration planeDetectionConfiguration) Use this to specify whether the tracker should detect planes or not.
float	getDeviceHeightAboveGround() Returns the estimated height at which the device is currently above the ground.
PlaneDetectionConfiguration	getPlaneDetectionConfiguration() Returns the plane detection configuration of the tracker.
TrackerEfficiencyMode	getTrackerEfficiencyMode() Returns the efficiency mode of the tracker.
float	getTrackingPlaneOrientation() Returns the initial orientation at which the instant tracking plane should be displayed.
boolean	isPlaneDetectionEnabled() Returns if plane detection is enabled.
boolean	isSMARTEnabled() Returns if the Wikitude SDk should use SMART instead of only the Wikitude InstantTracking algorithms if the device supports SMART.
void	setDeviceHeightAboveGround(float height) Sets the estimated height at which the device is currently above the ground.
void	setSMARTEnabled(boolean enabled) Defines if the Wikitude SDk should use SMART instead of only the Wikitude InstantTracking algorithms if the device supports .
void	setTrackerEfficiencyMode(TrackerEfficiencyMode trackerEfficiencyMode) Use this to specify the efficiency mode of the tracker.
void	setTrackingPlaneOrientation(float orientation) Sets the initial orientation at which the instant tracking plane should be displayed.

Methods inherited from class java.lang.Object

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

Field Detail

TRACKING_PLANE_ORIENTATION_HORIZONTAL

public static final float TRACKING_PLANE_ORIENTATION_HORIZONTAL

Constant for an horizontal instant tracking initialisation plane orientation.

See Also:

Constant Field Values

TRACKING_PLANE_ORIENTATION_VERTICAL

public static final float TRACKING_PLANE_ORIENTATION_VERTICAL

Constant for a vertical instant tracking initialisation plane orientation.

See Also:

Constant Field Values

Constructor Detail

InstantTrackerConfiguration

public InstantTrackerConfiguration()

Method Detail

getDeviceHeightAboveGround

public float getDeviceHeightAboveGround()

Returns the estimated height at which the device is currently above the ground.

Returns:

the estimated height in meters.

setDeviceHeightAboveGround

public void setDeviceHeightAboveGround(float height)

Sets the estimated height at which the device is currently above the ground. Setting this to an appropriate value will allow the augmentations to have a scale close to the one they would have in reality. The default value is 1.4 (meters).

Parameters:

height - estimated height in meters

getTrackingPlaneOrientation

public float getTrackingPlaneOrientation()

Returns the initial orientation at which the instant tracking plane should be displayed.

Returns:

orientation angle in degree

setTrackingPlaneOrientation

public void setTrackingPlaneOrientation(float orientation)

Sets the initial orientation at which the instant tracking plane should be displayed. This can be used to align the instant tracking plane with real world structures (e.g. 0° for a floor, 90° for a vertical wall) The default value is 0° (floor aligned). Using this after the Tracker was created has no effect. This setting is not used when running InstantTracking with SMART.

Parameters:

orientation - angle in degree

setSMARTEnabled

public void setSMARTEnabled(boolean enabled)

Defines if the Wikitude SDk should use SMART instead of only the Wikitude InstantTracking algorithms if the device supports . This is enabled by default.

Parameters:

enabled - If SMART should be used.

isSMARTEnabled

public boolean isSMARTEnabled()

Returns if the Wikitude SDk should use SMART instead of only the Wikitude InstantTracking algorithms if the device supports SMART.

Returns:

If SMART should be used.

getTrackerEfficiencyMode

public TrackerEfficiencyMode getTrackerEfficiencyMode()

Returns the efficiency mode of the tracker. Please refer to the TrackerEfficiencyMode documentation for more details.

setTrackerEfficiencyMode

public void setTrackerEfficiencyMode(TrackerEfficiencyMode trackerEfficiencyMode)

Use this to specify the efficiency mode of the tracker. Please refer to the TrackerEfficiencyMode documentation for more details.

Parameters:

trackerEfficiencyMode - the tracker efficiency mode that should be used

getPlaneDetectionConfiguration

public PlaneDetectionConfiguration getPlaneDetectionConfiguration()

Returns the plane detection configuration of the tracker. Please refer to the PlaneDetectionConfiguration documentation for more details.

isPlaneDetectionEnabled

public boolean isPlaneDetectionEnabled()

Returns if plane detection is enabled.

enablePlaneDetection

public void enablePlaneDetection(PlaneDetectionConfiguration planeDetectionConfiguration)

Use this to specify whether the tracker should detect planes or not. Please refer to the PlaneDetectionConfiguration documentation for more details regarding how to customize plane detection.

Parameters:

planeDetectionConfiguration - The configuration for Plane detection.