Class Client

data

field_

member_

libName

• get libName(): string

• このMemberが使っているWebCFaceライブラリの識別情報

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

  Returns string

libVersion

• get libVersion(): string

• このMemberが使っているライブラリのバージョン

  Returns string

name

• get name(): string

• Member名

  Returns string

onCanvas2DEntry

• get onCanvas2DEntry(): EventTarget<Canvas2D>

• Canvas2Dが追加された時のイベント

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

  Returns EventTarget<Canvas2D>

onCanvas3DEntry

• get onCanvas3DEntry(): EventTarget<Canvas3D>

• Canvas3Dが追加された時のイベント

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

  Returns EventTarget<Canvas3D>

onFuncEntry

• get onFuncEntry(): EventTarget<Func>

• Funcが追加された時のイベント

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

  Returns EventTarget<Func>

onImageEntry

• get onImageEntry(): EventTarget<Image>

• Imageが追加された時のイベント

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

  Returns EventTarget<Image>

onLogEntry

• get onLogEntry(): EventTarget<Log>

• Logが追加された時のイベント

  Returns EventTarget<Log>

  Since

  ver1.9

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

onPing

• get onPing(): EventTarget<Member>

• 通信速度が更新された時のイベント

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

  Returns EventTarget<Member>

onRobotModelEntry

• get onRobotModelEntry(): EventTarget<RobotModel>

• RobotModelが追加された時のイベント

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

  Returns EventTarget<RobotModel>

onSync

• get onSync(): EventTarget<Member>

• Memberがsyncしたときのイベント

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

  Returns EventTarget<Member>

onTextEntry

• get onTextEntry(): EventTarget<Text>

• Textが追加された時のイベント

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

  Returns EventTarget<Text>

onValueEntry

• get onValueEntry(): EventTarget<Value>

• Valueが追加された時のイベント

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

  Returns EventTarget<Value>

onViewEntry

• get onViewEntry(): EventTarget<View>

• Viewが追加された時のイベント

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

  Returns EventTarget<View>

pingStatus

• get pingStatus(): null | number

• 通信速度を調べる

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

  Returns null | number

  まだ受信していなければnull, 取得できればpingの往復時間 (ms)

remoteAddr

• get remoteAddr(): string

• このMemberのIPアドレス

  Returns string

canvas2D

• canvas2D(name): Canvas2D

• Canvas2Dを参照する

  Parameters

  • name: string

  Returns Canvas2D

canvas2DEntries

• canvas2DEntries(): Canvas2D[]

• このMemberが公開しているCanvas2Dのリストを返す

  Returns Canvas2D[]

canvas3D

• canvas3D(name): Canvas3D

• Canvas3Dを参照する

  Parameters

  • name: string

  Returns Canvas3D

canvas3DEntries

• canvas3DEntries(): Canvas3D[]

• このMemberが公開しているCanvas3Dのリストを返す

  Returns Canvas3D[]

dataCheck

• dataCheck(): ClientData

• Returns ClientData

func

• func(name): Func

• Funcを参照する

  Parameters

  • name: string

  Returns Func
• func(callback, returnType, args): AnonymousFunc

• Funcの名前を決めずに一時的なFuncオブジェクト(AnonymoudFuncオブジェクト)を作成し、 関数をセットする。

  関数のセットについては Func.set() を参照。

  Parameters

  • callback: FuncCallback

    セットする関数
  • returnType: number

    関数の戻り値の型
  • args: Arg[]

  Returns AnonymousFunc

funcs

• funcs(): Func[]

• このMemberが公開しているFuncのリストを返す

  Returns Func[]

image

• image(name): Image

• Imageを参照する

  Parameters

  • name: string

  Returns Image

images

• images(): Image[]

• このMemberが公開しているImageのリストを返す

  Returns Image[]

isValid

• isValid(): boolean

• Returns boolean

log

• log(name?): Log

• Logを参照する

  ver1.9〜: nameを指定可能 (デフォルトは "default")

  Parameters

  • name: string = "default"

  Returns Log

logEntries

• logEntries(): Log[]

• このmemberが公開しているLogのリストを返す

  Returns Log[]

  Since

  ver1.9

requestPingStatus

• requestPingStatus(): void

• pingStatusのデータをリクエストする

  Returns void

  Since

  ver1.8

robotModel

• robotModel(name): RobotModel

• RobotModelを参照する

  Parameters

  • name: string

  Returns RobotModel

robotModels

• robotModels(): RobotModel[]

• このMemberが公開しているRobotModelのリストを返す

  Returns RobotModel[]

setCheck

• setCheck(): ClientData

• Returns ClientData

syncTime

• syncTime(): Date

• syncの時刻を返す

  Returns Date

text

• text(name): Text

• Textを参照する

  Parameters

  • name: string

  Returns Text

texts

• texts(): Text[]

• このMemberが公開しているTextのリストを返す

  Returns Text[]

value

• value(name): Value

• Valueを参照する

  Parameters

  • name: string

  Returns Value

values

• values(): Value[]

• このMemberが公開しているValueのリストを返す

  Returns Value[]

view

• view(name): View

• Viewを参照する

  Parameters

  • name: string

  Returns View

views

• views(): View[]

• このMemberが公開しているViewのリストを返す

  Returns View[]