ARController.SelectedItemParams (HERE Android Premium SDK)

java.lang.Object
- com.here.android.mpa.ar.ARController.SelectedItemParams

Enclosing class:

ARController
```
public final class ARController.SelectedItemParams
extends java.lang.Object
```
Encapsulates parameters which affect ARObjects which are in the selected or non selected states.
An ARObject is selected by way of the ARController.select(ARObject) method. When an ARObject is selected, all other ARObjects are considered non selected. When no ARObject is selected, ARObjects are neither selected nor non selected.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getBoundingBoxAnimationDelay()` Get delay of selected item bounding box animation.
`long`	`getBoundingBoxAnimationTime()` Get delay of selected item bounding box animation.
`AnimationInterpolator`	`getBoundingBoxInterpolator()` Get the interpolator for selected object bounding box animation.
`float`	`getMaxViewAngle()` Get selected item max view angle when the item is on the right or left from line of sight.
`float`	`getNonSelectedItemsOpacity()` Get others icons opacity while one icon is in selected state.
`float`	`getOpacity()` Get selected item's opacity when icon in camera view is selected.
`Size`	`getSize()` Get selected item size.
`long`	`getSizeAnimationDelay()` Get delay of selected item size animation.
`long`	`getSizeAnimationTime()` Get delay of selected item size animation.
`AnimationInterpolator`	`getSizeInterpolator()` Get the interpolator for selected object size animation.
`ARController.SelectedItemParams`	`setBoundingBox(android.graphics.RectF box)` Set bounding box for a selected item.
`ARController.SelectedItemParams`	`setBoundingBoxAnimationDelay(long value)` Set selected item bounding box animation delay.
`ARController.SelectedItemParams`	`setBoundingBoxAnimationTime(long value)` Set selected item bounding box animation time.
`ARController.SelectedItemParams`	`setBoundingBoxInterpolator(AnimationInterpolator value)` Set the interpolator for selected object bounding box animation.
`ARController.SelectedItemParams`	`setMaxViewAngle(float angleDeg)` Set selected item max view angle when the item is on the right or left from line of sight.
`ARController.SelectedItemParams`	`setNonSelectedItemsOpacity(float value)` Set others icons opacity while one icon is in selected state.
`ARController.SelectedItemParams`	`setOpacity(float value)` Set selected item's opacity when icon in camera view is selected.
`ARController.SelectedItemParams`	`setSize(int width, int height)` Set selected item size.
`ARController.SelectedItemParams`	`setSizeAnimationDelay(long value)` Set selected item size animation delay.
`ARController.SelectedItemParams`	`setSizeAnimationTime(long value)` Set selected item size animation time.
`ARController.SelectedItemParams`	`setSizeInterpolator(AnimationInterpolator value)` Set the interpolator for selected object size animation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setSize
```
public ARController.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:
    
    ARController.select(ARObject), ARController.unselect()
  - getSize
```
public Size getSize()
```
    Get selected item size. This size is used when ARObject is in selected state.
    
    Returns:
    
    icon size when selected.
    
    See Also:
    
    ARController.select(ARObject), ARController.unselect()
  - setBoundingBox
```
public ARController.SelectedItemParams setBoundingBox(android.graphics.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.
  - setOpacity
```
public ARController.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.
  - getOpacity
```
public float getOpacity()
```
    Get selected item's opacity when icon in camera view is selected.
    
    Returns:
    
    selected icon opacity.
  - setNonSelectedItemsOpacity
```
public ARController.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.
  - getNonSelectedItemsOpacity
```
public float getNonSelectedItemsOpacity()
```
    Get others icons opacity while one icon is in selected state.
    
    Returns:
    
    non-selected icon opacity.
  - setSizeInterpolator
```
public ARController.SelectedItemParams setSizeInterpolator(AnimationInterpolator value)
```
    Set the interpolator for selected object size animation.
    
    Parameters:
    
    value - The AnimationInterpolator for selected object size animation.
    
    Returns:
    
    The updated SelectedItemParams object itself.
  - getSizeInterpolator
```
public AnimationInterpolator getSizeInterpolator()
```
    Get the interpolator for selected object size animation.
    
    Returns:
    
    AnimationInterpolator.
  - setBoundingBoxInterpolator
```
public ARController.SelectedItemParams setBoundingBoxInterpolator(AnimationInterpolator value)
```
    Set the interpolator for selected object bounding box animation.
    
    Parameters:
    
    value - The AnimationInterpolator for selected object bounding box animation.
    
    Returns:
    
    The updated SelectedItemParams object itself.
  - getBoundingBoxInterpolator
```
public AnimationInterpolator getBoundingBoxInterpolator()
```
    Get the interpolator for selected object bounding box animation.
    
    Returns:
    
    AnimationInterpolator.
  - setSizeAnimationDelay
```
public ARController.SelectedItemParams setSizeAnimationDelay(long value)
```
    Set selected item size animation delay.
    
    Parameters:
    
    value - Delay in ms
    
    Returns:
    
    The updated SelectedItemParams object itself.
  - getSizeAnimationDelay
```
public long getSizeAnimationDelay()
```
    Get delay of selected item size animation.
    
    Returns:
    
    delay in ms
  - setSizeAnimationTime
```
public ARController.SelectedItemParams setSizeAnimationTime(long value)
```
    Set selected item size animation time.
    
    Parameters:
    
    value - Delay in ms
    
    Returns:
    
    The updated SelectedItemParams object itself.
  - getSizeAnimationTime
```
public long getSizeAnimationTime()
```
    Get delay of selected item size animation.
    
    Returns:
    
    delay in ms
  - setBoundingBoxAnimationDelay
```
public ARController.SelectedItemParams setBoundingBoxAnimationDelay(long value)
```
    Set selected item bounding box animation delay.
    
    Parameters:
    
    value - Delay in ms
    
    Returns:
    
    The updated SelectedItemParams object itself.
  - getBoundingBoxAnimationDelay
```
public long getBoundingBoxAnimationDelay()
```
    Get delay of selected item bounding box animation.
    
    Returns:
    
    delay in ms
  - setBoundingBoxAnimationTime
```
public ARController.SelectedItemParams setBoundingBoxAnimationTime(long value)
```
    Set selected item bounding box animation time.
    
    Parameters:
    
    value - Delay in ms
    
    Returns:
    
    The updated SelectedItemParams object itself.
  - getBoundingBoxAnimationTime
```
public long getBoundingBoxAnimationTime()
```
    Get delay of selected item bounding box animation.
    
    Returns:
    
    delay in ms
  - setMaxViewAngle
```
public ARController.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.
  - getMaxViewAngle
```
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.

Class ARController.SelectedItemParams

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setSize

getSize

setBoundingBox

setOpacity

getOpacity

setNonSelectedItemsOpacity

getNonSelectedItemsOpacity

setSizeInterpolator

getSizeInterpolator

setBoundingBoxInterpolator

getBoundingBoxInterpolator

setSizeAnimationDelay

getSizeAnimationDelay

setSizeAnimationTime

getSizeAnimationTime

setBoundingBoxAnimationDelay

getBoundingBoxAnimationDelay

setBoundingBoxAnimationTime

getBoundingBoxAnimationTime

setMaxViewAngle

getMaxViewAngle