※この翻訳ドキュメントはスクリプトによって出力・同期されています。内容が怪しそうな場合はGitHubにissueを追加したり英語の原文の確認をお願いします。

animation_fill_alpha インターフェイス

このページではanimation_fill_alphaメソッドのインターフェイスについて説明します。

インターフェイス概要

animation_fill_alphaメソッドのインターフェイスではAnimationBaseのサブクラスであり且つアニメーション設定を扱うap.AnimationFillAlphaクラスのインスタンスを生成します。そのインスタンスを使って塗りの透明度のアニメーションを設定することができます。

このインターフェイスはRectangleやCircleクラスなどのGraphicsBaseのサブクラスで存在します。

基本的な使い方

以下の例では1.0～0.0の塗りの透明度のアニメーションをanimation_fill_alphaメソッドで設定しています。

import apysc as ap

DURATION: int = 1000


def on_animation_complete_1(e: ap.AnimationEvent[ap.Rectangle], options: dict) -> None:
    """
    The handler that animation calls when its end.

    Parameters
    ----------
    e : AnimationEvent
        Event instance.
    options : dict
        Optional arguments dictionary.
    """
    rectangle: ap.Rectangle = e.this.target
    rectangle.animation_fill_alpha(
        alpha=1.0,
        duration=DURATION,
    ).animation_complete(on_animation_complete_2).start()


def on_animation_complete_2(e: ap.AnimationEvent[ap.Rectangle], options: dict) -> None:
    """
    The handler that animation calls when its end.

    Parameters
    ----------
    e : AnimationEvent
        Event instance.
    options : dict
        Optional arguments dictionary.
    """
    rectangle: ap.Rectangle = e.this.target
    rectangle.animation_fill_alpha(
        alpha=0.0,
        duration=DURATION,
    ).animation_complete(on_animation_complete_1).start()


ap.Stage(
    stage_width=150,
    stage_height=150,
    background_color=ap.Color("#333"),
    stage_elem_id="stage",
)
sprite: ap.Sprite = ap.Sprite()
sprite.graphics.begin_fill(color=ap.Color("#00aaff"))
rectangle: ap.Rectangle = sprite.graphics.draw_rect(x=50, y=50, width=50, height=50)
rectangle.animation_fill_alpha(
    alpha=0.0,
    duration=DURATION,
).animation_complete(on_animation_complete_1).start()

ap.save_overall_html(dest_dir_path="./animation_fill_alpha_basic_usage/")

animation_fill_alpha API

特記事項: このAPIドキュメントはドキュメントビルド用のスクリプトによって自動で生成・同期されています。そのためもしかしたらこの節の内容は前節までの内容と重複している場合があります。

[インターフェイスの構造] animation_fill_alpha(self, *, alpha: Union[float, apysc._type.number.Number], duration: Union[int, apysc._type.int.Int] = 3000, delay: Union[int, apysc._type.int.Int] = 0, easing: apysc._animation.easing.Easing = <Easing.LINEAR: 'function(x) {return x;}'>) -> apysc._animation.animation_fill_alpha.AnimationFillAlpha

[インターフェイス概要]

塗りの透明度のアニメーション設定を行います。

[引数]

  • alpha: Number or float

    • 透明度のアニメーションの最終値。

  • duration: Int or int, default 3000

    • アニメーション完了までのミリ秒。

  • delay: Int or int, default 0

    • アニメーション開始までの遅延時間のミリ秒。

  • easing: Easing, default Easing.LINEAR

    • イージング設定。

[返却値]

  • animation_fill_alpha: AnimationFillAlpha

    • 生成されたアニメーションのインスタンス。

[特記事項]

アニメーションを開始するには返却されたインスタンスのstartメソッドを呼び出す必要があります。

[コードサンプル]

>>> import apysc as ap
>>> stage: ap.Stage = ap.Stage()
>>> sprite: ap.Sprite = ap.Sprite()
>>> sprite.graphics.begin_fill(color=ap.Color("#0af"))
>>> circle: ap.Circle = sprite.graphics.draw_circle(x=100, y=100, radius=50)
>>> _ = circle.animation_y(
...     y=100,
...     duration=1500,
...     easing=ap.Easing.EASE_OUT_QUINT,
... ).start()

[関連資料]