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

Graphics クラスの draw_dashed_line インターフェイス

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

インターフェイス概要

draw_dashed_lineインターフェイスはシンプルな破線の直線のグラフィックスを描画します。このインターフェイスはdot_settingdash_settinground_dot_settingdash_dot_settingの引数や属性の設定を無視します。

基本的な使い方

draw_dashed_lineインターフェイスは基本的な線の座標の指定としてx_starty_startx_endy_endの各引数を持ちます。加えて、破線のサイズとしてのdash_size引数と破線間のスペースのサイズとしてのspace_size引数の指定が必要です。

import apysc as ap

ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=250,
    stage_height=130,
    stage_elem_id="stage",
)
sprite: ap.Sprite = ap.Sprite()

# Set 5-pixel dash setting and draw the line.
sprite.graphics.line_style(color=ap.Color("#0af"), thickness=2)
sprite.graphics.draw_dashed_line(
    x_start=50, y_start=50, x_end=200, y_end=50, dash_size=5, space_size=2
)

# Set 10-pixel dash setting and draw the line.
sprite.graphics.draw_dashed_line(
    x_start=50, y_start=80, x_end=200, y_end=80, dash_size=10, space_size=2
)

ap.save_overall_html(dest_dir_path="graphics_draw_dashed_line_basic_usage/")

draw_dashed_line API

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

[インターフェイスの構造] draw_dashed_line(self, *, x_start: Union[float, apysc._type.number.Number], y_start: Union[float, apysc._type.number.Number], x_end: Union[float, apysc._type.number.Number], y_end: Union[float, apysc._type.number.Number], dash_size: Union[int, apysc._type.int.Int], space_size: Union[int, apysc._type.int.Int], variable_name_suffix: str = '') -> '_line.Line'


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

破線のベクターグラフィックスを描画します。


[引数]

  • x_start: float or Number

    • 線の開始位置のX座標。

  • y_start: float or Number

    • 線の開始位置のY座標。

  • x_end: float or Number

    • 線の終了位置のX座標。

  • y_end: float or Number

    • 線の終了位置のY座標。

  • dash_size: Int or int

    • 破線部分のサイズ。

  • space_size: Int or int

    • 破線間の空白スペースのサイズ。

  • variable_name_suffix: str, default “”

    • JavaScript上の変数のサフィックスの設定です。この設定はJavaScriptのデバッグ時に役立つことがあります。


[返却値]

  • line: Line

    • 生成された線のグラフィックスのインスタンス。


[特記事項]

・このインターフェイスはLineDashSettingを除いたLineDotSettingなどの線のスタイル設定を無視します。


[コードサンプル]

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

>>> line.line_dash_setting.dash_size
Int(5)

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