webcface.canvas3d module

class webcface.canvas3d.Canvas3D(base: Field, field: str = '')[source]

Bases: Field

add(*args: TemporalComponent | Line | Plane | Box | Circle | Cylinder | Sphere | Polygon, **kwargs) → Canvas3D[source]

要素を追加

Parameters:

  • args – (ver3.0〜) 追加する要素 (複数指定した場合すべて追加される。)

  • kwargs – (ver3.0〜) argsが初期化済みの要素でない場合、要素の初期化時に渡すオプション。

詳細は TemporalComponent のコンストラクタを参照

add_geometry(geometry: Line | Plane | Box | Circle | Cylinder | Sphere | Polygon, origin: Transform | None = None, color: int = ViewColor.INHERIT) → Canvas3D[source]

Geometryを追加

Deprecated since version ver3.0.

child(field: str) → Canvas3D[source]

子フィールドを返す

Returns:

「(thisのフィールド名).(子フィールド名)」をフィールド名とするView

exists() → bool[source]

このフィールドにデータが存在すればtrue (ver2.0〜)

try_get() などとは違って、実際のデータを受信しない。 リクエストもしない。

get() → List[Canvas3DComponent][source]

Canvasをlistで返す、まだリクエストされてなければ自動でリクエストされる

init() → Canvas3D[source]

このCanvas3Dオブジェクトにaddした内容を初期化する

property member: Member

Memberを返す

property name: str

field名を返す

on_change(func: Callable) → Callable[source]

値が変化したときのイベント (ver2.0〜)

コールバックの引数にはCanvas3Dオブジェクトが渡される。

まだ値をリクエストされてなければ自動でリクエストされる

request() → None[source]

値の受信をリクエストする

sync() → Canvas3D[source]

Viewの内容をclientに反映し送信可能にする

try_get() → List[Canvas3DComponent] | None[source]

CanvasをlistまたはNoneで返す、まだリクエストされてなければ自動でリクエストされる

class webcface.canvas3d.Canvas3DComponent(base: Canvas3DComponentBase, data: ClientData | None, id: str)[source]

Bases: Canvas3DComponentBase

property color: int

色 (ViewColor)

property geometry: Geometry | None

表示する図形

property id: str

要素のid (ver3.0〜)

property origin: Transform

表示する要素の移動

property type: int

コンポーネントの種類

Canvas3DComponentType Enumを使う

class webcface.canvas3d.Canvas3DData[source]

Bases: object

components: Dict[str, Canvas3DComponentBase]
ids: List[str]
tmp_components: List[TemporalComponent]