HERE Android SDK Developer's Guide

UpViewParams

The class UpViewParams is a member of com.here.android.mpa.ar.ARController.

Class Summary

public final class ARController.UpViewParams

extends java.lang.Object

Encapsulates parameters which affect the Up view.

[For complete information, see the section Class Details]

Method Summary

Table 1. Methods in UpViewParams
Methods

public float getCameraFrameMaxZoomScale ()

Gets current Max zoom scale as increase from the original

public float getPitchThreshold ()

Get pitch threshold when Down view transitions to Up view

public boolean isCameraFrameZoomEnabled ()

Check if camera frame zoom is enabled in UP view

public boolean isEdgeDetectionEnabled ()

Check if edge detection mode is enabled.

public boolean isPanEnabled ()

Check if pan is enabled in UP view

public boolean isPinchEnabled ()

Check if pinch is enabled in UP view

public boolean isPitchLocked ()

Check if pitch is locked in UP view

public boolean isShowGridEnabled ()

Check if showing the bottom plane grid is enabled in UP view

public UpViewParams setCameraFrameMaxZoomScale (float value)

Sets Max zoom scale as increase from the original to be used when pulled in UP view

public UpViewParams setCameraFrameZoomEnabled (boolean enable)

Enables or disables camera frame zoom, when pushed or pulled in LiveSight

public void setEdgeDetectionEnabled (boolean enabled)

Enable/disable mode where the camera frame gets processed for accurate placement of the LiveSight objects in the camera scene.

public UpViewParams setPanEnabled (boolean enable)

Enables or disables pan gesture in UP view

public UpViewParams setPinchEnabled (boolean enable)

Enables or disables pinch gesture in UP view

public UpViewParams setPitchLocked (boolean locked)

Enable/disable locked pitch in UP view

public UpViewParams setPitchThreshold (float value)

Set Pitch threshold when Down view transitions to Up View

public UpViewParams setShowGridEnabled (boolean enabled)

Enable/disable showing the bottom plane grid in UP view

Class Details

Encapsulates parameters which affect the Up view.

Method Details

public float getCameraFrameMaxZoomScale ()

Gets current Max zoom scale as increase from the original

Returns:

Max camera zoom scale

public float getPitchThreshold ()

Get pitch threshold when Down view transitions to Up view

Returns:

pitch value which triggers transition to Up view

public boolean isCameraFrameZoomEnabled ()

Check if camera frame zoom is enabled in UP view

Returns:

Camera zoom enable setting

public boolean isEdgeDetectionEnabled ()

Check if edge detection mode is enabled.

Returns:

true if edge detection is enabled.

See also:

setEdgeDetectionEnabled(boolean)

public boolean isPanEnabled ()

Check if pan is enabled in UP view

Returns:

Pan enable setting

public boolean isPinchEnabled ()

Check if pinch is enabled in UP view

Returns:

Pinch enable setting

public boolean isPitchLocked ()

Check if pitch is locked in UP view

Returns:

Pitch lock setting

public boolean isShowGridEnabled ()

Check if showing the bottom plane grid is enabled in UP view

Returns:

flag indicating if this feature is enabled

public UpViewParams setCameraFrameMaxZoomScale (float value)

Sets Max zoom scale as increase from the original to be used when pulled in UP view

Parameters:

  • value

    max frame zoom when pulled

Returns:

The updated UpViewParams object itself.

public UpViewParams setCameraFrameZoomEnabled (boolean enable)

Enables or disables camera frame zoom, when pushed or pulled in LiveSight

Parameters:

  • enable

    Enables if true or disables if false. This is disabled by default.

Returns:

The updated UpViewParams object itself.

public void setEdgeDetectionEnabled (boolean enabled)

Enable/disable mode where the camera frame gets processed for accurate placement of the LiveSight objects in the camera scene. Enabled by default. It is recommended to disable the edge detection in low light conditions.

Parameters:

  • enabled

    If true, edge detection mode is enabled.

public UpViewParams setPanEnabled (boolean enable)

Enables or disables pan gesture in UP view

Parameters:

  • enable

    Enables if true or disables if false. Default: enabled.

Returns:

The updated UpViewParams object itself.

public UpViewParams setPinchEnabled (boolean enable)

Enables or disables pinch gesture in UP view

Parameters:

  • enable

    Enables if true or disables if false. By default, pinch gesture is enabled.

Returns:

The updated UpViewParams object itself.

public UpViewParams setPitchLocked (boolean locked)

Enable/disable locked pitch in UP view

Parameters:

  • locked

    Lock value

Returns:

The updated UpViewParams object itself.

public UpViewParams setPitchThreshold (float value)

Set Pitch threshold when Down view transitions to Up View

Parameters:

  • value

    Pitch value ranges from 0...180

Returns:

The updated UpViewParams object itself.

public UpViewParams setShowGridEnabled (boolean enabled)

Enable/disable showing the bottom plane grid in UP view

Parameters:

  • enabled

    Flag indicating if this feature is enabled

Returns:

The updated UpViewParams object itself.