Class Member

Memberを指すクラス

詳細は Memberのドキュメントを参照

Hierarchy (view full)

Field
- Member
  - Client

Constructors

constructor

new Member(base, member?): Member
このコンストラクタは直接使わず、 Client.member(), Client.members(), Client.onMemberEntry などを使うこと
Parameters
- base: Field
- member: string = ""
Returns Member
Overrides Field.constructor
- Defined in src/member.ts:24

Properties

data

data: null | ClientData

field_

field_: string

member_

member_: string

Accessors

libName

get libName(): string
このMemberが使っているWebCFaceライブラリの識別情報

c++クライアントライブラリは"cpp", javascriptクライアントは"js", pythonクライアントは"python"を返す。

Returns string
- Defined in src/member.ts:304

libVersion

get libVersion(): string
このMemberが使っているライブラリのバージョン

Returns string
- Defined in src/member.ts:314

name

get name(): string
Member名

Returns string
- Defined in src/member.ts:30

onCanvas2DEntry

get onCanvas2DEntry(): EventTarget<Canvas2D>
Canvas2Dが追加された時のイベント

コールバックの型は (target: Canvas3D) => void

Returns EventTarget<Canvas2D>
- Defined in src/member.ts:254

onCanvas3DEntry

get onCanvas3DEntry(): EventTarget<Canvas3D>
Canvas3Dが追加された時のイベント

コールバックの型は (target: Canvas3D) => void

Returns EventTarget<Canvas3D>
- Defined in src/member.ts:242

onFuncEntry

get onFuncEntry(): EventTarget<Func>
Funcが追加された時のイベント

コールバックの型は (target: Func) => void

Returns EventTarget<Func>
- Defined in src/member.ts:218

onImageEntry

get onImageEntry(): EventTarget<Image>
Imageが追加された時のイベント

コールバックの型は (target: View) => void

Returns EventTarget<Image>
- Defined in src/member.ts:266

onLogEntry

get onLogEntry(): EventTarget<Log>
Logが追加された時のイベント

Returns EventTarget<Log>
Since
ver1.9

コールバックの型は (target: Log) => void
- Defined in src/member.ts:279

onPing

get onPing(): EventTarget<Member>
通信速度が更新された時のイベント

通信速度データがリクエストされていなければリクエストを送る。コールバックの型は (target: Member) => void

Returns EventTarget<Member>
- Defined in src/member.ts:365

onRobotModelEntry

get onRobotModelEntry(): EventTarget<RobotModel>
RobotModelが追加された時のイベント

コールバックの型は (target: RobotModel) => void

Returns EventTarget<RobotModel>
- Defined in src/member.ts:206

onSync

get onSync(): EventTarget<Member>
Memberがsyncしたときのイベント

コールバックの型は (target: Member) => void

Returns EventTarget<Member>
- Defined in src/member.ts:291

onTextEntry

get onTextEntry(): EventTarget<Text>
Textが追加された時のイベント

コールバックの型は (target: Text) => void

Returns EventTarget<Text>
- Defined in src/member.ts:194

onValueEntry

get onValueEntry(): EventTarget<Value>
Valueが追加された時のイベント

コールバックの型は (target: Value) => void

Returns EventTarget<Value>
- Defined in src/member.ts:182

onViewEntry

get onViewEntry(): EventTarget<View>
Viewが追加された時のイベント

コールバックの型は (target: View) => void

Returns EventTarget<View>
- Defined in src/member.ts:230

pingStatus

get pingStatus(): null | number
通信速度を調べる

通信速度データがリクエストされていなければリクエストを送る。

Returns null | number
まだ受信していなければnull, 取得できればpingの往復時間 (ms)
- Defined in src/member.ts:337

remoteAddr

get remoteAddr(): string
このMemberのIPアドレス

Returns string
- Defined in src/member.ts:324

Methods

canvas2D

canvas2D(name): Canvas2D
Canvas2Dを参照する
Parameters
- name: string
Returns Canvas2D
- Defined in src/member.ts:66

canvas2DEntries

canvas2DEntries(): Canvas2D[]
このMemberが公開しているCanvas2Dのリストを返す

Returns Canvas2D[]
- Defined in src/member.ts:147

canvas3D

canvas3D(name): Canvas3D
Canvas3Dを参照する
Parameters
- name: string
Returns Canvas3D
- Defined in src/member.ts:60

canvas3DEntries

canvas3DEntries(): Canvas3D[]
このMemberが公開しているCanvas3Dのリストを返す

Returns Canvas3D[]
- Defined in src/member.ts:139

dataCheck

dataCheck(): ClientData
Returns ClientData
Inherited from Field.dataCheck
- Defined in src/field.ts:17

func

func(name): Func
Funcを参照する
Parameters
- name: string
Returns Func
- Defined in src/member.ts:78
func(callback, returnType, args): AnonymousFunc
Funcの名前を決めずに一時的なFuncオブジェクト(AnonymoudFuncオブジェクト)を作成し、関数をセットする。

関数のセットについては Func.set() を参照。
Parameters
- callback: FuncCallback
  セットする関数
- returnType: number
  関数の戻り値の型
- args: Arg[]
Returns AnonymousFunc
- Defined in src/member.ts:88

funcs

funcs(): Func[]
このMemberが公開しているFuncのリストを返す

Returns Func[]
- Defined in src/member.ts:163

image

image(name): Image
Imageを参照する
Parameters
- name: string
Returns Image
- Defined in src/member.ts:72

images

images(): Image[]
このMemberが公開しているImageのリストを返す

Returns Image[]
- Defined in src/member.ts:155

isValid

isValid(): boolean
Returns boolean
Inherited from Field.isValid
- Defined in src/field.ts:29

log

log(name?): Log
Logを参照する

ver1.9〜: nameを指定可能 (デフォルトは "default")
Parameters
- name: string = "default"
Returns Log
- Defined in src/member.ts:101

logEntries

logEntries(): Log[]
このmemberが公開しているLogのリストを返す

Returns Log[]
Since
ver1.9
- Defined in src/member.ts:172

requestPingStatus

requestPingStatus(): void
pingStatusのデータをリクエストする

Returns void
Since
ver1.8
- Defined in src/member.ts:349

robotModel

robotModel(name): RobotModel
RobotModelを参照する
Parameters
- name: string
Returns RobotModel
- Defined in src/member.ts:48

robotModels

robotModels(): RobotModel[]
このMemberが公開しているRobotModelのリストを返す

Returns RobotModel[]
- Defined in src/member.ts:123

setCheck

setCheck(): ClientData
Returns ClientData
Inherited from Field.setCheck
- Defined in src/field.ts:23

syncTime

syncTime(): Date
syncの時刻を返す

Returns Date
- Defined in src/member.ts:376

text

text(name): Text
Textを参照する
Parameters
- name: string
Returns Text
- Defined in src/member.ts:42

texts

texts(): Text[]
このMemberが公開しているTextのリストを返す

Returns Text[]
- Defined in src/member.ts:115

value

value(name): Value
Valueを参照する
Parameters
- name: string
Returns Value
- Defined in src/member.ts:36

values

values(): Value[]
このMemberが公開しているValueのリストを返す

Returns Value[]
- Defined in src/member.ts:107

view

view(name): View
Viewを参照する
Parameters
- name: string
Returns View
- Defined in src/member.ts:54

views

views(): View[]
このMemberが公開しているViewのリストを返す

Returns View[]
- Defined in src/member.ts:131