HERE Android SDK Developer's Guide

StreetLevelBillboard

The class StreetLevelBillboard is a member of com.here.android.mpa.streetlevel .

Class Summary

public final class StreetLevelBillboard

extends com.here.android.mpa.streetlevel.StreetLevelIconBase, com.here.android.mpa.streetlevel.StreetLevelObject, com.here.android.mpa.common.ViewObject, java.lang.Object

Represents a street level billboard object.

[For complete information, see the section Class Details]

Constructor Summary

Table 1. Constructors in StreetLevelBillboard
Constructors

StreetLevelBillboard (GeoCoordinate coordinate, Image image)

Public Constructor

Method Summary

Table 2. Methods in StreetLevelBillboard
Methods

public float getHeight ()

Gets the current height of a StreetLevelBillboard, in meters.

public StreetLevelBillboardOrientation getOrientation ()

Gets the orientation of the StreetLevelBillboard.

public float getWidth ()

Gets the current width of a StreetLevelBillboard, in meters.

public StreetLevelBillboard setFacadePlacementSize (float width, float height, float minimumDistance, float maximumDistance)

Sets icon size used in facade placement calculation.

public StreetLevelBillboard setHeight (float height)

Sets a height, in meters, for the StreetLevelBillboard.

public StreetLevelBillboard setOrientation (StreetLevelBillboardOrientation orientation)

Sets the orientation for the StreetLevelBillboard.

public StreetLevelBillboard setSize (float width, float height)

Sets a size for the billboard, in meters.

public StreetLevelBillboard setWidth (float width)

Sets a width, in meters, for the StreetLevelBillboard.

Class Details

Represents a street level billboard object. Users can add a StreetLevelBillboard object to an on-screen StreetLevelModel instance by binding it with a StreetLevelFragment object.

Constructor Details

StreetLevelBillboard (GeoCoordinate coordinate, Image image)

Public Constructor

Parameters:

  • coordinate

    The GeoCoordinate for this billboard

  • image

    Image texture to be displayed on this billboard

Throws:

  • NullPointerException

    Passed argument is null

  • IllegalArgumentException

    Passed argument is invalid

Method Details

public float getHeight ()

Gets the current height of a StreetLevelBillboard, in meters.

Returns:

The current height

public StreetLevelBillboardOrientation getOrientation ()

Gets the orientation of the StreetLevelBillboard.

Returns:

The orientation of the StreetLevelBillboard.

public float getWidth ()

Gets the current width of a StreetLevelBillboard, in meters.

Returns:

The current width

public StreetLevelBillboard setFacadePlacementSize (float width, float height, float minimumDistance, float maximumDistance)

Sets icon size used in facade placement calculation. By default the value specified in setSize(float, float) is used and each call to setSize(float, float) causes placement recalculation. Once setFacadePlacementSize(float, float, float, float) is called the value specified is used instead and setSize(float, float) does not cause facade placement recalculation. It is assumed that facade placement size is an upper limit of the actual size.

Parameters:

  • width

    Width of the icon in meters.

  • height

    Height of the icon in meters

  • minimumDistance

    Minimum distance at which the size specified is applied.

  • maximumDistance

    Maximum distance at which the size specified is applied.

Returns:

This StreetLevelBillboard object

public StreetLevelBillboard setHeight (float height)

Sets a height, in meters, for the StreetLevelBillboard.

Parameters:

  • height

    Desired height

Returns:

This StreetLevelBillboard object

public StreetLevelBillboard setOrientation (StreetLevelBillboardOrientation orientation)

Sets the orientation for the StreetLevelBillboard.

Parameters:

  • orientation

    Orientation of the billboard

Returns:

This StreetLevelBillboard object

public StreetLevelBillboard setSize (float width, float height)

Sets a size for the billboard, in meters. If the size is not set, the billboard will not be displayed in the street level image.

Parameters:

  • width

    Desired width

  • height

    Desired height

Returns:

This StreetLevelBillboard object

public StreetLevelBillboard setWidth (float width)

Sets a width, in meters, for the StreetLevelBillboard.

Parameters:

  • width

    Desired width

Returns:

This StreetLevelBillboard object