Package com.here.sdk.venue.control

Class Venue

java.lang.Object
com.here.NativeBase
com.here.sdk.venue.control.Venue
public final class Venue extends NativeBase

Controls the VenueModel inside the VenueMap object. The venue controls the selection of the VenueDrawing and the VenueLevel of the VenueModel. It provides the possibility to customize styles for the VenueGeometry. Objects of this class can only be created using methods VenueMap.addVenueAsync(String, VenueLoadErrorCallback) and VenueMap.selectVenueAsync(String, VenueLoadErrorCallback).

  • Method Details

    • setCustomStyle

      public void setCustomStyle(@NonNull List<VenueGeometry> geometries, @Nullable VenueGeometryStyle style, @Nullable VenueLabelStyle labelStyle)

      Sets a custom style for geometries and related labels.

      Parameters:
      geometries -

      The list of geometries to apply the new style.

      style -

      The style for geometries, or null to reset the style to default.

      labelStyle -

      The style for geometry labels, or null to reset the label style to default.

    • setCustomStyle

      public void setCustomStyle(@NonNull List<VenueTopology> topologies, @Nullable VenueGeometryStyle style)

      Sets a custom style for topologies.

      Parameters:
      topologies -

      The list of topologies to apply the new style.

      style -

      The style for geometries, or null to reset the style to default.

    • setCustomStyleToCrosswalk

      public void setCustomStyleToCrosswalk(@NonNull List<Crosswalk> crosswalks, @Nullable VenueGeometryStyle style)

      Sets a custom style for crosswalk.

      Parameters:
      crosswalks -

      The list of crosswalk to apply the new style.

      style -

      The style for geometries, or null to reset the style to default.

    • getVenueModel

      @NonNull public VenueModel getVenueModel()

      Gets the VenueModel controlled by this object.

      It can be used to get the VenueModel belonging to this object, like a building or a complex of buildings.

      Returns:

      The VenueModel controlled by this object.

    • getVenueStyle

      @NonNull public VenueStyle getVenueStyle()

      Gets the VenueStyle associated with the VenueModel controlled by this object.

      It can be used to get the style of the venue. Contains the information about the geometry and label styles available for the venue.

      Returns:

      The VenueStyle associated with the VenueModel controlled by this object.

    • getSelectedDrawing

      @NonNull public VenueDrawing getSelectedDrawing()

      Gets the currently selected VenueDrawing of the VenueModel.

      Only the selected drawing will be visible as active on the map. All others will be hidden or displayed without details, depending on the implementation of the renderer.

      Returns:

      The selected drawing.

    • setSelectedDrawing

      public void setSelectedDrawing(@NonNull VenueDrawing value)

      Sets the selected VenueDrawing.

      Only the selected drawing will be visible as active on the map. All others will be hidden or displayed without details, depending on the implementation of the renderer.

      Parameters:
      value -

      The selected drawing.

    • getSelectedLevel

      @NonNull public VenueLevel getSelectedLevel()

      Gets the currently selected VenueLevel from the selected VenueDrawing.

      Only the selected level will be visible as active on the map. All others will be hidden or displayed without details, depending on a renderer implementation. If the level doesn't belong to the currently selected drawing, it can not be selected.

      Returns:

      The selected level.

    • setSelectedLevel

      public void setSelectedLevel(@NonNull VenueLevel value)

      Sets the selected VenueLevel from the currently selected VenueDrawing.

      Only the selected level will be visible as active on the map. All others will be hidden or displayed without details, depending on a renderer implementation. If the level doesn't belong to the currently selected drawing, it can not be selected.

      Parameters:
      value -

      The selected level.

    • getSelectedLevelZIndex

      public int getSelectedLevelZIndex()

      Gets the Z index of the currently selected VenueLevel.

      Z index 0 represents the ground level, negative values represent underground levels, positive values - levels above the ground. Z index can also be taken from VenueLevel.getZIndex().

      Returns:

      The Z index value of the VenueLevel selected.

    • setSelectedLevelZIndex

      public void setSelectedLevelZIndex(int value)

      Sets the VenueLevel with the specified Z index as selected.

      Z index 0 represents the ground level, negative values represent underground levels, positive values - levels above the ground. Z index can also be taken from VenueLevel.getZIndex().

      Parameters:
      value -

      The Z index value of the VenueLevel selected.

    • getSelectedLevelIndex

      public int getSelectedLevelIndex()

      Gets the index of the currently selected VenueLevel in the level array of the related VenueDrawing. The level array can be taken from VenueDrawing.getLevels().

      Unlike the Z index, it can't have a negative value.

      Returns:

      The index of the VenueLevel selected from the level array of the VenueDrawing.

    • setSelectedLevelIndex

      public void setSelectedLevelIndex(int value)

      Sets the VenueLevel with the specified index from the level array of the VenueDrawing as selected.

      Unlike the Z index, it can't have a negative value.

      Parameters:
      value -

      The index of the VenueLevel selected from the level array of the VenueDrawing.

    • isTopologyVisible

      public boolean isTopologyVisible()

      Gets the current status of topology visibility.

      It can be used to check the status of topology visibility.

      Returns:

      Returns true if topology is visible.

    • setTopologyVisible

      public void setTopologyVisible(boolean value)

      Sets the topology visibility.

      It can be used to check the status of topology visibility.

      Parameters:
      value -

      Returns true if topology is visible.