※この翻訳ドキュメントはスクリプトによって出力・同期されています。内容が怪しそうな場合はGitHubにissueを追加したり英語の原文の確認をお願いします。
PathVertical クラス¶
このページではPathVerticalクラスについて説明します。
クラス概要¶
PathVerticalクラスはパス上に新しい垂直の直線の設定を追加するためのクラスです。
この設定はもし垂直方向の線の描画のみが必要で水平方向の座標設定が不要な場合にコードの記述をシンプルにします。
主にこの設定はPathクラスのコンストラクタとdraw_pathメソッドのインターフェイスで使用されます。
基本的な使い方¶
PathVerticalクラスのコンストラクタではyの引数指定のみ必要とします。
Pathクラスのコンストラクタもしくはdraw_pathメソッドのインターフェイスのpath_data_list引数でそのインスタンスが必要とされます。
以下のコード例ではy=50の座標からy=150の座標に向けて垂直の直線を描画しています:
import apysc as ap
ap.Stage(
background_color=ap.Color("#333"),
stage_width=100,
stage_height=200,
stage_elem_id="stage",
)
path: ap.Path = ap.Path(
path_data_list=[
ap.PathMoveTo(x=50, y=50),
ap.PathVertical(y=150),
],
line_color=ap.Color("#0af"),
line_thickness=5,
)
ap.save_overall_html(dest_dir_path="path_vertical_basic_usage/")
相対座標設定¶
コンストラクタのrelativeのオプション引数はその挙動を変更します。
例として、もしその引数にTrueを指定した場合座標は相対座標として設定されます。
デフォルト値はFalseとなっており、この設定では絶対座標として扱われます。
以下のコード例ではrelativeの設定をして現在の座標から垂直方向に50px下の位置に直線を描画しています:
import apysc as ap
ap.Stage(
background_color=ap.Color("#333"),
stage_width=100,
stage_height=150,
stage_elem_id="stage",
)
path: ap.Path = ap.Path(
path_data_list=[
ap.PathMoveTo(x=50, y=50),
ap.PathVertical(y=50, relative=True),
],
line_color=ap.Color("#0af"),
line_thickness=5,
)
ap.save_overall_html(dest_dir_path="path_vertical_relative/")
PathVertical クラスのコンストラクタのAPI¶
特記事項: このAPIドキュメントはドキュメントビルド用のスクリプトによって自動で生成・同期されています。そのためもしかしたらこの節の内容は前節までの内容と重複している場合があります。
[インターフェイスの構造] __init__(self, y: Union[float, apysc._type.number.Number], *, relative: Union[bool, apysc._type.boolean.Boolean] = False, variable_name_suffix: str = '') -> None
[インターフェイス概要]
SVGの垂直方向への線（V）の描画のためのパスデータのクラスです。
[引数]
y: float or Number終点のY座標。
relative: bool or Boolean, default Falseパスの座標が相対座標として扱うかもしくは絶対座標として扱うかどうかの真偽値。
variable_name_suffix: str, default “”JavaScript上の変数のサフィックスの設定です。この設定はJavaScriptのデバッグ時に役立つことがあります。
[コードサンプル]
>>> import apysc as ap
>>> stage: ap.Stage = ap.Stage()
>>> sprite: ap.Sprite = ap.Sprite()
>>> sprite.graphics.line_style(color=ap.Color("#fff"), thickness=3)
>>> path: ap.Path = sprite.graphics.draw_path(
... path_data_list=[
... ap.PathMoveTo(x=0, y=50),
... ap.PathVertical(y=100),
... ]
... )
[関連資料]
