このページは Cloud Translation API によって翻訳されました。

カスタム図形描画を作成する

カスタムビューの最も重要な要素は外観です。カスタム描画は、アプリケーションのニーズに応じて簡単なものでも複雑なものでもかまいません。このドキュメントでは、最も一般的なオペレーションの一部について説明します。

詳細については、ドローアブルの概要をご覧ください。

onDraw() をオーバーライドする

カスタムビューの描画で最も重要なステップは、onDraw() メソッドをオーバーライドすることです。onDraw() へのパラメータは、ビューが自身を描画するために使用できる Canvas オブジェクトです。Canvas クラスは、テキスト、線、ビットマップ、その他多くのグラフィックプリミティブを描画するためのメソッドを定義します。onDraw() でこれらのメソッドを使用して、カスタムユーザーインターフェース（UI）を作成できます。

まず、Paint オブジェクトを作成します。次のセクションでは、Paint について説明します。

描画オブジェクトを作成する

android.graphics フレームワークでは、描画は 2 つの領域に分割されています。

何を描画するか（Canvas によって処理）。
どのように描画するか（処理担当は Paint）

たとえば、Canvas は線を描画するメソッドを提供し、Paint はその線の色を定義するメソッドを提供します。Canvas には長方形を描画するメソッドがあり、Paint は長方形を色で塗りつぶすか空のままにするかを定義します。Canvas は画面上に描画できる図形を定義し、Paint は描画する各図形の色、スタイル、フォントなどを定義します。

何かを描画する前に、1 つ以上の Paint オブジェクトを作成します。次の例では、init というメソッドでこの処理を行っています。このメソッドは Java のコンストラクタから呼び出されますが、Kotlin ではインラインで初期化できます。

Kotlin

@ColorInt
private var textColor    // Obtained from style attributes.

@Dimension
private var textHeight   // Obtained from style attributes.

private val textPaint = Paint(ANTI_ALIAS_FLAG).apply {
    color = textColor
    if (textHeight == 0f) {
        textHeight = textSize
    } else {
        textSize = textHeight
    }
}

private val piePaint = Paint(Paint.ANTI_ALIAS_FLAG).apply {
    style = Paint.Style.FILL
    textSize = textHeight
}

private val shadowPaint = Paint(0).apply {
    color = 0x101010
    maskFilter = BlurMaskFilter(8f, BlurMaskFilter.Blur.NORMAL)
}

Java

private Paint textPaint;
private Paint piePaint;
private Paint shadowPaint;

@ColorInt
private int textColor;       // Obtained from style attributes.

@Dimension
private float textHeight;    // Obtained from style attributes.

private void init() {
   textPaint = new Paint(Paint.ANTI_ALIAS_FLAG);
   textPaint.setColor(textColor);
   if (textHeight == 0) {
       textHeight = textPaint.getTextSize();
   } else {
       textPaint.setTextSize(textHeight);
   }

   piePaint = new Paint(Paint.ANTI_ALIAS_FLAG);
   piePaint.setStyle(Paint.Style.FILL);
   piePaint.setTextSize(textHeight);

   shadowPaint = new Paint(0);
   shadowPaint.setColor(0xff101010);
   shadowPaint.setMaskFilter(new BlurMaskFilter(8, BlurMaskFilter.Blur.NORMAL));
   ...
}

事前にオブジェクトを作成することは、最適化するうえで重要です。ビューは頻繁に再描画され、多くの描画オブジェクトではコストの高い初期化が必要になります。onDraw() メソッド内で描画オブジェクトを作成すると、パフォーマンスが大幅に低下し、UI の動作が遅くなることがあります。

レイアウトイベントを処理する

カスタムビューを適切に描画するには、そのサイズを確認します。複雑なカスタムビューでは、多くの場合、画面上の領域のサイズと形状に応じて、複数のレイアウト計算を実行する必要があります。画面上のビューのサイズについては、決して想定しないでください。1 つのアプリだけがビューを使用する場合でも、そのアプリは、縦向きモードと横向きモードの両方で、さまざまな画面サイズ、複数の画面密度、さまざまなアスペクト比を処理する必要があります。

View には測定を処理する多くのメソッドがありますが、そのほとんどはオーバーライドする必要はありません。ビューのサイズを特別な制御する必要がない場合は、onSizeChanged() メソッドのみをオーバーライドします。

onSizeChanged() は、ビューに最初にサイズが割り当てられたときに呼び出されます。また、ビューのサイズがなんらかの理由で変更されたときにも呼び出されます。描画のたびに再計算するのではなく、onSizeChanged() でビューのサイズに関連する位置、寸法、その他の値を計算します。次の例の onSizeChanged() では、ビューはグラフの境界四角形と、テキストラベルとその他の視覚要素の相対位置を計算します。

ビューにサイズが割り当てられると、レイアウトマネージャーは、そのサイズにビューのパディングが含まれると想定します。ビューのサイズを計算するときに、このパディング値を処理します。次の onSizeChanged() のスニペットは、これを行う方法を示しています。

Kotlin

private val showText    // Obtained from styled attributes.
private val textWidth   // Obtained from styled attributes.

override fun onSizeChanged(w: Int, h: Int, oldw: Int, oldh: Int) {
    super.onSizeChanged(w, h, oldw, oldh)
    // Account for padding.
    var xpad = (paddingLeft + paddingRight).toFloat()
    val ypad = (paddingTop + paddingBottom).toFloat()

    // Account for the label.
    if (showText) xpad += textWidth.toFloat()
    val ww = w.toFloat() - xpad
    val hh = h.toFloat() - ypad

    // Figure out how big you can make the pie.
    val diameter = Math.min(ww, hh)
}

Java

private Boolean showText;    // Obtained from styled attributes.
private int textWidth;       // Obtained from styled attributes.

@Override
protected void onSizeChanged(int w, int h, int oldw, int oldh) {
    super.onSizeChanged(w, h, oldw, oldh);
    // Account for padding.
    float xpad = (float)(getPaddingLeft() + getPaddingRight());
    float ypad = (float)(getPaddingTop() + getPaddingBottom());

    // Account for the label.
    if (showText) xpad += textWidth;

    float ww = (float)w - xpad;
    float hh = (float)h - ypad;

    // Figure out how big you can make the pie.
    float diameter = Math.min(ww, hh);
}

ビューのレイアウトパラメータをより細かく制御する必要がある場合は、onMeasure() を実装します。このメソッドのパラメータは、ビューの親がビューに求めるサイズと、そのサイズが厳格な上限か単なる提案かを示す View.MeasureSpec 値です。最適化として、これらの値はパックされた整数として格納され、View.MeasureSpec の静的メソッドを使用して各整数に格納された情報を展開します。

onMeasure() の実装例を次に示します。この実装では、グラフがラベルと同じ大きさになるように領域を拡大しようとします。

Kotlin

override fun onMeasure(widthMeasureSpec: Int, heightMeasureSpec: Int) {
    // Try for a width based on your minimum.
    val minw: Int = paddingLeft + paddingRight + suggestedMinimumWidth
    val w: Int = View.resolveSizeAndState(minw, widthMeasureSpec, 1)

    // Whatever the width is, ask for a height that lets the pie get as big as
    // it can.
    val minh: Int = View.MeasureSpec.getSize(w) - textWidth.toInt() + paddingBottom + paddingTop
    val h: Int = View.resolveSizeAndState(minh, heightMeasureSpec, 0)

    setMeasuredDimension(w, h)
}

Java

@Override
protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
   // Try for a width based on your minimum.
   int minw = getPaddingLeft() + getPaddingRight() + getSuggestedMinimumWidth();
   int w = resolveSizeAndState(minw, widthMeasureSpec, 1);

   // Whatever the width is, ask for a height that lets the pie get as big as it
   // can.
   int minh = MeasureSpec.getSize(w) - (int)textWidth + getPaddingBottom() + getPaddingTop();
   int h = resolveSizeAndState(minh, heightMeasureSpec, 0);

   setMeasuredDimension(w, h);
}

このコードには、3 つの重要な注意点があります。

計算では、ビューのパディングが考慮されます。前述のように、これはビューが行います。
ヘルパーメソッド resolveSizeAndState() を使用して、最終的な幅と高さの値を作成します。このヘルパーは、ビューに必要なサイズと onMeasure() に渡された値を比較して、適切な View.MeasureSpec 値を返します。
onMeasure() は戻り値を返しません。代わりに、このメソッドは setMeasuredDimension() を呼び出して結果を伝えます。このメソッドを呼び出す必要があります。この呼び出しを省略すると、View クラスはランタイム例外をスローします。

引き分け

オブジェクトの作成と測定コードを定義したら、onDraw() を実装できます。ビューごとに onDraw() の実装方法が異なりますが、ほとんどのビューで共通するオペレーションがいくつかあります。

drawText() を使用してテキストを描画します。setTypeface() を呼び出して書体を指定し、setColor() を呼び出してテキストの色を指定します。
drawRect()、drawOval()、drawArc() を使用して、プリミティブな図形を描画します。図形の塗りつぶし、枠線、またはその両方を変更するには、setStyle() を呼び出します。
Path クラスを使用して、より複雑な図形を描画します。Path オブジェクトに線と曲線を追加してシェイプを定義し、drawPath() を使用してシェイプを描画します。プリミティブ図形と同様に、setStyle() に応じて、パスの枠線、塗りつぶし、またはその両方を行うことができます。
LinearGradient オブジェクトを作成して、グラデーションの塗りつぶしを定義します。塗りつぶしシェイプで LinearGradient を使用するには、setShader() を呼び出します。
drawBitmap() を使用してビットマップを描画します。

次のコードは、テキスト、線、図形を組み合わせて描画します。

Kotlin

private val data = mutableListOf<Item>() // A list of items that are displayed.

private var shadowBounds = RectF()       // Calculated in onSizeChanged.
private var pointerRadius: Float = 2f    // Obtained from styled attributes.
private var pointerX: Float = 0f         // Calculated in onSizeChanged.
private var pointerY: Float = 0f         // Calculated in onSizeChanged.
private var textX: Float = 0f            // Calculated in onSizeChanged.
private var textY: Float = 0f            // Calculated in onSizeChanged.
private var bounds = RectF()             // Calculated in onSizeChanged.
private var currentItem: Int = 0         // The index of the currently selected item.

override fun onDraw(canvas: Canvas) {
    super.onDraw(canvas)

    canvas.apply {
        // Draw the shadow.
        drawOval(shadowBounds, shadowPaint)

        // Draw the label text.
        drawText(data[currentItem].label, textX, textY, textPaint)

        // Draw the pie slices.
        data.forEach {item ->
            piePaint.shader = item.shader
            drawArc(
                bounds,
                360 - item.endAngle,
                item.endAngle - item.startAngle,
                true,
                piePaint
            )
        }

        // Draw the pointer.
        drawLine(textX, pointerY, pointerX, pointerY, textPaint)
        drawCircle(pointerX, pointerY, pointerRadius, textPaint)
    }
}

// Maintains the state for a data item.
private data class Item(
    var label: String,      
    var value: Float = 0f,

    @ColorInt
    var color: Int = 0,

    // Computed values.
    var startAngle: Float = 0f,
    var endAngle: Float = 0f,

    var shader: Shader
)

Java

private List<Item> data = new ArrayList<Item>();  // A list of items that are displayed.

private RectF shadowBounds;                       // Calculated in onSizeChanged.
private float pointerRadius;                      // Obtained from styled attributes.
private float pointerX;                           // Calculated in onSizeChanged.
private float pointerY;                           // Calculated in onSizeChanged.
private float textX;                              // Calculated in onSizeChanged.
private float textY;                              // Calculated in onSizeChanged.
private RectF bounds;                             // Calculated in onSizeChanged.
private int currentItem = 0;                      // The index of the currently selected item.

protected void onDraw(Canvas canvas) {
    super.onDraw(canvas);

    // Draw the shadow.
    canvas.drawOval(
            shadowBounds,
            shadowPaint
    );

    // Draw the label text.
    canvas.drawText(data.get(currentItem).label, textX, textY, textPaint);

    // Draw the pie slices.
    for (int i = 0; i < data.size(); ++i) {
        Item it = data.get(i);
        piePaint.setShader(it.shader);
        canvas.drawArc(
                bounds,
                360 - it.endAngle,
                it.endAngle - it.startAngle,
                true, 
                piePaint
        );
    }

    // Draw the pointer.
    canvas.drawLine(textX, pointerY, pointerX, pointerY, textPaint);
    canvas.drawCircle(pointerX, pointerY, pointerRadius, textPaint);
}

// Maintains the state for a data item.
private class Item {
    public String label;
    public float value;
    @ColorInt
    public int color;

    // Computed values.
    public int startAngle;
    public int endAngle;

    public Shader shader;
}

グラフィック効果を適用する

Android 12（API レベル 31）では、ぼかし、カラーフィルタ、Android シェーダー効果などの一般的なグラフィック効果を View オブジェクトとレンダリング階層に適用する RenderEffect クラスが追加されています。エフェクトは、内部エフェクトと外部エフェクトで構成されるチェーン効果、またはブレンド効果として組み合わせることができます。この機能のサポートは、デバイスの処理能力によって異なります。

View.setRenderEffect(RenderEffect) を呼び出して、View の基になる RenderNode に効果を適用することもできます。

RenderEffect オブジェクトを実装する手順は次のとおりです。

view.setRenderEffect(RenderEffect.createBlurEffect(radiusX, radiusY, SHADER_TILE_MODE))

ビューは、プログラムで作成することも、XML レイアウトからインフレートして、ビューバインディングまたは findViewById() を使用して取得することもできます。

カスタム図形描画を作成する

onDraw() をオーバーライドする

描画オブジェクトを作成する

Kotlin

Java

レイアウト イベントを処理する

Kotlin

Java

Kotlin

Java

引き分け

Kotlin

Java

グラフィック効果を適用する

レイアウトイベントを処理する