com.nttdocomo.opt.ui
クラス Sprite

Object
  |
  +--com.nttdocomo.opt.ui.Sprite

推奨されていません。 スプライトを使用する場合は基本 API の com.nttdocomo.ui.Sprite クラスを使用してください。

public class Sprite
extends Object

スプライトを定義します。 スプライトは、表示するイメージと表示する位置をもつオブジェクトです。 スプライトオブジェクトにイメージオブジェクトを指定することができますが、引数で渡されたイメージオブジェクトの参照をスプライトオブジェクトが保持します。引数で渡されたイメージオブジェクトを変更するスプライトオブジェクトにも影響します。(イメージオブジェクト設定後に、イメージオブジェクトを破棄してはいけません。)

端末によってサポートされていない場合があります。未サポートの場合、メソッドが呼び出された時点でUnsupportedOperationExceptionを発生します。

導入されたバージョン:
DoJa-2.0
関連項目:
SpriteSet

コンストラクタの概要
protected Sprite()
          推奨されていません。  アプリケーションが直接このコンストラクタを呼び出してオブジェクトを生成することはできません。
  Sprite(com.nttdocomo.ui.Image image)
          推奨されていません。  イメージを指定してスプライトオブジェクトを生成します。
  Sprite(com.nttdocomo.ui.Image image, int x, int y, int width, int height)
          推奨されていません。  イメージの一部を指定してスプライトオブジェクトを生成します。
 
メソッドの概要
 int getHeight()
          推奨されていません。  スプライトの高さを取得します。
 int getWidth()
          推奨されていません。  スプライトの幅を取得します。
 int getX()
          推奨されていません。  スプライトを表示する位置の X 座標を取得します。
 int getY()
          推奨されていません。  スプライトを表示する位置の Y 座標を取得します。
 boolean isVisible()
          推奨されていません。  スプライトが可視かどうかを取得します。
 void setFlipMode(int flipMode)
          推奨されていません。  スプライトを反転表示するかどうか設定します。
 void setImage(com.nttdocomo.ui.Image image)
          推奨されていません。  スプライトのイメージを設定します。
 void setImage(com.nttdocomo.ui.Image image, int x, int y, int width, int height)
          推奨されていません。  スプライトのイメージを設定します。
 void setLocation(int x, int y)
          推奨されていません。  スプライトを表示する位置を設定します。
 void setRenderMode(int operator, int srcRatio, int dstRatio)
          推奨されていません。  スプライトの演算を設定します。
 void setVisible(boolean b)
          推奨されていません。  スプライトが可視かどうかを設定します。
 
クラス Object から継承したメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

Sprite

protected Sprite()
推奨されていません。 
アプリケーションが直接このコンストラクタを呼び出してオブジェクトを生成することはできません。


Sprite

public Sprite(com.nttdocomo.ui.Image image)
推奨されていません。 
イメージを指定してスプライトオブジェクトを生成します。 デフォルトでは表示位置(0, 0)の可視状態に初期化されます。

パラメータ:
image - イメージを指定します。

Sprite

public Sprite(com.nttdocomo.ui.Image image,
              int x,
              int y,
              int width,
              int height)
推奨されていません。 
イメージの一部を指定してスプライトオブジェクトを生成します。 デフォルトでは表示位置(0, 0)の可視状態に初期化されます。

パラメータ:
image - イメージを指定します。
x - スプライトとして使用するイメージの一部の矩形の左上の X 座標を指定します。
y - スプライトとして使用するイメージの一部の矩形の左上の Y 座標を指定します。
width - スプライトとして使用するイメージの一部の矩形の幅を指定します。
height - スプライトとして使用するイメージの一部の矩形の高さを指定します。
例外:
IllegalArgumentException - 引数 width, height のどちらかまたは両方に 0 未満の値が指定された場合に発生します。
メソッドの詳細

setLocation

public void setLocation(int x,
                        int y)
推奨されていません。 
スプライトを表示する位置を設定します。

パラメータ:
x - 表示する位置のX座標を指定します。
y - 表示する位置のY座標を指定します。

setImage

public void setImage(com.nttdocomo.ui.Image image)
推奨されていません。 
スプライトのイメージを設定します。

パラメータ:
image - イメージを指定します。
例外:
NullPointerException - 引数の image に null が指定された場合に発生します。

setImage

public void setImage(com.nttdocomo.ui.Image image,
                     int x,
                     int y,
                     int width,
                     int height)
推奨されていません。 
スプライトのイメージを設定します。 なお、本メソッドを呼び出しても、Sprite#setFlipMode(int)、Sprite#setRenderMode(int, int, int)による設定値は変更されません。 また、imageの領域外にはみ出すような矩形領域を指定した場合の描画のクリッピング方法および衝突判定の対象領域は、機種依存です。

パラメータ:
image - イメージを指定します。
x - スプライトとして使用するイメージの一部の矩形の左上の X 座標を指定します。
y - スプライトとして使用するイメージの一部の矩形の左上の Y 座標を指定します。
width - スプライトとして使用するイメージの一部の矩形の幅を指定します。
height - スプライトとして使用するイメージの一部の矩形の高さを指定します。
例外:
NullPointerException - 引数 image に null が指定された場合に発生します。
IllegalArgumentException - 引数 width, height のどちらかまたは両方に 0 未満の値が指定された場合に発生します。

setVisible

public void setVisible(boolean b)
推奨されていません。 
スプライトが可視かどうかを設定します。

パラメータ:
b - 可視にする場合は true を、不可視にする場合は false を指定します。

isVisible

public boolean isVisible()
推奨されていません。 
スプライトが可視かどうかを取得します。

戻り値:
可視な場合は true を、不可視な場合は false を返します。

setFlipMode

public void setFlipMode(int flipMode)
推奨されていません。 
スプライトを反転表示するかどうか設定します。

パラメータ:
flipMode - 反転モードを指定します。 Graphics2.FLIP_NONE, Graphics2.FLIP_HORIZONTAL, Graphics2.FLIP_VERTICAL, Graphics2.FLIP_ROTATE の いずれかを指定します。
例外:
IllegalArgumentException - 引数 flipmode に不正な値が指定された場合に発生します。

setRenderMode

public void setRenderMode(int operator,
                          int srcRatio,
                          int dstRatio)
推奨されていません。 
スプライトの演算を設定します。 詳細については Graphics2.setRenderMode(int, int, int) を参照してください。

パラメータ:
operator - 演算方法を指定します。 Graphics2.OP_REPL, Graphics2.OP_ADD, Graphics2.OP_SUB のいずれかを指定します。
srcRatio - ソースピクセルの乗数を0から255の範囲で指定します。255が1.0に対応する固定小数表現となります。
dstRatio - デスティネーションピクセルの乗数を0から255の範囲で指定します。255が1.0に対応する固定小数表現となります。
例外:
IllegalArgumentException - 引数 operator に不正な値が指定された場合に発生します。
IllegalArgumentException - 引数 srcRatio, dstRatio に不正な値が指定された場合に発生します。

getX

public int getX()
推奨されていません。 
スプライトを表示する位置の X 座標を取得します。

戻り値:
スプライトのX座標を返します。

getY

public int getY()
推奨されていません。 
スプライトを表示する位置の Y 座標を取得します。

戻り値:
スプライトのY座標を返します。

getWidth

public int getWidth()
推奨されていません。 
スプライトの幅を取得します。 Sprite#Sprite(Image)あるいはSprite#setImage(Image)で設定されたスプライトの場合はイメージの幅が、Sprite#Sprite(Image, int, int, int, int)あるいはSprite#setImage(Image, int, int, int, int)で設定されたスプライトの場合は指定矩形領域の幅が、スプライトの幅となります。 これは、SpriteSetの衝突判定の対象となる矩形領域の幅と一致します。

戻り値:
スプライトの幅を返します。

getHeight

public int getHeight()
推奨されていません。 
スプライトの高さを取得します。 Sprite#Sprite(Image)あるいはSprite#setImage(Image)で設定されたスプライトの場合はイメージの高さが、Sprite#Sprite(Image, int, int, int, int)あるいはSprite#setImage(Image, int, int, int, int)で設定されたスプライトの場合は指定矩形領域の高さが、スプライトの高さとなります。 これは、SpriteSetの衝突判定の対象となる矩形領域の高さと一致します。

戻り値:
スプライトの高さを返します。


NTT DoCoMo,Inc.

本製品または文書は著作権法により保護されており、その使用、複製、再頒布および逆コンパイルを制限するライセンスのもとにおいて頒布されます。NTTドコモ(その他に許諾者がある場合は当該許諾者も含めて)の書面による事前の許可なく、本製品および関連する文書のいかなる部分も、いかなる方法によっても複製することが禁じられます。フォントを含む第三者のソフトウェアは、著作権法により保護されており、その提供者からライセンスを受けているものです。

Sun、Sun Microsystems、Java、J2MEおよびJ2SEは、米国およびその他の国における米国 Sun Microsystems,Inc.の商標または登録商標です。サンのロゴマークは、米国 Sun Microsystems, Inc.の登録商標です。

「iモード」、「iアプリ/アイアプリ」、「i-αppli」ロゴ、「DoJa」はNTTドコモの商標または登録商標です。