com.mapbox.vision.ar.view.gl

Class VisionArView

com.mapbox.vision.ar.view.gl.VisionArView

public class VisionArView

class VisionArView is a view which represents visual component that renders video stream from the camera and AR navigation route on top of that.

See Also:

class VisionArView

Field Summary

Fields

Modifier and Type	Field and Description
static com.mapbox.vision.ar.view.gl.VisionArView.Companion	Companion Deprecated.

Constructor Summary

Constructors

Constructor and Description
VisionArView(android.content.Context context)
VisionArView(android.content.Context context, android.util.AttributeSet attrs)

Method Summary

Modifier and Type	Method and Description
boolean	isFenceVisible() Check if AR fences rendering is enabled
boolean	isLaneVisible() Check if AR lane rendering is enabled
void	onPause() Call this method when class VisionArView should no longer render on the screen.
void	setArManager(VisionArManager visionArManager) Set class VisionArManager to enable rendering of AR on the view. class VisionArManager is held as a weak reference
void	setArQuality(float quality) Change overall quality of AR objects. Quality should be in 0.0,1.0 range. 1.0 stands for the best quality, 0.0 stands for the worst quality. Any other value will get clamped to 0.0,1.0 range. Tweaking AR quality may improve performance.
void	setFenceVisible(boolean visible) Enable rendering AR fences. AR fences rendering is disabled by default.
void	setFenceVisualParams(FenceVisualParams fenceVisualParams) Change visual parameters of AR fence.
void	setLaneVisible(boolean visible) Enable rendering AR lane. AR lane rendering is enabled by default.
void	setLaneVisualParams(LaneVisualParams laneVisualParams) Change visual parameters of AR lane.

Field Detail

Companion

public static com.mapbox.vision.ar.view.gl.VisionArView.Companion Companion

Deprecated.

Constructor Detail

VisionArView

public VisionArView(android.content.Context context)

VisionArView

public VisionArView(android.content.Context context,
                    android.util.AttributeSet attrs)

Method Detail

setArManager

public void setArManager(VisionArManager visionArManager)

Set class VisionArManager to enable rendering of AR on the view. class VisionArManager is held as a weak reference

Parameters:

visionArManager - : instance of class VisionArManager

See Also:

class VisionArManager, class VisionArManager

setLaneVisualParams

public void setLaneVisualParams(LaneVisualParams laneVisualParams)

Change visual parameters of AR lane.

Parameters:

laneVisualParams - : configuration that describes visual state of AR lane.

setFenceVisualParams

public void setFenceVisualParams(FenceVisualParams fenceVisualParams)

Change visual parameters of AR fence.

Parameters:

fenceVisualParams - : configuration that describes visual state of AR fence.

setArQuality

public void setArQuality(float quality)

Change overall quality of AR objects. Quality should be in 0.0,1.0 range. 1.0 stands for the best quality, 0.0 stands for the worst quality. Any other value will get clamped to 0.0,1.0 range. Tweaking AR quality may improve performance.

Parameters:

quality - : quality of AR object such as lane and fence.

See Also:

0.0,1.0, 0.0,1.0

setFenceVisible

public void setFenceVisible(boolean visible)

Enable rendering AR fences. AR fences rendering is disabled by default.

isFenceVisible

public boolean isFenceVisible()

Check if AR fences rendering is enabled

Returns:

True if AR fences rendering is enabled and False otherwise

setLaneVisible

public void setLaneVisible(boolean visible)

Enable rendering AR lane. AR lane rendering is enabled by default.

isLaneVisible

public boolean isLaneVisible()

Check if AR lane rendering is enabled

Returns:

True if AR lane rendering is enabled and False otherwise

onPause

public void onPause()

Call this method when class VisionArView should no longer render on the screen.

See Also:

class VisionArView