Canvas3Dの送受信データを表すクラス More...

#include <webcface/canvas3d.h>

Inheritance diagram for Canvas3D:

Collaboration diagram for Canvas3D:

Public Member Functions
	Canvas3D ()

	Canvas3D (const Field &base)

	Canvas3D (const Field &base, const SharedString &field)

Canvas3D	child (std::string_view field) const
	「(thisの名前).(追加の名前)」を新しい名前とするField

Canvas3D	child (std::wstring_view field) const
	「(thisの名前).(追加の名前)」を新しい名前とするField (wstring)

Canvas3D	child (int index) const

Canvas3D	operator[] (std::string_view field) const

Canvas3D	operator[] (std::wstring_view field) const

Canvas3D	operator[] (const char *field) const

Canvas3D	operator[] (const wchar_t *field) const

Canvas3D	operator[] (int index) const

Canvas3D	parent () const
	nameの最後のピリオドの前までを新しい名前とするField

const Canvas3D &	onChange (std::function< void(Canvas3D)> callback) const
	値が変化したときに呼び出されるコールバックを設定

template<typename F , typename std::enable_if_t< std::is_invocable_v< F >, std::nullptr_t > = nullptr>
const Canvas3D &	onChange (F callback) const
	値が変化したときに呼び出されるコールバックを設定

template<typename T >
void	appendListener (T &&callback) const

const Canvas3D &	request () const
	canvasの内容をリクエストする

std::optional< std::vector< Canvas3DComponent > >	tryGet () const
	Canvasの内容を取得する

std::vector< Canvas3DComponent >	get () const
	Canvasの内容を取得する

bool	exists () const
	このフィールドにデータが存在すればtrue

std::chrono::system_clock::time_point	time () const
	syncの時刻を返す

const Canvas3D &	free () const
	値やリクエスト状態をクリア

const Canvas3D &	init () const
	このCanvas3Dに追加した内容を初期化する

const Canvas3D &	operator<< (TemporalCanvas3DComponent cc) const
	Componentを追加

template<typename T >
const Canvas3D &	add (T &&cc) const
	コンポーネントなどを追加

template<bool V, bool C2>
const Canvas3D &	operator<< (TemporalComponent< V, C2, true > cc) const
	Geometryを追加

const Canvas3D &	sync () const
	Viewの内容をclientに反映し送信可能にする

template<typename T , typename std::enable_if_t< std::is_same_v< T, Canvas3D >, std::nullptr_t > = nullptr>
bool	operator== (const T &other) const
	Canvas3Dの参照先を比較

template<typename T , typename std::enable_if_t< std::is_same_v< T, Canvas3D >, std::nullptr_t > = nullptr>
bool	operator!= (const T &other) const

std::string	lastName () const
	nameのうちピリオドで区切られた最後の部分を取り出す

Member	member () const
	Memberを返す

const std::string &	name () const
	field名を返す

const std::wstring &	nameW () const
	field名を返す (wstring)

Protected Member Functions
std::shared_ptr< internal::ClientData >	dataLock () const
	data_wをlockし、失敗したらruntime_errorを投げる

std::shared_ptr< internal::ClientData >	setCheck () const
	data_wをlockし、memberがselfではなければinvalid_argumentを投げる

bool	expired () const

SharedString	lastName8 () const

Field	child (const SharedString &field) const

std::wstring	lastNameW () const
	nameのうちピリオドで区切られた最後の部分を取り出す (wstring)

Value	value (std::string_view field="") const

Value	value (std::wstring_view field) const

Text	text (std::string_view field="") const

Text	text (std::wstring_view field) const

RobotModel	robotModel (std::string_view field="") const

RobotModel	robotModel (std::wstring_view field) const

Image	image (std::string_view field="") const

Image	image (std::wstring_view field) const

Func	func (std::string_view field="") const

Func	func (std::wstring_view field) const

FuncListener	funcListener (std::string_view field) const

FuncListener	funcListener (std::wstring_view field) const

View	view (std::string_view field="") const

View	view (std::wstring_view field) const

Canvas3D	canvas3D (std::string_view field="") const

Canvas3D	canvas3D (std::wstring_view field) const

Canvas2D	canvas2D (std::string_view field="") const

Canvas2D	canvas2D (std::wstring_view field) const

Log	log (std::string_view field="") const

Log	log (std::wstring_view field) const

std::vector< Value >	valueEntries () const

std::vector< Text >	textEntries () const

std::vector< RobotModel >	robotModelEntries () const

std::vector< Func >	funcEntries () const

std::vector< View >	viewEntries () const

std::vector< Canvas3D >	canvas3DEntries () const

std::vector< Canvas2D >	canvas2DEntries () const

std::vector< Image >	imageEntries () const

std::vector< Log >	logEntries () const

bool	isSelf () const
	memberがselfならtrue

bool	operator== (const Field &other) const

bool	operator== (const FieldBase &rhs) const

bool	operator!= (const Field &other) const

bool	operator!= (const FieldBase &rhs) const

Protected Attributes
std::weak_ptr< internal::ClientData >	data_w
	ClientDataの参照

SharedString	member_
	メンバー名

SharedString	field_
	フィールド名

Detailed Description

Canvas3Dの送受信データを表すクラス

コンストラクタではなく Member::canvas3D() を使って取得してください

Constructor & Destructor Documentation

◆ Canvas3D() [1/3]

Canvas3D ( )

◆ Canvas3D() [2/3]

Canvas3D ( const Field & base )

◆ Canvas3D() [3/3]

Canvas3D	(	const Field &	base,
		const SharedString &	field
	)

inline

Member Function Documentation

◆ add()

template<typename T >

const Canvas3D & add ( T && cc ) const

inline

コンポーネントなどを追加

Tの型に応じた operator<< が呼ばれる

Since: ver1.9〜

◆ appendListener()

template<typename T >

void appendListener ( T && callback ) const

inline

Deprecated:: ver1.11まではEventTarget::appendListener()でコールバックを追加できたが、 ver2.0からコールバックは1個のみになった。互換性のため残しているがonChange()と同じ

◆ canvas2D() [1/2]

Canvas2D canvas2D ( std::string_view field = "" ) const

inherited

◆ canvas2D() [2/2]

Canvas2D canvas2D ( std::wstring_view field ) const

inherited

◆ canvas2DEntries()

std::vector< Canvas2D > canvas2DEntries ( ) const

inherited

◆ canvas3D() [1/2]

Canvas3D canvas3D ( std::string_view field = "" ) const

inherited

◆ canvas3D() [2/2]

Canvas3D canvas3D ( std::wstring_view field ) const

inherited

◆ canvas3DEntries()

std::vector< Canvas3D > canvas3DEntries ( ) const

inherited

◆ child() [1/4]

Field child ( const SharedString & field ) const

inherited

◆ child() [2/4]

Canvas3D child ( int index ) const

inline

Since: ver1.11

◆ child() [3/4]

Canvas3D child ( std::string_view field ) const

inline

「(thisの名前).(追加の名前)」を新しい名前とするField

◆ child() [4/4]

Canvas3D child ( std::wstring_view field ) const

inline

「(thisの名前).(追加の名前)」を新しい名前とするField (wstring)

Since: ver2.0

◆ dataLock()

std::shared_ptr< internal::ClientData > dataLock ( ) const

inherited

data_wをlockし、失敗したらruntime_errorを投げる

◆ exists()

bool exists ( ) const

このフィールドにデータが存在すればtrue

Since: ver2.1

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

◆ expired()

bool expired ( ) const

inherited

◆ free()

const Canvas3D & free ( ) const

値やリクエスト状態をクリア

◆ func() [1/2]

Func func ( std::string_view field = "" ) const

inherited

◆ func() [2/2]

Func func ( std::wstring_view field ) const

inherited

◆ funcEntries()

std::vector< Func > funcEntries ( ) const

inherited

◆ funcListener() [1/2]

FuncListener funcListener ( std::string_view field ) const

inherited

◆ funcListener() [2/2]

FuncListener funcListener ( std::wstring_view field ) const

inherited

◆ get()

std::vector< Canvas3DComponent > get ( ) const

inline

Canvasの内容を取得する

◆ image() [1/2]

Image image ( std::string_view field = "" ) const

inherited

◆ image() [2/2]

Image image ( std::wstring_view field ) const

inherited

◆ imageEntries()

std::vector< Image > imageEntries ( ) const

inherited

◆ init()

const Canvas3D & init ( ) const

このCanvas3Dに追加した内容を初期化する

このCanvas3Dオブジェクトに追加された内容をクリアし、内容を変更済みとしてマークする (init() 後に sync() をすると空のCanvas3Dが送信される)

◆ isSelf()

bool isSelf ( ) const

inherited

memberがselfならtrue

data_wがlockできなければruntime_errorを投げる

◆ lastName()

std::string lastName ( ) const

inline

nameのうちピリオドで区切られた最後の部分を取り出す

Since: ver1.11

◆ lastName8()

SharedString lastName8 ( ) const

protectedinherited

◆ lastNameW()

std::wstring lastNameW ( ) const

inlineinherited

nameのうちピリオドで区切られた最後の部分を取り出す (wstring)

Since: ver2.0

◆ log() [1/2]

Log log ( std::string_view field = "" ) const

inherited

Since: ver2.4

◆ log() [2/2]

Log log ( std::wstring_view field ) const

inherited

Since: ver2.4

◆ logEntries()

std::vector< Log > logEntries ( ) const

inherited

Since: ver2.4

◆ member()

Member member ( ) const

Memberを返す

◆ name()

const std::string & name ( ) const

inline

field名を返す

◆ nameW()

const std::wstring & nameW ( ) const

inline

field名を返す (wstring)

Since: ver2.0

◆ onChange() [1/2]

template<typename F , typename std::enable_if_t< std::is_invocable_v< F >, std::nullptr_t > = nullptr>

const Canvas3D & onChange ( F callback ) const

inline

値が変化したときに呼び出されるコールバックを設定

Since: ver2.0

Parameters

callback 引数をとらない関数

◆ onChange() [2/2]

const Canvas3D & onChange ( std::function< void(Canvas3D)> callback ) const

値が変化したときに呼び出されるコールバックを設定

Since: ver2.0

Parameters

callback Canvas3D型の引数(thisが渡される)を1つ取る関数

◆ operator!=() [1/3]

bool operator!= ( const Field & other ) const

inlineinherited

◆ operator!=() [2/3]

bool operator!= ( const FieldBase & rhs ) const

inlineinherited

◆ operator!=() [3/3]

template<typename T , typename std::enable_if_t< std::is_same_v< T, Canvas3D >, std::nullptr_t > = nullptr>

bool operator!= ( const T & other ) const

inline

◆ operator<<() [1/2]

const Canvas3D & operator<< ( TemporalCanvas3DComponent cc ) const

Componentを追加

Since: ver1.9

◆ operator<<() [2/2]

template<bool V, bool C2>

const Canvas3D & operator<< ( TemporalComponent< V, C2, true > cc ) const

inline

Geometryを追加

Since: ver1.9

◆ operator==() [1/3]

bool operator== ( const Field & other ) const

inherited

◆ operator==() [2/3]

bool operator== ( const FieldBase & rhs ) const

inlineinherited

◆ operator==() [3/3]

template<typename T , typename std::enable_if_t< std::is_same_v< T, Canvas3D >, std::nullptr_t > = nullptr>

bool operator== ( const T & other ) const

inline

Canvas3Dの参照先を比較

Since: ver1.11

◆ operator[]() [1/5]

Canvas3D operator[] ( const char * field ) const

inline

operator[](long, const char *)と解釈されるのを防ぐための定義

Since: ver1.11

◆ operator[]() [2/5]

Canvas3D operator[] ( const wchar_t * field ) const

inline

Since: ver2.0

◆ operator[]() [3/5]

Canvas3D operator[] ( int index ) const

inline

child()と同じ

Since: ver1.11

◆ operator[]() [4/5]

Canvas3D operator[] ( std::string_view field ) const

inline

child()と同じ

Since: ver1.11

◆ operator[]() [5/5]

Canvas3D operator[] ( std::wstring_view field ) const

inline

child()と同じ

Since: ver2.0

◆ parent()

Canvas3D parent ( ) const

inline

nameの最後のピリオドの前までを新しい名前とするField

Since: ver1.11

◆ request()

const Canvas3D & request ( ) const

canvasの内容をリクエストする

Since: ver1.7

◆ robotModel() [1/2]

RobotModel robotModel ( std::string_view field = "" ) const

inherited

◆ robotModel() [2/2]

RobotModel robotModel ( std::wstring_view field ) const

inherited

◆ robotModelEntries()

std::vector< RobotModel > robotModelEntries ( ) const

inherited

◆ setCheck()

std::shared_ptr< internal::ClientData > setCheck ( ) const

inherited

data_wをlockし、memberがselfではなければinvalid_argumentを投げる

◆ sync()

const Canvas3D & sync ( ) const

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

このCanvas3Dオブジェクトの内容が変更されていなければ (init()も追加もされていなければ) 何もしない。

◆ text() [1/2]

Text text ( std::string_view field = "" ) const

inherited

◆ text() [2/2]

Text text ( std::wstring_view field ) const

inherited

◆ textEntries()

std::vector< Text > textEntries ( ) const

inherited

◆ time()

std::chrono::system_clock::time_point time ( ) const

syncの時刻を返す

Deprecated:: 1.7でMember::syncTime()に変更

◆ tryGet()

std::optional< std::vector< Canvas3DComponent > > tryGet ( ) const

Canvasの内容を取得する

◆ value() [1/2]

Value value ( std::string_view field = "" ) const

inherited

◆ value() [2/2]

Value value ( std::wstring_view field ) const

inherited

◆ valueEntries()

std::vector< Value > valueEntries ( ) const

inherited

◆ view() [1/2]

View view ( std::string_view field = "" ) const

inherited

◆ view() [2/2]

View view ( std::wstring_view field ) const

inherited

◆ viewEntries()

std::vector< View > viewEntries ( ) const

inherited

Member Data Documentation

◆ data_w

std::weak_ptr<internal::ClientData> data_w

inherited

ClientDataの参照

ClientData内に保持するクラスもあるので循環参照を避けるためweak_ptr

◆ field_

SharedString field_

inherited

フィールド名

Memberなどフィールド名が不要なクラスでは使用しない

◆ member_

SharedString member_

inherited

メンバー名

The documentation for this class was generated from the following files:

client/include/webcface/canvas3d.h
client/src/canvas3d.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Canvas3D() [1/3]

◆ Canvas3D() [2/3]

◆ Canvas3D() [3/3]

Member Function Documentation

◆ add()

◆ appendListener()

◆ canvas2D() [1/2]

◆ canvas2D() [2/2]

◆ canvas2DEntries()

◆ canvas3D() [1/2]

◆ canvas3D() [2/2]

◆ canvas3DEntries()

◆ child() [1/4]

◆ child() [2/4]

◆ child() [3/4]

◆ child() [4/4]

◆ dataLock()

◆ exists()

◆ expired()

◆ free()

◆ func() [1/2]

◆ func() [2/2]

◆ funcEntries()

◆ funcListener() [1/2]

◆ funcListener() [2/2]

◆ get()

◆ image() [1/2]

◆ image() [2/2]

◆ imageEntries()

◆ init()

◆ isSelf()

◆ lastName()

◆ lastName8()

◆ lastNameW()

◆ log() [1/2]

◆ log() [2/2]

◆ logEntries()

◆ member()

◆ name()

◆ nameW()

◆ onChange() [1/2]

◆ onChange() [2/2]

◆ operator!=() [1/3]

◆ operator!=() [2/3]

◆ operator!=() [3/3]

◆ operator<<() [1/2]

◆ operator<<() [2/2]

◆ operator==() [1/3]

◆ operator==() [2/3]

◆ operator==() [3/3]

◆ operator[]() [1/5]

◆ operator[]() [2/5]

◆ operator[]() [3/5]

◆ operator[]() [4/5]

◆ operator[]() [5/5]

◆ parent()

◆ request()

◆ robotModel() [1/2]

◆ robotModel() [2/2]

◆ robotModelEntries()

◆ setCheck()

◆ sync()

◆ text() [1/2]

◆ text() [2/2]

◆ textEntries()

◆ time()

◆ tryGet()

◆ value() [1/2]

◆ value() [2/2]

◆ valueEntries()

◆ view() [1/2]

◆ view() [2/2]

◆ viewEntries()

Member Data Documentation

◆ data_w