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

Point2D クラス

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

Point2D クラスの概要

Point2Dクラスは2次元の座標値を扱うためのインターフェイスのクラスで、X座標とY座標を扱います。このクラスはPolygonクラスなどの一部のクラスで使用され、各頂点座標の設定用に参照されます。

基本的な使い方

Point2Dクラスのコンストラクタではxyの各引数が必要になります。各引数はPythonのビルトインのintの値かもしくはapyscのIntの値を受け付けます。

import apysc as ap

ap.Stage()
point_1: ap.Point2D = ap.Point2D(x=10, y=20)

x: ap.Int = ap.Int(10)
y: ap.Int = ap.Int(20)
point_2: ap.Point2D = ap.Point2D(x=x, y=y)

XとY座標のgetterのインターフェイス

Point2Dクラスのxyの属性は以下のコード例のようにInt型の値を返却します:

import apysc as ap

ap.Stage()
point: ap.Point2D = ap.Point2D(x=10, y=20)
assert point.x == 10
assert point.y == 20

XとY座標のsetterのインターフェイス

xy属性は以下のコード例のようにInt型の値を使って値を更新することができます:

import apysc as ap

ap.Stage()
point: ap.Point2D = ap.Point2D(x=10, y=20)
point.x = ap.Number(30)
assert point.x == 30

draw_polygon インターフェイスにおける使用例

draw_polygonインターフェイスはPoint2Dの値のリストの引数を必要とします。そのためこの節ではその描画のインターフェイスによるPoint2Dクラスを使ったコード例を載せています。

以下のコード例では3点の座標を指定することによって三角形のベクターグラフィックスを描画しています。

import apysc as ap

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_polygon(
    points=[
        ap.Point2D(x=75, y=50),
        ap.Point2D(x=50, y=100),
        ap.Point2D(x=100, y=100),
    ]
)

ap.save_overall_html(dest_dir_path="point2d_basic_usage/")

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

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

[インターフェイスの構造] __init__(self, x: Union[float, apysc._type.number.Number], y: Union[float, apysc._type.number.Number], *, variable_name_suffix: str = '') -> None


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

2次元の座標値を扱うクラスです。


[引数]

  • x: Union[float, Number]

    • X座標。

  • y: Union[float, Number]

    • Y座標。

  • variable_name_suffix: str, default “”

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


[コードサンプル]

>>> import apysc as ap
>>> stage: ap.Stage = ap.Stage()
>>> sprite: ap.Sprite = ap.Sprite()
>>> sprite.graphics.begin_fill(color=ap.Color("#0af"))
>>> polygon: ap.Polygon = sprite.graphics.draw_polygon(
...     points=[
...         ap.Point2D(x=0, y=0),
...         ap.Point2D(x=0, y=50),
...         ap.Point2D(x=50, y=25),
...     ]
... )

x属性のAPI

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

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

X座標の属性のインターフェイスです。


[返却値]

  • x: Number

    • X座標。


[コードサンプル]

>>> import apysc as ap
>>> point: ap.Point2D = ap.Point2D(x=50, y=100)
>>> point.x = ap.Number(150)
>>> point.x
Number(150.0)

y属性のAPI

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

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

Y座標の属性のインターフェイスです。


[返却値]

  • y: Number

    • Y座標。


[コードサンプル]

>>> import apysc as ap
>>> point: ap.Point2D = ap.Point2D(x=50, y=100)
>>> point.y = ap.Number(150)
>>> point.y
Number(150.0)