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

GraphicsBase クラスの line_dash_setting インターフェイス

このページではGraphicsBaseクラスのline_dash_setting属性のインターフェイスについて説明します。

インターフェイス概要

line_dash_setting

基本的な使い方

getterとsetterのインターフェイスの値はLineDashSettingインスタンスの値となります。

以下のコード例では線に対して10pxの破線と3pxの破線間の空白のスペースを設定しています。

import apysc as ap

ap.Stage(
    stage_width=250,
    stage_height=100,
    background_color=ap.Color("#333"),
    stage_elem_id="stage",
)
sprite: ap.Sprite = ap.Sprite()
sprite.graphics.line_style(color=ap.Color("#0af"), thickness=5)

line: ap.Line = sprite.graphics.draw_line(x_start=50, y_start=50, x_end=200, y_end=50)
line.line_dash_setting = ap.LineDashSetting(dash_size=10, space_size=3)

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

設定の削除

delete_line_dash_settingインターフェイスはこの線の設定を削除します。

以下の例では四角をクリックするとハンドラ内の処理で線の設定を削除しています:

import apysc as ap


def on_click(e: ap.MouseEvent[ap.Rectangle], options: dict) -> None:
    """
    The handler for the click event.

    Parameters
    ----------
    e : ap.MouseEvent[ap.Rectangle]
        Event instance.
    options : dict
        Optional argument dictionary.
    """
    rectangle: ap.Rectangle = e.this
    rectangle.delete_line_dash_setting()


ap.Stage(
    stage_width=150,
    stage_height=150,
    background_color=ap.Color("#333"),
    stage_elem_id="stage",
)
rectangle: ap.Rectangle = ap.Rectangle(
    x=50,
    y=50,
    width=50,
    height=50,
    fill_color=ap.Color("#666"),
    line_color=ap.Color("#fff"),
    line_thickness=2,
    line_dash_setting=ap.LineDashSetting(dash_size=4, space_size=2),
)
rectangle.click(handler=on_click)

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

line_dash_setting 属性のAPI

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

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

現在の線の破線のスタイル設定を取得します。

[返却値]

  • line_dash_setting: LineDashSetting or None

    • 線の破線のスタイル設定。

[コードサンプル]

>>> import apysc as ap
>>> stage: ap.Stage = ap.Stage()
>>> sprite: ap.Sprite = ap.Sprite()
>>> sprite.graphics.line_style(color=ap.Color("#fff"), thickness=10)
>>> line: ap.Line = sprite.graphics.draw_line(
...     x_start=50, y_start=50, x_end=150, y_end=50
... )
>>> line.line_dash_setting = ap.LineDashSetting(dash_size=5, space_size=2)
>>> line.line_dash_setting.dash_size
Int(5)

>>> line.line_dash_setting.space_size
Int(2)

delete_line_dash_setting のAPI

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

[インターフェイスの構造] delete_line_dash_setting(self) -> None

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

現在の破線の設定を削除します。