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

animation_x インターフェイス

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

インターフェイス概要

animation_xメソッドのインターフェイスはAnimationXのインスタンスを生成します。そのインスタンスを使ってX座標のアニメーションを設定することができます。

このインターフェイスはSpriteやRectangleなどのDisplayObjectの各サブクラスに存在します。

基本的な使い方

以下の例ではanimation_xメソッドを使ってX座標（50から100）のアニメーションを設定しています。

import apysc as ap

EASING: ap.Easing = ap.Easing.EASE_OUT_QUINT
DURATION: int = 1000


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

    Parameters
    ----------
    e : ap.AnimationEvent
        Event instance.
    options : dict
        Optional arguments dictionary.
    """
    rectangle: ap.Rectangle = e.this.target
    animation_x: ap.AnimationX = rectangle.animation_x(
        x=50, duration=DURATION, easing=EASING
    )
    animation_x.animation_complete(on_animation_complete_2)
    animation_x.start()


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

    Parameters
    ----------
    e : ap.AnimationEvent
        Event instance.
    options : dict
        Optional arguments dictionary.
    """
    rectangle: ap.Rectangle = e.this.target
    animation_x: ap.AnimationX = rectangle.animation_x(
        x=100, duration=DURATION, easing=EASING
    )
    animation_x.animation_complete(on_animation_complete_1)
    animation_x.start()


ap.Stage(
    stage_width=200,
    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)
animation_x: ap.AnimationX = rectangle.animation_x(
    x=100, duration=DURATION, easing=EASING
)
animation_x.animation_complete(on_animation_complete_1)
animation_x.start()

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

Circle と Ellipse の各クラスの特記事項

内部実装が異なるためCircleとEllipseの各クラスのanimation_xインターフェイスはAnimationXの代わりにAnimationCxクラス（center x）のインスタンスを返却します。

import apysc as ap

ap.Stage(
    stage_width=200,
    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"))
circle: ap.Circle = sprite.graphics.draw_circle(x=100, y=100, radius=50)
animation_cx: ap.AnimationCx = circle.animation_x(
    x=100, duration=1000, easing=ap.Easing.EASE_OUT_QUINT
)

animation_x API

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

[インターフェイスの構造] animation_x(self, *, x: 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_x.AnimationX

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

X座標のアニメーションを設定します。

[引数]

  • x: float or Number

    • 最終的なX座標。

  • duration: Int or int, default 3000

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

  • delay: Int or int, default 0

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

  • easing: Easing, default Easing.LINEAR

    • イージング設定。

[返却値]

  • animation_x: AnimationX

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

[特記事項]

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

[コードサンプル]

>>> import apysc as ap
>>> stage: ap.Stage = ap.Stage()
>>> sprite: ap.Sprite = ap.Sprite()
>>> sprite.graphics.begin_fill(color=ap.Color("#0af"))
>>> rectangle: ap.Rectangle = sprite.graphics.draw_rect(
...     x=50, y=50, width=50, height=50
... )
>>> _ = rectangle.animation_x(
...     x=100,
...     duration=1500,
...     easing=ap.Easing.EASE_OUT_QUINT,
... ).start()

[関連資料]