GroundOverlayOptions

public final 类 GroundOverlayOptions扩展对象
实现 Parcelable

定义地面叠加层的选项。

常量摘要

float

NO_DIMENSION

未指定高度尺寸时的标志。

继承的常量摘要

继承自 android.os.Parcelable 接口

int	CONTENTS_FILE_DESCRIPTOR
int	PARCELABLE_WRITE_RETURN_VALUE

公共构造函数摘要

GroundOverlayOptions() 用于创建一组新的地面叠加层选项。

公共方法摘要

GroundOverlayOptions	anchor(float u, float v) 指定锚点。
GroundOverlayOptions	方向角（浮动方向角） 以与北方所呈顺时针角度指定地面叠加层的方位。
GroundOverlayOptions	clickable（布尔值可点击） 指定地面叠加层是否可点击。
浮点数	getAnchorU() 水平相对锚点；0.0 和 1.0 分别表示左侧边缘和右侧边缘。
浮点数	getAnchorV() 垂直相对锚点；0.0 和 1.0 分别表示顶部边缘和底部边缘。
浮点数	getBearing() 获取此 GroundOverlayOptions 对象的方向角。
LatLngBounds	getBounds() 获取为此 GroundOverlayOptions 对象设置的边界。
浮点数	getHeight() 获取为此 GroundOverlayOptions 对象设置的高度。
BitmapDescriptor	getImage() 获取为此 GroundOverlayOptions 对象设置的图片描述符。
LatLng	getLocation() 获取为此 GroundOverlayOptions 对象设置的位置。
浮点数	getTransparency() 获取为此 GroundOverlayOptions 对象设置的透明度。
浮点数	getWidth() 获取为此 GroundOverlayOptions 对象设置的宽度。
浮点数	getZIndex() 获取为此 GroundOverlayOptions 对象设置的 ZIndex。
GroundOverlayOptions	image(BitmapDescriptor imageDescriptor) 指定此地面叠加层的图像。
布尔值	isClickable() 获取此 GroundOverlayOptions 对象的可点击性设置。
布尔值	isVisible() 获取此 GroundOverlayOptions 对象的可见性设置。
GroundOverlayOptions	position(LatLng 位置, 浮点宽度) 使用锚点 (LatLng) 和宽度（以米为单位）指定此地面叠加层的位置。
GroundOverlayOptions	position(LatLng location, float width, float height) 使用定位点 (LatLng)、宽度和高度（均以米为单位）指定此地面叠加层的位置。
GroundOverlayOptions	positionFromBounds(LatLngBounds 边界) 指定该地面叠加层的位置。
GroundOverlayOptions	透明度（浮点数透明度） 指定地面叠加层的透明度。
GroundOverlayOptions	visible（布尔值 visible） 用于指定地面叠加层的可见性。
GroundOverlayOptions	zIndex（浮点数 zIndex） 指定地面叠加层的 zIndex，即绘制顺序。

继承的方法摘要

继承自 java.lang.Object 类

布尔值	equals(Object arg0)
final Class<?>	getClass()
整型	hashCode()
final void	notify()
final void	notifyAll()
字符串	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

继承自 android.os.Parcelable 接口

abstract int	describeContents()
abstract void	writeToParcel(Parcel arg0, int arg1)

常量

public static final float NO_DIMENSION

未指定高度尺寸时的标志。

常量值： -1.0

公共构造函数

public GroundOverlayOptions ()

用于创建一组新的地面叠加层选项。

公共方法

public GroundOverlayOptions anchor (float u, float v)

指定锚点。

锚点会与地面叠加层的位置对齐。

锚点在 2D 连续空间中指定，其中 (0,0)、(1,0)、(0,1) 和 (1,1) 分别表示左上角、右上角、左下角和右下角。

 *-----+-----+-----+-----*
 |     |     |     |     |
 |     |     |     |     |
 +-----+-----+-----+-----+
 |     |     |   X |     |   (U, V) = (0.7, 0.6)
 |     |     |     |     |
 *-----+-----+-----+-----*
 

参数

u	锚点的 u 坐标
v	锚点的 v 坐标

返回

• 此 GroundOverlayOptions 对象。

public GroundOverlayOptions bearing （浮动方向角）

以与北方所呈顺时针角度指定地面叠加层的方位。旋转是围绕锚点进行的。如果未指定，默认值为 0（即图片向上指向北方）。

请注意，经纬度边界在旋转之前适用。

参数

方向角	表示从北方顺时针旋转的方位（以度为单位）。超出 [0, 360) 范围的值将进行标准化。

返回

• 此 GroundOverlayOptions 对象。

public GroundOverlayOptions clickable （布尔值可点击）

指定地面叠加层是否可点击。默认的可点击性为 false。

参数

可点击	新的可点击性设置。

返回

• 此 GroundOverlayOptions 对象，并为其采用新的可点击性设置。

public float getAnchorU ()

水平相对锚点；0.0 和 1.0 分别表示左侧边缘和右侧边缘。系统会相应地插入其他锚点值。

返回

• 水平边缘相对锚点位置。

public float getAnchorV ()

垂直相对锚点；0.0 和 1.0 分别表示顶部边缘和底部边缘。系统会相应地插入其他锚点值。

返回

• 垂直边缘相对锚点位置。

public float getBearing ()

获取此 GroundOverlayOptions 对象的方向角。

返回

• 地面叠加层的方向角。

public LatLngBounds getBounds ()

获取为此 GroundOverlayOptions 对象设置的边界。

返回

• 地面叠加层的边界。如果位置是使用 position(LatLng, float) 或 position(LatLng, float, float) 设置的，此值将为 null。

public float getHeight ()

获取为此 GroundOverlayOptions 对象设置的高度。

返回

• 地面叠加层的高度。

public BitmapDescriptor getImage ()

获取为此 GroundOverlayOptions 对象设置的图片描述符。

返回

• 表示地面叠加层图片的 BitmapDescriptor。

public LatLng getLocation ()

获取为此 GroundOverlayOptions 对象设置的位置。

返回

• 放置地面叠加层锚点的位置。如果位置是使用 positionFromBounds(LatLngBounds) 设置的，此值将为 null。

公共浮点 getTransparency ()

获取为此 GroundOverlayOptions 对象设置的透明度。

返回

• 地面叠加层的透明度。

public float getWidth ()

获取为此 GroundOverlayOptions 对象设置的宽度。

返回

• 地面叠加层的宽度。

公共 浮点数 getZIndex ()

获取为此 GroundOverlayOptions 对象设置的 ZIndex。

返回

• 地面叠加层的 zIndex。

public GroundOverlayOptions image (BitmapDescriptor imageDescriptor)

指定该地面叠加层的图像。

如需将图像加载为纹理（用于在地图上绘制图像），必须将其转换为边长为 2 的次方的图像。这是为了能够创建 mipmap，从而以各种缩放级别渲染纹理。如需了解详情，请参阅 Mipmap（维基百科）。因此，为了通过避免这种转换来节省内存，建议将图像的尺寸设置为 2 的次方。

参数

imageDescriptor	要用于此地面叠加层的 BitmapDescriptor

返回

• 此 GroundOverlayOptions 对象。

public boolean isClickable ()

获取此 GroundOverlayOptions 对象的可点击性设置。

返回

• 如果地面叠加层可点击，则为 true；如果不可点击，则为 false。

public boolean isVisible ()

获取此 GroundOverlayOptions 对象的可见性设置。

返回

• 如果此地面叠加层可见，则为 true；如果不可见，则为 false。

public GroundOverlayOptions position (LatLng location, float width)

使用锚点 (LatLng) 和宽度（以米为单位）指定此地面叠加层的位置。系统会相应地调整高度以保持宽高比。

参数

个位置	给定图像中的锚点将保持固定在地图上的 LatLng 位置。应用转换（例如，setDimensions、setBearing 等）时，锚点将保持固定在地面上的位置。
width	叠加层的宽度（以米为单位）。高度将根据图片宽高比自动确定。

返回

• 此 GroundOverlayOptions 对象设置了新位置。

抛出

IllegalArgumentException	如果锚点为 null
IllegalArgumentException	如果宽度为负数
IllegalStateException	如果已使用 positionFromBounds(LatLngBounds) 设置位置

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

使用定位点 (LatLng)、宽度和高度（均以米为单位）指定此地面叠加层的位置。渲染时，系统会缩放图片以适应指定的尺寸。

参数

个位置	给定图像中的锚点将保持固定在地图上的 LatLng 位置。应用转换（例如，setDimensions、setBearing 等）时，锚点将保持固定在地面上的位置。
width	叠加层的宽度（以米为单位）
高度	叠加层的高度（以米为单位）

返回

• 此 GroundOverlayOptions 对象设置了新位置。

抛出

IllegalArgumentException	如果锚点为 null
IllegalArgumentException	如果宽度或高度为负数
IllegalStateException	如果已使用 positionFromBounds(LatLngBounds) 设置位置

public GroundOverlayOptions positionFromBounds (LatLngBounds bounds)

指定该地面叠加层的位置。

参数

bounds	一个 LatLngBounds，用于放置地面叠加层

返回

• 此 GroundOverlayOptions 对象设置了新位置。

抛出

IllegalStateException	如果已使用 position(LatLng, float) 或 position(LatLng, float, float) 设置位置

public GroundOverlayOptions transparency （浮点数透明度）

指定地面叠加层的透明度。默认透明度为 0（不透明）。

参数

透明度	[0..1] 范围内的浮点数，其中 0 表示地面叠加层不透明，1 表示地面叠加层是透明的。

返回

• 此 GroundOverlayOptions 对象。

抛出

IllegalArgumentException	如果透明度超出 [0..1] 范围，则会发生该错误。

public GroundOverlayOptions visible (boolean visible)

用于指定地面叠加层的可见性。默认的公开范围为 true。

参数

visible

返回

• 此 GroundOverlayOptions 对象。

public GroundOverlayOptions zIndex (float zIndex)

指定地面叠加层的 zIndex，即绘制顺序。如需详细了解 zIndex，请参阅此类顶部的文档。

参数

zIndex

返回

• 此 GroundOverlayOptions 对象。