HERE Android SDK Developer's Guide

IconParams

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

Class Summary

public final class ARController.IconParams

extends java.lang.Object

Encapsulates parameters which affect the icons of an ARObject.

[For complete information, see the section Class Details]

Method Summary

Table 1. Methods in IconParams
Methods

public long getDepressAnimationDelay ()

Get delay of icon's depress animation.

public long getDepressAnimationTime ()

Get duration of icon's depress animation.

public float getDownIconOpacity ()

Get down icon's opacity.

public long getFlyAnimationDelay ()

Get delay of icon's fly animation.

public long getFlyAnimationTime ()

Get duration of icon's fly animation.

public AnimationInterpolator getFlyInterpolator ()

Get the interpolator for icon flying animation.

public Vector3f getFlyRotateAngles ()

Get icon's fly rotation angles.

public long getFlyRotateAnimationDelay ()

Get delay of icon's fly rotation animation.

public long getFlyRotateAnimationTime ()

Get duration of icon's fly rotation animation.

public long getPopUpAnimationDelay ()

Get delay of icon's first appearance animation(pop-up).

public long getPopUpAnimationTime ()

Get duration of icon's first appearance animation(pop-up).

public AnimationInterpolator getPopUpInterpolator ()

Get the interpolator for icon pop up animation.

public long getPressAnimationDelay ()

Get delay of icon's tap animation.

public long getPressAnimationTime ()

Get duration of icon's press animation.

public AnimationInterpolator getTurnInterpolator ()

Get the interpolator for icon rotation animation.

public boolean getUseDownIconOpacity ()

Get enabled status of down icon's opacity.

public IconParams setBackIconMaxSize (int width, int height)

Set back icon maximum size

public IconParams setBackToFrontIconSizeRatio (float ratio)

Set back to front icon size ratio.

public IconParams setDefaultIcons (int frontIconId, int backIconId, int downIconId)

Set default icons resource ids.

public IconParams setDepressAnimationDelay (long time)

Set delay of icon's depress animation.

public IconParams setDepressAnimationTime (long time)

Set duration of icon's depress animation.

public IconParams setDownIconOpacity (float opacity)

Set down icon's opacity.

public IconParams setFlyAnimationDelay (long value)

Set icon's fly animation delay.

public IconParams setFlyAnimationTime (long value)

Set icon's fly animation duration.

public IconParams setFlyIconSizeOnMap (ARObject object, int width, int height)

Set fly animation initial icon size while transitioning from MAP to CAMERA view and final icon size while transitioning from CAMERA to MAP view

public IconParams setFlyInterpolator (AnimationInterpolator value)

Set the interpolator for icon flying animation.

public IconParams setFlyRotateAngles (Vector3f value)

Set icon's fly rotation angles.

public IconParams setFlyRotateAnimationDelay (long value)

Set icon's fly rotation animation delay.

public IconParams setFlyRotateAnimationTime (long value)

Set icon's fly rotation animation duration.

public IconParams setFrontIconMaxSize (int width, int height)

Set front icon maximum size

public IconParams setPopUpAnimationDelay (long value)

Set icon's first appearance animation(pop-up) delay.

public IconParams setPopUpAnimationTime (long value)

Set icon's first appearance animation(pop-up) duration.

public IconParams setPopUpInterpolator (AnimationInterpolator value)

Set the interpolator for icon pop up animation.

public IconParams setPressAnimationDelay (long time)

Set delay of icon's press animation.

public IconParams setPressAnimationTime (long time)

Set duration of icon's press animation.

public IconParams setTurnInterpolator (AnimationInterpolator value)

Set the interpolator for icon rotation animation.

public IconParams setUseDownIconOpacity (boolean enabled)

Enables/disables usage of down icon opacity, by default, it is enabled.

Class Details

Encapsulates parameters which affect the icons of an ARObject.

Method Details

public long getDepressAnimationDelay ()

Get delay of icon's depress animation.

Returns:

delay of icon's depress animation in ms.

public long getDepressAnimationTime ()

Get duration of icon's depress animation.

Returns:

duration of icon's depress animation in ms.

public float getDownIconOpacity ()

Get down icon's opacity.

Returns:

down icon's opacity.

public long getFlyAnimationDelay ()

Get delay of icon's fly animation.

Returns:

delay of icon's fly animation in ms.

public long getFlyAnimationTime ()

Get duration of icon's fly animation.

Returns:

duration of icon's fly animation in Ms.

public AnimationInterpolator getFlyInterpolator ()

Get the interpolator for icon flying animation.

Returns:

AnimationInterpolator.

public Vector3f getFlyRotateAngles ()

Get icon's fly rotation angles.

Returns:

angles of rotation in degrees.

public long getFlyRotateAnimationDelay ()

Get delay of icon's fly rotation animation.

Returns:

delay of icon's fly rotation animation in ms.

public long getFlyRotateAnimationTime ()

Get duration of icon's fly rotation animation.

Returns:

duration of icon's fly rotation animation in ms.

public long getPopUpAnimationDelay ()

Get delay of icon's first appearance animation(pop-up).

Returns:

delay of icon's first appearance animation(pop-up) in ms.

public long getPopUpAnimationTime ()

Get duration of icon's first appearance animation(pop-up).

Returns:

duration of icon's first appearance animation(pop-up) in ms.

public AnimationInterpolator getPopUpInterpolator ()

Get the interpolator for icon pop up animation.

Returns:

AnimationInterpolator.

public long getPressAnimationDelay ()

Get delay of icon's tap animation.

Returns:

delay of icon's tap animation in ms.

public long getPressAnimationTime ()

Get duration of icon's press animation.

Returns:

duration of icon's press animation in ms.

public AnimationInterpolator getTurnInterpolator ()

Get the interpolator for icon rotation animation.

Returns:

AnimationInterpolator.

public boolean getUseDownIconOpacity ()

Get enabled status of down icon's opacity.

Returns:

down icon's opacity status.

public IconParams setBackIconMaxSize (int width, int height)

Set back icon maximum size

Parameters:

  • width

    Maximum width of back icon in pixels

  • height

    Maximum height of back icon in pixels

Returns:

The updated IconParams object itself.

public IconParams setBackToFrontIconSizeRatio (float ratio)

Set back to front icon size ratio. The ratio is taken into account ONLY if icon and info sizes are NOT set explicitly. For example, a ratio of 0.5 means the back icon has half the width and height of the front icon.

Parameters:

  • ratio

    back to front icon size ratio

Returns:

The updated IconParams object itself.

public IconParams setDefaultIcons (int frontIconId, int backIconId, int downIconId)

Set default icons resource ids.

Parameters:

  • frontIconId

    Front fallback icon resource Id

  • backIconId

    Back fallback icon resource Id

  • downIconId

    Down fallback icon resource Id

Returns:

The updated IconParams object itself.

public IconParams setDepressAnimationDelay (long time)

Set delay of icon's depress animation.

Parameters:

  • time

    delay of icon's depress animation in ms.

Returns:

The updated IconParams object itself.

public IconParams setDepressAnimationTime (long time)

Set duration of icon's depress animation.

Parameters:

  • time

    duration of icon's depress animation in ms.

Returns:

The updated IconParams object itself.

public IconParams setDownIconOpacity (float opacity)

Set down icon's opacity.

Parameters:

  • opacity

    Down icon's opacity.

Returns:

The updated IconParams object itself.

public IconParams setFlyAnimationDelay (long value)

Set icon's fly animation delay.

Parameters:

  • value

    fly animation delay in ms

Returns:

The updated IconParams object itself.

public IconParams setFlyAnimationTime (long value)

Set icon's fly animation duration.

Parameters:

  • value

    fly animation duration in ms

Returns:

The updated IconParams object itself.

public IconParams setFlyIconSizeOnMap (ARObject object, int width, int height)

Set fly animation initial icon size while transitioning from MAP to CAMERA view and final icon size while transitioning from CAMERA to MAP view

Parameters:

  • object

    An ARObject to set the size to

  • width

    An icon width at the start/end of animation

  • height

    An icon height at the start/end of animation

Returns:

The updated IconParams object itself.

public IconParams setFlyInterpolator (AnimationInterpolator value)

Set the interpolator for icon flying animation.

Parameters:

Returns:

The updated IconParams object itself.

public IconParams setFlyRotateAngles (Vector3f value)

Set icon's fly rotation angles.

Parameters:

  • value

    icon's fly rotation angles in degrees.

Returns:

The updated IconParams object itself.

public IconParams setFlyRotateAnimationDelay (long value)

Set icon's fly rotation animation delay.

Parameters:

  • value

    fly rotation animation delay in ms

Returns:

The updated IconParams object itself.

public IconParams setFlyRotateAnimationTime (long value)

Set icon's fly rotation animation duration.

Parameters:

  • value

    fly rotation animation duration in ms

Returns:

The updated IconParams object itself.

public IconParams setFrontIconMaxSize (int width, int height)

Set front icon maximum size

Parameters:

  • width

    Maximum width of front icon in pixels

  • height

    Maximum height of front icon in pixels

Returns:

The updated IconParams object itself.

public IconParams setPopUpAnimationDelay (long value)

Set icon's first appearance animation(pop-up) delay.

Parameters:

  • value

    pop-up animation delay in ms

Returns:

The updated IconParams object itself.

public IconParams setPopUpAnimationTime (long value)

Set icon's first appearance animation(pop-up) duration.

Parameters:

  • value

    pop-up animation duration in ms

Returns:

The updated IconParams object itself.

public IconParams setPopUpInterpolator (AnimationInterpolator value)

Set the interpolator for icon pop up animation.

Parameters:

Returns:

The updated IconParams object itself.

public IconParams setPressAnimationDelay (long time)

Set delay of icon's press animation.

Parameters:

  • time

    delay of icon's tap animation in ms.

Returns:

The updated IconParams object itself.

public IconParams setPressAnimationTime (long time)

Set duration of icon's press animation.

Parameters:

  • time

    duration of icon's press animation in ms.

Returns:

The updated IconParams object itself.

public IconParams setTurnInterpolator (AnimationInterpolator value)

Set the interpolator for icon rotation animation.

Parameters:

Returns:

The updated IconParams object itself.

public IconParams setUseDownIconOpacity (boolean enabled)

Enables/disables usage of down icon opacity, by default, it is enabled. When enabled, down icons will use the opacity specified through setDownIconOpacity(float), instead of the opacity computed for up icons.

Parameters:

  • enabled

    Enabled status

Returns:

The updated IconParams object itself.