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

Timer クラス

このページではTimerクラスについて説明します。

Timer クラスの概要

Timerクラスは一定間隔で処理を実行するためのタイマーの処理を扱います。任意の間隔を設定してハンドラの呼び出し設定を追加することができます。

基本的な使い方

Timerクラスはコンストラクタでハンドラとしてのhandler引数とタイマー実行間隔のミリ秒としてのdelay引数の指定を必要とします。そしてstartメソッドを呼び出すとタイマーがスタートします。タイマーはTimerEventクラスのインスタンスとオプションとして指定できる追加のパラメーターの引数をハンドラへ渡します。

以下のコード例では四角（Sprite）をクリックした際にTimerクラスを使用した設定を行っています:

from typing_extensions import TypedDict

import apysc as ap


class _RectOptions(TypedDict):
    rectangle: ap.Rectangle


def on_sprite_click(e: ap.MouseEvent[ap.Sprite], options: _RectOptions) -> None:
    """
    The Handler that the rectangle calls when clicked.

    Parameters
    ----------
    e : MouseEvent
        Event instance.
    options : dict
        Optional arguments dictionary.
    """
    e.this.unbind_click_all()
    timer: ap.Timer = ap.Timer(on_timer, delay=16.6, options=options)
    timer.start()


def on_timer(e: ap.TimerEvent, options: _RectOptions) -> None:
    """
    The Handler a timer calls.

    Parameters
    ----------
    e : TimerEvent
        Event instance.
    options : dict
        Optional arguments dictionary.
    """
    rectangle: ap.Rectangle = options["rectangle"]
    rectangle.x += 1


ap.Stage(
    stage_width=350,
    stage_height=150,
    background_color=ap.Color("#333"),
    stage_elem_id="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)
options: _RectOptions = {"rectangle": rectangle}
sprite.click(on_sprite_click, options=options)

ap.save_overall_html(dest_dir_path="timer_basic_usage/")

四角をクリックするとタイマーがスタートし、タイマーのハンドラは四角のX座標を加算していきます。

関連資料

Timer クラスのコンストラクタのAPI

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

[インターフェイスの構造] __init__(self, handler: Callable[[ForwardRef('TimerEvent'), ~_ConstructorOptions], NoneType], *, delay: Union[int, float, apysc._type.number_value_mixin.NumberValueMixIn, apysc._time.fps.FPS], repeat_count: Union[int, apysc._type.int.Int] = 0, options: Union[~_ConstructorOptions, NoneType] = None) -> None

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

一定間隔ごとにハンドラの関数を実行するためのタイマーのクラスです。

[引数]

  • handler: _Handler

    • 一定間隔ごとに呼ばれる関数もしくはメソッドのハンドラ。

  • delay: Int or int or Number or float or FPS

    • ハンドラの実行間隔となるミリ秒もしくはFPSのenumの値。もしFPSの値が指定された場合、FPSに応じて計算されたミリ秒が設定されます（例えば、もしFPS_60が指定されていればdelayの値は16.6666667ミリ秒相当になります。）。

  • repeat_count: Int or int

    • ハンドラの実行回数の上限値。ハンドラの実行回数がこの値に到達した場合タイマーは停止します。もし0が指定された場合にはタイマーは停止しなくなります。

  • options: dict or None, default None

    • ハンドラの関数もしくはメソッドへ渡すオプションとしての各パラメーターを格納した辞書。

[コードサンプル]

>>> from typing_extensions import TypedDict
>>> import apysc as ap
>>> _ = ap.Stage()
>>> class RectOptions(TypedDict):
...     rectangle: ap.Rectangle
...
>>> def on_timer(e: ap.TimerEvent, options: RectOptions) -> None:
...     rectangle: ap.Rectangle = options["rectangle"]
...     rectangle.x += 1
>>> 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
... )
>>> options: RectOptions = {"rectangle": rectangle}
>>> _ = ap.Timer(on_timer, delay=ap.FPS.FPS_60, options=options).start()

[関連資料]