GroundOverlay

La classe publique finale GroundOverlay étend l'objet

Une superposition au sol est une image fixée sur une carte. Une superposition au sol présente les propriétés suivantes:

Poste
Il existe deux façons d'indiquer la position d'une superposition au sol :
  • À l'aide d'un lieu: vous devez fournir une image de la superposition au sol, une LatLng sur laquelle l'ancre sera fixe et la largeur de la superposition (en mètres). Par défaut, l'ancre se trouve à 50% du haut de l'image et à 50% de sa gauche. Ce paramètre peut être modifié. Si vous le souhaitez, vous pouvez indiquer la hauteur de la superposition (en mètres). Si vous ne fournissez pas la hauteur de la superposition, elle sera automatiquement calculée pour conserver les proportions de l'image.
  • Utilisation de limites: vous devez indiquer un LatLngBounds qui contiendra l'image.
Vous devez spécifier la position de la superposition au sol avant de l'ajouter à la carte. Sinon, une IllegalArgumentException est générée lorsque la superposition au sol est ajoutée à la carte. De plus, vous ne devez spécifier la position qu'à l'aide de l'une de ces méthodes dans l'objet GroundOverlayOptions. Sinon, une erreur IllegalStateException sera générée si vous spécifiez l'utilisation d'une deuxième méthode.
Image
Image (au format BitmapDescriptor) à utiliser pour cette superposition. L'image est mise à l'échelle pour s'adapter à la position fournie. Vous devez spécifier une image avant d'ajouter la superposition au sol à la carte. Si ce n'est pas le cas, une IllegalArgumentException est générée lorsqu'elle est ajoutée à la carte.
Roulement
Mesure de rotation de l'image dans le sens des aiguilles d'une montre. Le centre de la rotation sera l'ancre de l'image. Cette valeur est facultative. La direction par défaut est 0, c'est-à-dire l'image est alignée avec le nord.
zIndex
Ordre dans lequel cette superposition au sol est dessinée par rapport aux autres superpositions (y compris les Polyline et TileOverlay, mais pas les Marker). Une superposition avec un zIndex plus grand est dessinée sur des superpositions ayant des zIndex plus petits. L'ordre des superpositions ayant la même valeur zIndex est arbitraire. Cette option est facultative et la valeur par défaut du zIndex est 0.
Transparence
Transparence de la superposition au sol dans la plage [0..1], où 0 signifie que la superposition est opaque et 1 signifie qu'elle est totalement transparente. Si le bitmap spécifié est déjà partiellement transparent, la transparence de chaque pixel est mise à l'échelle en conséquence.Par exemple, si un pixel du bitmap a une valeur alpha de 200 et que vous spécifiez la transparence de la superposition au sol sur 0,25, le pixel s'affiche à l'écran avec une valeur alpha de 150. La spécification de cette propriété est facultative, et la transparence par défaut est 0 (opaque).
Visibilité
Indique si la superposition au sol est visible ou invisible, c'est-à-dire si elle est dessinée sur la carte. Une superposition au sol invisible n'est pas dessinée, mais conserve toutes ses autres propriétés. Cette option est facultative et la visibilité par défaut est true, c'est-à-dire visible.
Cliquabilité
Si vous souhaitez gérer les événements déclenchés lorsque l'utilisateur clique sur la superposition au sol, définissez cette propriété sur true. Vous pouvez modifier cette valeur à tout moment. La valeur par défaut est false. Si cette propriété est définie sur true, votre application recevra des notifications à la GoogleMap.OnGroundOverlayClickListener enregistrée via setOnGroundOverlayClickListener(GoogleMap.OnGroundOverlayClickListener).
Tag
Object associé à la superposition au sol. Par exemple, Object peut contenir des données sur ce que la superposition au sol représente. Cette opération est plus facile que de stocker un Map<GroundOverlay, Object> distinct. Autre exemple : vous pouvez associer un ID String correspondant à l'ID d'un ensemble de données. Le SDK Google Maps pour Android ne lit ni n'écrit cette propriété.

Les méthodes de cette classe doivent être appelées sur le thread UI Android. Dans le cas contraire, une exception IllegalStateException est générée au moment de l'exécution.

Exemple

GoogleMap map = ...; // get a map.
 BitmapDescriptor imageDescriptor = ...; // get an image.
 LatLngBounds bounds = ...; // get a bounds
 // Adds a ground overlay with 50% transparency.
 GroundOverlay groundOverlay = map.addGroundOverlay(new GroundOverlayOptions()
     .image(imageDescriptor)
     .positionFromBounds(bounds)
     .transparency(0.5));

Récapitulatif des méthodes publiques

boolean
est égal à(autre objet)
Vérifie si cet élément GroundOverlay est égal à un autre.
float
getBearing()
Récupère l'orientation de la superposition au sol en degrés dans le sens des aiguilles d'une montre, à partir du nord.
LatLngBounds
getBounds()
Récupère les limites de la superposition au sol.
float
getHeight()
Récupère la hauteur de la superposition au sol.
Chaîne
getId()
Récupère l'ID de cette superposition au sol.
LatLng
getPosition()
Récupère l'emplacement du point d'ancrage.
Objet
getTag()
Récupère le tag du cercle.
float
getTransparency()
Récupère la transparence de cette superposition au sol.
float
getWidth()
Récupère la largeur de la superposition au sol.
float
getZIndex()
Récupère le zIndex de cette superposition au sol.
int
hashCode()
boolean
isClickable()
Récupère la cliquabilité de la superposition au sol.
boolean
isVisible()
Récupère la visibilité de cette superposition au sol.
void
supprimer()
Supprime cette superposition au sol de la carte.
void
setBearing(orientation à flot)
Définit l'orientation de la superposition au sol (direction de l'axe vertical de la superposition au sol) en degrés dans le sens des aiguilles d'une montre à partir du nord.
void
setClickable(valeur booléenne cliquable)
Définit la cliquabilité de la superposition au sol.
void
setDimensions(largeur flottante, hauteur flottante)
Définit les dimensions de la superposition au sol.
void
setDimensions(largeur flottante)
Définit la largeur de la superposition au sol.
void
setImage(imageDescriptor BitmapDescriptor)
Définit l'image pour la superposition au sol.
void
setPosition(LatLng latLng)
Définit la position de la superposition au sol en modifiant l'emplacement du point d'ancrage.
void
setPositionFromBounds(limites de LatLngBounds)
Définit la position de la superposition au sol en l'ajustant à l'élément LatLngBounds donné.
void
setTag(tag d'objet)
Définit le tag de la superposition au sol.
void
setTransparency(transparence de type "float")
Définit la transparence de cette superposition au sol.
void
setVisible(booléen visible)
Définit la visibilité de cette superposition au sol.
void
setZIndex(zIndex flottant)
Définit le zIndex de cette superposition au sol.

Récapitulatif des méthodes héritées

Méthodes publiques

public boolean est égal à (objet autre)

Vérifie si cet élément GroundOverlay est égal à un autre.

Paramètres
other un Object.
Renvoie
  • "true" si les deux objets sont le même, c'est-à-dire que ceci == other.

public float getBearing ()

Récupère l'orientation de la superposition au sol en degrés dans le sens des aiguilles d'une montre, à partir du nord.

Renvoie
  • la direction de la superposition au sol.

public LatLngBounds getBounds ()

Récupère les limites de la superposition au sol. La rotation de la superposition au sol est alors ignorée.

Renvoie
  • LatLngBounds contenant la superposition au sol, en ignorant la rotation.

public float getHeight ()

Récupère la hauteur de la superposition au sol.

Renvoie
  • la hauteur de la superposition au sol en mètres.

public String getId ()

Récupère l'ID de cette superposition au sol. L'ID est unique parmi toutes les GroundOverlays d'une carte.

Renvoie
  • l'identifiant de cette superposition au sol.

public LatLng getPosition ()

Récupère l'emplacement du point d'ancrage.

Renvoie
  • la position sur la carte (une LatLng).

objet public getTag ()

Récupère le tag du cercle.

Renvoie
  • la balise si une balise a été définie avec setTag ; null si aucune balise n'a été définie.

public float getTransparency ()

Récupère la transparence de cette superposition au sol.

Renvoie
  • la transparence de cette superposition au sol.

public float getWidth ()

Récupère la largeur de la superposition au sol.

Renvoie
  • la largeur de la superposition au sol en mètres.

public float getZIndex ()

Récupère le zIndex de cette superposition au sol.

Renvoie
  • le zIndex de la superposition au sol.

public int hashCode ()

public boolean isClickable ()

Récupère la cliquabilité de la superposition au sol. Si la superposition au sol est cliquable, votre application reçoit des notifications au GoogleMap.OnGroundOverlayClickListener lorsque l'utilisateur clique dessus. L'écouteur d'événements est enregistré via setOnGroundOverlayClickListener(GoogleMap.OnGroundOverlayClickListener).

Renvoie
  • true si la superposition au sol est cliquable. Sinon, renvoie false.

public boolean isVisible ()

Récupère la visibilité de cette superposition au sol. Notez que cette méthode ne permet pas de déterminer si la superposition au sol s'affiche réellement à l'écran, mais si elle sera dessinée si elle est contenue dans la fenêtre d'affichage de la caméra.

Renvoie
  • la visibilité de cette superposition au sol.

public vide remove ()

Supprime cette superposition au sol de la carte. Une fois qu'une superposition au sol a été supprimée, le comportement de toutes ses méthodes n'est plus défini.

public vide setBearing (orientation à flot)

Définit l'orientation de la superposition au sol (direction de l'axe vertical de la superposition au sol) en degrés dans le sens des aiguilles d'une montre à partir du nord. La rotation est effectuée autour du point d'ancrage.

Paramètres
orientation orientation en degrés dans le sens des aiguilles d'une montre à partir du nord

public void setClickable (booléen cliquable)

Définit la cliquabilité de la superposition au sol. Si la superposition au sol est cliquable, votre application reçoit des notifications au GoogleMap.OnGroundOverlayClickListener lorsque l'utilisateur clique dessus. L'écouteur d'événements est enregistré via setOnGroundOverlayClickListener(GoogleMap.OnGroundOverlayClickListener).

Paramètres
Vous pouvez appuyer. Nouveau paramètre de cliquabilité pour la superposition au sol.

public void setDimensions (largeur de flottement, hauteur de float)

Définit les dimensions de la superposition au sol. L'image est alors étirée afin de l'adapter aux dimensions requises.

Paramètres
largeur largeur en mètres
hauteur hauteur en mètres

public void setDimensions (largeur flottante)

Définit la largeur de la superposition au sol. La hauteur de la superposition au sol est adaptée en conséquence pour préserver le format.

Paramètres
largeur largeur en mètres

public vide setImage (BitmapDescriptor imageDescriptor)

Définit l'image pour la superposition au sol. La nouvelle image occupe les mêmes limites que l'ancienne.

Paramètres
imageDescriptor BitmapDescriptor à utiliser pour cette superposition au sol.

public vide setPosition (LatLng latLng)

Définit la position de la superposition au sol en modifiant l'emplacement du point d'ancrage. Conserve toutes les autres propriétés de l'image.

Paramètres
latLng LatLng, qui est le nouvel emplacement où placer le point d'ancrage.

public vide setPositionFromBounds (limites LatLngBounds)

Définit la position de la superposition au sol en l'ajustant à l'élément LatLngBounds donné. Cette méthode ignore la rotation (orientation) de la superposition au sol lors de son positionnement, mais l'orientation est quand même utilisée lors du tracé.

Paramètres
limites une LatLngBounds dans laquelle placer la superposition au sol

public vide setTag (tag d'objet)

Définit le tag de la superposition au sol.

Vous pouvez utiliser cette propriété pour associer un Object arbitraire à cette superposition au sol. Par exemple, Object peut contenir des données sur ce que la superposition au sol représente. Cette opération est plus facile que de stocker un élément Map<GroundOverlay, Object> distinct. Autre exemple, vous pouvez associer un ID String correspondant à l'ID d'un ensemble de données. Le SDK Google Maps pour Android ne lit ni n'écrit cette propriété. Vous êtes tenu d'appeler setTag(null) pour effacer la balise lorsque vous n'en avez plus besoin afin d'éviter les fuites de mémoire dans votre application.

Paramètres
tag Si la valeur est "null", la balise est effacée.

public vide setTransparency (transparence de type "float")

Définit la transparence de cette superposition au sol. Pour en savoir plus, consultez la documentation en haut de cette classe.

Paramètres
la transparence Flottant dans la plage [0..1], où 0 signifie que la superposition au sol est opaque et 1 signifie que la superposition au sol est transparente.

public void setVisible (boolean visible)

Définit la visibilité de cette superposition au sol. Lorsqu'elle n'est pas visible, aucune superposition au sol n'est dessinée, mais elle conserve toutes ses autres propriétés.

Paramètres
visible Si la valeur est true, la superposition au sol est visible. Si la valeur est false, elle n'est pas

public void setZIndex (float zIndex)

Définit le zIndex de cette superposition au sol. Pour en savoir plus, consultez la documentation en haut de cette classe.

Paramètres
zIndex le zIndex de cette superposition au sol