目录

GroundOverlayOptions

Class Info

public class GroundOverlayOptions

用于设置GroundOverlay属性的类。

Public Constructor Summary

Constructor Name

GroundOverlayOptions()

GroundOverlayOptions类的默认构造方法。

Public Method Summary

Qualifier and Type

Method Name and Description

GroundOverlayOptions

anchor(float u, float v)

设置覆盖物图片的对齐方式,即指定锚点的位置。

GroundOverlayOptions

bearing(float bearing)

设置覆盖物从正北顺时针的角度。

GroundOverlayOptions

clickable(boolean clickable)

设置覆盖物的可点击性。

float

getAnchorU()

获取覆盖物锚点的水平位置的值。

float

getAnchorV()

获取覆盖物锚点的垂直位置的值。

float

getBearing()

获取覆盖物的角度。

LatLngBounds

getBounds()

获取覆盖物的矩形区域。

float

getHeight()

获取覆盖物的高度。

BitmapDescriptor

getImage()

获取覆盖物的图片信息。

LatLng

getLocation()

获取覆盖物的位置。

float

getTransparency()

获取覆盖物的透明度。

float

getWidth()

获取覆盖物的宽度。

float

getZIndex()

获取覆盖物的z指数。

GroundOverlayOptions

image(BitmapDescriptor imageDescriptor)

设置覆盖物的图片信息。

boolean

isClickable()

获取覆盖物的可点击性。

boolean

isVisible()

获取覆盖物的可见性。

GroundOverlayOptions

position(LatLng location, float width)

根据位置和宽设置覆盖物。

GroundOverlayOptions

position(LatLng location, float width, float height)

根据位置和宽高设置覆盖物。

GroundOverlayOptions

positionFromBounds(LatLngBounds bounds)

根据矩形区域设置覆盖物的位置。

GroundOverlayOptions

transparency(float transparency)

设置覆盖物的透明度。

GroundOverlayOptions

visible(boolean visible)

设置覆盖物的可见性。

GroundOverlayOptions

zIndex(float zIndex)

设置覆盖物的z指数。

Public Methods

[h2]anchor

Method

public GroundOverlayOptions anchor(float u, float v)

您调用此API可以设置覆盖物图片的对齐方式,即指定锚点的位置。(0, 0)是左上角,(1, 0)是右上角,(0, 1)是左下角,(1, 1)是右下角 。如果不设置,默认为(0.5, 0.5)图片的中心点。例如,在覆盖物X(0.5, 0.3)处的锚点坐标如下:

Parameters

Name

Description

u

锚点的水平坐标,以图像宽度的比例,建议取值[0, 1]。默认值为0.5。

v

锚点的垂直坐标,以图像高度的比例,建议取值[0, 1]。默认值为0.5。

Returns

Type

Description

GroundOverlayOptions

设置新的对齐方式后的GroundOverlayOptions对象。

[h2]bearing

Method

public GroundOverlayOptions bearing(float bearing)

您调用此API可以设置覆盖物从正北顺时针的角度。

Parameters

Name

Description

bearing

覆盖物从正北顺时针的角度,正北方向为0度。取值说明:

  • [0, 360):顺时针增加,默认为0。
  • 负数:逆时针增加。例如:-90,逆时针旋转90度。
  • 大于360:顺时针循环增加。例如:450,顺时针旋转90度。

Returns

Type

Description

GroundOverlayOptions

设置新的角度后的GroundOverlayOptions对象。

[h2]clickable

Method

public GroundOverlayOptions clickable(boolean clickable)

您调用此API可以设置覆盖物的可点击性。

Parameters

Name

Description

clickable

可点击性,默认为不可点击。

Returns

Type

Description

GroundOverlayOptions

设置新的可点击性后的GroundOverlayOptions对象。

[h2]getAnchorU

Method

public float getAnchorU()

您调用此API可以获取覆盖物锚点的水平位置的值。

Returns

Type

Description

float

锚点水平方向的值,取值范围:[0, 1]。

[h2]getAnchorV

Method

public float getAnchorV()

您调用此API可以获取覆盖物锚点的垂直位置的值。

Returns

Type

Description

float

锚点垂直方向的值,取值范围:[0, 1]。

[h2]getBearing

Method

public float getBearing()

您调用此API可以获取覆盖物的角度。

Returns

Type

Description

float

覆盖物的角度,取值范围:[0, 360)。

[h2]getBounds

Method

public LatLngBounds getBounds()

您调用此API可以获取覆盖物的矩形区域。

Returns

Type

Description

LatLngBounds

覆盖物的矩形区域。

[h2]getHeight

Method

public float getHeight()

您调用此API可以获取覆盖物的高度。

Returns

Type

Description

float

覆盖物的高度,单位:米。

[h2]getImage

Method

public BitmapDescriptor getImage()

您调用此API可以获取覆盖物的图片信息。

Returns

Type

Description

BitmapDescriptor

覆盖物图片。

[h2]getLocation

Method

public LatLng getLocation()

您调用此API可以获取覆盖物的位置。

Returns

Type

Description

LatLng

覆盖物的经纬度。

[h2]getTransparency

Method

public float getTransparency()

您调用此API可以获取覆盖物的透明度。

Returns

Type

Description

float

覆盖物的透明度,取值范围:[0, 1]。

  • 0:不透明。
  • 1:全透明。

[h2]getWidth

Method

public float getWidth()

您调用此API可以获取覆盖物的宽度。

Returns

Type

Description

float

覆盖物的宽度。

[h2]getZIndex

Method

public float getZIndex()

您调用此API可以获取覆盖物的z指数。

Returns

Type

Description

float

z指数,即覆盖物的叠加顺序。

[h2]image

Method

public GroundOverlayOptions image(BitmapDescriptor imageDescriptor)

您调用此API可以设置覆盖物的图片信息。

Parameters

Name

Description

imageDescriptor

图片对象。

Returns

Type

Description

GroundOverlayOptions

设置新的图片信息后的GroundOverlayOptions对象。

[h2]isClickable

Method

public boolean isClickable()

您调用此API可以获取覆盖物的可点击性。

Returns

Type

Description

boolean

覆盖物的可点击性。

  • true:可点击
  • false:不可点击

[h2]isVisible

Method

public boolean isVisible()

您调用此API可以获取覆盖物的可见性。

Returns

Type

Description

boolean

覆盖物的可见性。

  • true:可见
  • false:不可见

[h2]position(LatLng location, float width)

Method

public GroundOverlayOptions position(LatLng location, float width)

根据位置和宽设置覆盖物。在显示时,图片高度根据图片的比例自动匹配。

Parameters

Name

Description

location

锚点的位置。默认情况下,锚点在距离图像顶部和图像左侧一半的位置。

width

覆盖物的宽,单位:米。

Throws

Name

Description

IllegalArgumentException

锚点的位置为空或者传入的width为负数时,抛出异常。

IllegalStateException

如果已使用positionFromBounds(LatLngBounds)设置了位置,抛出异常。

Returns

Type

Description

GroundOverlayOptions

设置新的位置和宽度后的GroundOverlayOptions对象。

[h2]position(LatLng location, float width, float height)

Method

public GroundOverlayOptions position(LatLng location, float width, float height)

根据位置和宽高设置覆盖物。在显示时,图片会被缩放来适应指定的尺寸。

Parameters

Name

Description

location

锚点的位置。默认情况下,锚点在距离图像顶部和图像左侧一半的位置。

width

覆盖物的宽,单位:米。

height

覆盖物的高,单位:米。

Throws

Name

Description

IllegalArgumentException

锚点的位置为空或者传入的width/height为负数时,抛出异常。

IllegalStateException

如果已使用positionFromBounds(LatLngBounds)设置了位置,抛出异常。

Returns

Type

Description

GroundOverlayOptions

设置新的位置和宽高后的GroundOverlayOptions对象。

[h2]positionFromBounds

Method

public GroundOverlayOptions positionFromBounds(LatLngBounds bounds)

您调用此API可以根据矩形区域设置覆盖物的位置。

Parameters

Name

Description

bounds

矩形区域。

Throws

Name

Description

IllegalStateException

如果已使用position(LatLng location, float width)或者position(LatLng location, float width, float height)设置了位置,抛出异常。

Returns

Type

Description

GroundOverlayOptions

设置新的矩形区域位置后的GroundOverlayOptions对象。

[h2]transparency

Method

public GroundOverlayOptions transparency(float transparency)

设置覆盖物的透明度,取值范围:[0, 1],0为不透明,1为全透明。

Parameters

Name

Description

transparency

覆盖物的透明度,默认值为0。

Throws

Name

Description

IllegalArgumentException

透明度范围超过[0, 1]抛出异常。

Returns

Type

Description

GroundOverlayOptions

设置新的透明度后的GroundOverlayOptions对象。

[h2]visible

Method

public GroundOverlayOptions visible(boolean visible)

您调用此API可以设置覆盖物的可见性,如果覆盖物不可见,则不会绘制,其他所有状态均保留。

Parameters

Name

Description

visible

覆盖物的可见性,默认为可见。

Returns

Type

Description

GroundOverlayOptions

设置新的可见性后的GroundOverlayOptions对象。

[h2]zIndex

Method

public GroundOverlayOptions zIndex(float zIndex)

用于设置覆盖物的z指数。z指数指的是覆盖物的叠加顺序,具有较大z指数的覆盖物会绘制在具有较小z指数的覆盖物上,具有相同z指数的叠加顺序为元素添加的先后顺序。

Parameters

Name

Description

zIndex

z指数,即覆盖物的叠加顺序。默认的z指数是0。

Returns

Type

Description

GroundOverlayOptions

设置新的z指数后的GroundOverlayOptions对象。