HERE Android SDK Developer's Guide

SelectedItemParams

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

Class Summary

public final class ARController.SelectedItemParams

extends java.lang.Object

Encapsulates parameters which affect ARObjects which are in the selected or non selected states.

[For complete information, see the section Class Details]

Method Summary

Table 1. Methods in SelectedItemParams
Methods

public long getBoundingBoxAnimationDelay ()

Get delay of selected item bounding box animation.

public long getBoundingBoxAnimationTime ()

Get delay of selected item bounding box animation.

public AnimationInterpolator getBoundingBoxInterpolator ()

Get the interpolator for selected object bounding box animation.

public float getMaxViewAngle ()

Get selected item max view angle when the item is on the right or left from line of sight.

public float getNonSelectedItemsOpacity ()

Get others icons opacity while one icon is in selected state.

public float getOpacity ()

Get selected item's opacity when icon in camera view is selected.

public Size getSize ()

Get selected item size.

public long getSizeAnimationDelay ()

Get delay of selected item size animation.

public long getSizeAnimationTime ()

Get delay of selected item size animation.

public AnimationInterpolator getSizeInterpolator ()

Get the interpolator for selected object size animation.

public SelectedItemParams setBoundingBox (RectF box)

Set bounding box for a selected item.

public SelectedItemParams setBoundingBoxAnimationDelay (long value)

Set selected item bounding box animation delay.

public SelectedItemParams setBoundingBoxAnimationTime (long value)

Set selected item bounding box animation time.

public SelectedItemParams setBoundingBoxInterpolator (AnimationInterpolator value)

Set the interpolator for selected object bounding box animation.

public SelectedItemParams setMaxViewAngle (float angleDeg)

Set selected item max view angle when the item is on the right or left from line of sight.

public SelectedItemParams setNonSelectedItemsOpacity (float value)

Set others icons opacity while one icon is in selected state.

public SelectedItemParams setOpacity (float value)

Set selected item's opacity when icon in camera view is selected.

public SelectedItemParams setSize (int width, int height)

Set selected item size.

public SelectedItemParams setSizeAnimationDelay (long value)

Set selected item size animation delay.

public SelectedItemParams setSizeAnimationTime (long value)

Set selected item size animation time.

public SelectedItemParams setSizeInterpolator (AnimationInterpolator value)

Set the interpolator for selected object size animation.

Class Details

Encapsulates parameters which affect ARObjects which are in the selected or non selected states.

An ARObject is selected by way of the select(ARObject) method. When an ARObject is selected, all other ARObject s are considered non selected. When no ARObject is selected, ARObject s are neither selected nor non selected.

Method Details

public long getBoundingBoxAnimationDelay ()

Get delay of selected item bounding box animation.

Returns:

delay in ms

public long getBoundingBoxAnimationTime ()

Get delay of selected item bounding box animation.

Returns:

delay in ms

public AnimationInterpolator getBoundingBoxInterpolator ()

Get the interpolator for selected object bounding box animation.

Returns:

AnimationInterpolator.

public float getMaxViewAngle ()

Get selected item max view angle when the item is on the right or left from line of sight.

Returns:

The view angle at the selected item. The range is: -angleDeg +angleDeg.

public float getNonSelectedItemsOpacity ()

Get others icons opacity while one icon is in selected state.

Returns:

non-selected icon opacity.

public float getOpacity ()

Get selected item's opacity when icon in camera view is selected.

Returns:

selected icon opacity.

public Size getSize ()

Get selected item size. This size is used when ARObject is in selected state.

Returns:

icon size when selected.

See also:

select(ARObject)

unselect()

public long getSizeAnimationDelay ()

Get delay of selected item size animation.

Returns:

delay in ms

public long getSizeAnimationTime ()

Get delay of selected item size animation.

Returns:

delay in ms

public AnimationInterpolator getSizeInterpolator ()

Get the interpolator for selected object size animation.

Returns:

AnimationInterpolator.

public SelectedItemParams setBoundingBox (RectF box)

Set bounding box for a selected item. All values(left, top, right and bottom) are the ratios of the view's height and width. Value of 0 for left an top and 1 for right and bottom indicate that there are no boundaries are actually used. Values > 0 and < 1 are used to set absolute boundaries considerring selected icon half size, so that icon is shown on the screen fully.

Parameters:

  • box

    android.graphics.RectF selected item's bounding box. If null, bounding box for the selected item is not used.

Returns:

The updated SelectedItemParams object itself.

public SelectedItemParams setBoundingBoxAnimationDelay (long value)

Set selected item bounding box animation delay.

Parameters:

  • value

    Delay in ms

Returns:

The updated SelectedItemParams object itself.

public SelectedItemParams setBoundingBoxAnimationTime (long value)

Set selected item bounding box animation time.

Parameters:

  • value

    Delay in ms

Returns:

The updated SelectedItemParams object itself.

public SelectedItemParams setBoundingBoxInterpolator (AnimationInterpolator value)

Set the interpolator for selected object bounding box animation.

Parameters:

Returns:

The updated SelectedItemParams object itself.

public SelectedItemParams setMaxViewAngle (float angleDeg)

Set selected item max view angle when the item is on the right or left from line of sight.

Parameters:

  • angleDeg

    The view angle at the selected item. The range is: -angleDeg +angleDeg.

Returns:

The updated SelectedItemParams object itself.

public SelectedItemParams setNonSelectedItemsOpacity (float value)

Set others icons opacity while one icon is in selected state.

Parameters:

  • value

    non-selected icons opacity.

Returns:

The updated SelectedItemParams object itself.

public SelectedItemParams setOpacity (float value)

Set selected item's opacity when icon in camera view is selected.

Parameters:

  • value

    selected icon opacity.

Returns:

The updated SelectedItemParams object itself.

public SelectedItemParams setSize (int width, int height)

Set selected item size. This size is used when ARObject is in selected state.

Parameters:

  • width

    Maximum width of selected icon in pixels

  • height

    Maximum height of selected icon in pixels

Returns:

The updated SelectedItemParams object itself.

See also:

select(ARObject)

unselect()

public SelectedItemParams setSizeAnimationDelay (long value)

Set selected item size animation delay.

Parameters:

  • value

    Delay in ms

Returns:

The updated SelectedItemParams object itself.

public SelectedItemParams setSizeAnimationTime (long value)

Set selected item size animation time.

Parameters:

  • value

    Delay in ms

Returns:

The updated SelectedItemParams object itself.

public SelectedItemParams setSizeInterpolator (AnimationInterpolator value)

Set the interpolator for selected object size animation.

Parameters:

Returns:

The updated SelectedItemParams object itself.