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

delete インターフェイス

このページではdelete関数のインターフェイスについて説明します。

インターフェイス概要

delete関数は任意のインスタンスの削除を行います。削除された対象はundefinedのオブジェクトになります。

もし対象のインスタンスがDisplayObjectのインスタンスであれば、このインターフェイスはそのインスタンスをステージから取り除きます。

例えばSpriteやRectangleなどのインスタンスであればこのインターフェイスはそれらのインスタンスを取り除きます。

基本的な使い方

delete関数の引数へは任意のapyscのインスタンスを指定することができます。

import apysc as ap

ap.Stage()
int_val: ap.Int = ap.Int(10)
ap.delete(int_val)

もし指定されたインスタンスがDisplayObjectのインスタンスであれば、delete関数はそのインスタンスをステージから取り除きます。

また、削除されたインスタンスはundefinedのオブジェクトになります。

import apysc as ap


def on_click(e: ap.MouseEvent[ap.Sprite], options: dict) -> None:
    """
    The click event handler that a sprite calls.

    Parameters
    ----------
    e : ap.MouseEvent[ap.Sprite]
        Event instance.
    options : dict
        Optional arguments dictionary.
    """
    sprite: ap.Sprite = e.this
    ap.delete(sprite)
    ap.assert_undefined(sprite)


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("#0af"))
sprite.graphics.draw_rect(x=50, y=50, width=50, height=50)
sprite.click(on_click)

ap.save_overall_html(dest_dir_path="delete_basic_usage/")

もし以下の四角をクリックすると、delete関数は対象のインスタンスをステージから取り除きます。