GroundOverlay

java.lang.Object
- com.zdc.android.zms.maps.model.GroundOverlay

```
public final class GroundOverlay
extends java.lang.Object
```
グラウンドオーバーレイを定義する。

グラウンドオーバーレイは以下のプロパティを持つ。
Position
位置の指定には２種類の方法がある。
- 緯度経度：アンカー(重心)位置の緯度経度(LatLng)と、画像の幅(m)を指定する。アンカーポイントのデフォルトは画像中心。
  画像の高さ(m)を指定することもできる。高さを指定しない場合は、画像のアスペクト比によって自動で計算される。
- バウンディングボックス：画像を含めるバウンディングボックス(LatLngBounds)を指定する。
位置が指定される前にオーバーレイがマップに追加された場合、IllegalArgumentExceptionがスローされる。
また、位置の指定はGroundOverlayOptionsのメソッドを使って行う必要がある。
他のメソッドを使用した場合、IllegalStateExceptionがスローされる。
Image

画像(Bitmap)はこのオーバーレイに使用される。
画像は、指定した位置に描画される。
画像の幅、または高さが1024を超える場合、IllegalArgumentExceptionがスローされる。
画像が指定される前にオーバーレイがマップに追加された場合、IllegalArgumentExceptionがスローされる。

Bearing

画像を時計回りに回転する量。回転の中心はアンカーポイントとなる。デフォルト値は0(北)。

zIndex

他の形状(Polylines, Circles, Polygons ※Markersは対象外)も含め、上に描画する順番。
高いzIndexを持つオブジェクトは、より低いzIndexを持つオブジェクトの上に描画される。
同じzIndexを持つ場合は、不定の順番で描画される。
デフォルトのzIndexは0。

Transparency

オーバーレイの透明性。
範囲は[0..1]で、0が不透明、1が透明を意味する。
指定された画像が既に透明である場合は、それにさらにTransparencyの値が加味される。
(例：200のα値を持つ画像に、0.25のTransparencyを与えた場合、α値は150となる)
デフォルトのTransparencyは0。

Visibility

オブジェクトが地図上に表示されているかどうか。デフォルトはtrue。すなわち表示される。

Clickability

ユーザーがオブジェクトをクリックしたときのイベントをハンドリングしたい場合は、このプロパティにtrueを設定する。
デフォルトはfalse。このプロパティがtrueの時、ZDCMap.setOnGroundOverlayClickListener(ZDCMap.OnGroundOverlayClickListener)で登録したZDCMap.OnGroundOverlayClickListenerの通知を受ける。
Code Example
```
 
 // オーバーレイ追加
 ZDCMap map = ...;
 Bitmap image = ...;
 GroundOverlay groundOverlay = map.addGroundOverlay(new GroundOverlayOptions()
                .image(image)
                .positionFromBounds(new LatLngBounds(new LatLng(20, 140), new LatLng(40, 145))));
 
```

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

GroundOverlay(com.zdc.android.zms.maps.model.internal.IGroundOverlayDelegate delegate)

コンストラクタ
コンストラクタと説明
`GroundOverlay(com.zdc.android.zms.maps.model.internal.IGroundOverlayDelegate delegate)`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`boolean`	`equals(java.lang.Object obj)`
`float`	`getBearing()` オーバーレイの回転角度を取得する。
`LatLngBounds`	`getBounds()` オーバーレイのバウンディングボックスを取得する。
`float`	`getHeight()` オーバーレイの高さを取得する。
`java.lang.String`	`getId()` このオーバーレイのIDを取得する。
`LatLng`	`getPosition()` アンカーポイント(重心点)を取得する。
`float`	`getTransparency()` オーバーレイの透明性を取得する。
`float`	`getWidth()` オーバーレイの幅を取得する。
`int`	`getZIndex()` オーバーレイのzIndexを取得する。
`int`	`hashCode()`
`boolean`	`isClickable()` クリック可否を取得する。
`boolean`	`isVisible()` オーバーレイの可視性を取得する。
`void`	`remove()` 地図上からこのオーバーレイを削除する。
`void`	`setBearing(float bearing)` オーバーレイの回転角度を設定する。
`void`	`setClickable(boolean clickable)` クリック可否を設定する。
`void`	`setDimensions(float width)` オーバーレイの幅を設定する。
`void`	`setDimensions(float width, float height)` オーバーレイのサイズを設定する。
`void`	`setImage(android.graphics.Bitmap image)` オーバーレイ用の画像を設定する。
`void`	`setPosition(LatLng latLng)` オーバーレイの位置をアンカーポイント(重心点)で設定する。
`void`	`setPositionFromBounds(LatLngBounds bounds)` 与えられた`LatLngBounds`にフィットするようにして、オーバーレイの位置を設定する。
`void`	`setTransparency(float transparency)` このオーバーレイの透明度を設定する。
`void`	`setVisible(boolean visible)` オーバーレイの可視性を設定する。
`void`	`setZIndex(int zIndex)` オーバーレイのzIndexを設定する。

クラスから継承されたメソッド java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - GroundOverlay
```
public GroundOverlay(com.zdc.android.zms.maps.model.internal.IGroundOverlayDelegate delegate)
```
- メソッドの詳細
  - equals
```
public boolean equals(java.lang.Object obj)
```
    オーバーライド:
    
    equals クラス内 java.lang.Object
  - getBearing
```
public float getBearing()
```
    オーバーレイの回転角度を取得する。北から時計回りで単位は度。
    
    戻り値:
    
    オーバーレイの回転角度
  - getBounds
```
public LatLngBounds getBounds()
```
    オーバーレイのバウンディングボックスを取得する。
    設定されている回転角度は無視される。(回転した状態のバウンディングではない。)
    取得したオブジェクトへの変更は、オーバーレイに反映されない。
    
    戻り値:
    
    回転を無視したオーバーレイを含むLatLngBounds。
  - getHeight
```
public float getHeight()
```
    オーバーレイの高さを取得する。
    
    戻り値:
    
    オーバーレイの高さ(m)
  - getId
```
public java.lang.String getId()
```
    このオーバーレイのIDを取得する。 IDは地図上の全ての図形でユニーク。
    
    戻り値:
    
    オーバーレイのID
  - getPosition
```
public LatLng getPosition()
```
    アンカーポイント(重心点)を取得する。取得したオブジェクトへの変更は、オーバーレイに反映されない。
    
    戻り値:
    
    地図上の位置(LatLng)
  - getTransparency
```
public float getTransparency()
```
    オーバーレイの透明性を取得する。
    
    戻り値:
    
    オーバーレイの透明性
  - getWidth
```
public float getWidth()
```
    オーバーレイの幅を取得する。
    
    戻り値:
    
    オーバーレイの幅(m)
  - getZIndex
```
public int getZIndex()
```
    オーバーレイのzIndexを取得する。
    
    戻り値:
    
    オーバーレイのzIndex
  - hashCode
```
public int hashCode()
```
    オーバーライド:
    
    hashCode クラス内 java.lang.Object
  - isClickable
```
public boolean isClickable()
```
    クリック可否を取得する。
    
    戻り値:
    
    true可; false不可
  - isVisible
```
public boolean isVisible()
```
    オーバーレイの可視性を取得する。これは、画面上にあるかどうかを返すわけではなく、カメラのビューポートに含まれている場合に描画するかどうかを返す。
    
    戻り値:
    
    オーバーレイの可視性
  - remove
```
public void remove()
```
    地図上からこのオーバーレイを削除する。
  - setBearing
```
public void setBearing(float bearing)
```
    オーバーレイの回転角度を設定する。時計回りでアンカーポイント(重心点)を基準に回転する。
    
    パラメータ:
    
    bearing - オーバーレイの回転角度
  - setClickable
```
public void setClickable(boolean clickable)
```
    クリック可否を設定する。
    
    パラメータ:
    
    clickable - true可; false不可
  - setDimensions
```
public void setDimensions(float width)
```
    オーバーレイの幅を設定する。オーバーレイの高さはアスペクト比を維持するように、自動で調整される。
    
    パラメータ:
    
    width - 幅(m)
  - setDimensions
```
public void setDimensions(float width,
                          float height)
```
    オーバーレイのサイズを設定する。画像はサイズに合わせて伸縮される。
    
    パラメータ:
    
    width - 幅(m)
    
    height - 高(m)
  - setImage
```
public void setImage(android.graphics.Bitmap image)
```
    オーバーレイ用の画像を設定する。新しい画像は、古い画像と同じ範囲(幅高、位置)になる。
    オブジェクトは内部でコピーされる。
    
    パラメータ:
    
    image - 画像
  - setPosition
```
public void setPosition(LatLng latLng)
```
    オーバーレイの位置をアンカーポイント(重心点)で設定する。画像の他の全てのプロパティは保持する。
    オブジェクトは内部でコピーされる。
    
    パラメータ:
    
    latLng - 新しいアンカーポイント LatLng。
  - setPositionFromBounds
```
public void setPositionFromBounds(LatLngBounds bounds)
```
    与えられたLatLngBoundsにフィットするようにして、オーバーレイの位置を設定する。
    配置する際に回転は無視するが、描画時には回転して描画する。
    オブジェクトは内部でコピーされる。
    
    パラメータ:
    
    bounds - オーバーレイの場所 LatLngBounds。
  - setTransparency
```
public void setTransparency(float transparency)
```
    このオーバーレイの透明度を設定する。詳細はドキュメント上部参照。
    
    パラメータ:
    
    transparency - 透明度[0..1] 0:不透明, 1:透明
  - setVisible
```
public void setVisible(boolean visible)
```
    オーバーレイの可視性を設定する。 falseの時、オーバーレイは描画されない。
    
    パラメータ:
    
    visible - true表示; false非表示
  - setZIndex
```
public void setZIndex(int zIndex)
```
    オーバーレイのzIndexを設定する。詳細はドキュメント上部参照。
    
    パラメータ:
    
    zIndex - zIndex

クラス GroundOverlay

Code Example

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

GroundOverlay

メソッドの詳細

equals

getBearing

getBounds

getHeight

getId

getPosition

getTransparency

getWidth

getZIndex

hashCode

isClickable

isVisible

remove

setBearing

setClickable

setDimensions

setDimensions

setImage

setPosition

setPositionFromBounds

setTransparency

setVisible

setZIndex