(ver1.3から追加) 画像の送受信データを表すクラス More...

#include <webcface/image.h>

Inheritance diagram for Image:

Collaboration diagram for Image:

Public Member Functions
	Image ()=default

	Image (const Field &base)

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

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

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

Image	child (int index) const

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

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

Image	operator[] (const char *field) const

Image	operator[] (const wchar_t *field) const

Image	operator[] (int index) const

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

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

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

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

const Image &	set (const ImageFrame &img) const
	画像をセットする

const Image &	operator= (const ImageFrame &img) const
	画像をセットする

const Image &	request (std::optional< int > rows, std::optional< int > cols=std::nullopt, std::optional< ImageColorMode > color_mode=std::nullopt, std::optional< double > frame_rate=std::nullopt) const
	画像を生画像のフォーマットでリクエストする

const Image &	request (std::optional< SizeOption > size=std::nullopt, std::optional< ImageColorMode > color_mode=std::nullopt, std::optional< double > frame_rate=std::nullopt) const
	画像を生画像のフォーマットでリクエストする

const Image &	request (std::optional< int > rows, std::optional< int > cols, ImageCompressMode cmp_mode, int quality, std::optional< double > frame_rate=std::nullopt) const
	画像を圧縮されたフォーマットでリクエストする

const Image &	request (std::optional< SizeOption > size, ImageCompressMode cmp_mode, int quality, std::optional< double > frame_rate=std::nullopt) const
	画像を圧縮されたフォーマットでリクエストする

std::optional< ImageFrame >	tryGet () const
	画像を返す

ImageFrame	get () const
	画像を返す (データがない場合0x0の画像が返る)

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

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

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

const Image &	clear () const
	画像をクリア (リクエスト状態は解除しない)

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

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

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

template<typename Member_ = Member, bool = ::webcface::traits::assertCompleteMember < std::enable_if_t<std::is_same_v< Member_, Member >, Member_>>()>
Member_	member () const
	Memberを返す

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

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

Protected Member Functions
const Image &	tryRequest () const

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)

template<typename Value_ = Value, bool = ::webcface::traits::assertCompleteValue < std::enable_if_t<std::is_same_v< Value_, Value >, Value_>>()>
Value_	value (std::string_view field="") const

template<typename Value_ = Value, bool = ::webcface::traits::assertCompleteValue < std::enable_if_t<std::is_same_v< Value_, Value >, Value_>>()>
Value_	value (std::wstring_view field) const

template<typename Text_ = Text, bool = ::webcface::traits::assertCompleteText < std::enable_if_t<std::is_same_v< Text_, Text >, Text_>>()>
Text_	text (std::string_view field="") const

template<typename Text_ = Text, bool = ::webcface::traits::assertCompleteText < std::enable_if_t<std::is_same_v< Text_, Text >, Text_>>()>
Text_	text (std::wstring_view field) const

template<typename RobotModel_ = RobotModel, bool = ::webcface::traits::assertCompleteRobotModel < std::enable_if_t<std::is_same_v< RobotModel_, RobotModel >, RobotModel_>>()>
RobotModel_	robotModel (std::string_view field="") const

template<typename RobotModel_ = RobotModel, bool = ::webcface::traits::assertCompleteRobotModel < std::enable_if_t<std::is_same_v< RobotModel_, RobotModel >, RobotModel_>>()>
RobotModel_	robotModel (std::wstring_view field) const

template<typename Image_ = Image, bool = ::webcface::traits::assertCompleteImage < std::enable_if_t<std::is_same_v< Image_, Image >, Image_>>()>
Image_	image (std::string_view field="") const

template<typename Image_ = Image, bool = ::webcface::traits::assertCompleteImage < std::enable_if_t<std::is_same_v< Image_, Image >, Image_>>()>
Image_	image (std::wstring_view field) const

template<typename Func_ = Func, bool = ::webcface::traits::assertCompleteFunc < std::enable_if_t<std::is_same_v< Func_, Func >, Func_>>()>
Func_	func (std::string_view field="") const

template<typename Func_ = Func, bool = ::webcface::traits::assertCompleteFunc < std::enable_if_t<std::is_same_v< Func_, Func >, Func_>>()>
Func_	func (std::wstring_view field) const

template<typename FuncListener_ = FuncListener, bool = ::webcface::traits::assertCompleteFuncListener < std::enable_if_t<std::is_same_v< FuncListener_, FuncListener >, FuncListener_>>()>
FuncListener_	funcListener (std::string_view field="") const

template<typename FuncListener_ = FuncListener, bool = ::webcface::traits::assertCompleteFuncListener < std::enable_if_t<std::is_same_v< FuncListener_, FuncListener >, FuncListener_>>()>
FuncListener_	funcListener (std::wstring_view field) const

template<typename View_ = View, bool = ::webcface::traits::assertCompleteView < std::enable_if_t<std::is_same_v< View_, View >, View_>>()>
View_	view (std::string_view field="") const

template<typename View_ = View, bool = ::webcface::traits::assertCompleteView < std::enable_if_t<std::is_same_v< View_, View >, View_>>()>
View_	view (std::wstring_view field) const

template<typename Canvas3D_ = Canvas3D, bool = ::webcface::traits::assertCompleteCanvas3D < std::enable_if_t<std::is_same_v< Canvas3D_, Canvas3D >, Canvas3D_>>()>
Canvas3D_	canvas3D (std::string_view field="") const

template<typename Canvas3D_ = Canvas3D, bool = ::webcface::traits::assertCompleteCanvas3D < std::enable_if_t<std::is_same_v< Canvas3D_, Canvas3D >, Canvas3D_>>()>
Canvas3D_	canvas3D (std::wstring_view field) const

template<typename Canvas2D_ = Canvas2D, bool = ::webcface::traits::assertCompleteCanvas2D < std::enable_if_t<std::is_same_v< Canvas2D_, Canvas2D >, Canvas2D_>>()>
Canvas2D_	canvas2D (std::string_view field="") const

template<typename Canvas2D_ = Canvas2D, bool = ::webcface::traits::assertCompleteCanvas2D < std::enable_if_t<std::is_same_v< Canvas2D_, Canvas2D >, Canvas2D_>>()>
Canvas2D_	canvas2D (std::wstring_view field) const

template<typename Log_ = Log, bool = ::webcface::traits::assertCompleteLog < std::enable_if_t<std::is_same_v< Log_, Log >, Log_>>()>
Log_	log (std::string_view field="") const

template<typename Log_ = Log, bool = ::webcface::traits::assertCompleteLog < std::enable_if_t<std::is_same_v< Log_, Log >, Log_>>()>
Log_	log (std::wstring_view field) const

std::vector< Field >	children () const
	「(thisの名前).(追加の名前)」で公開されているデータのリスト

std::vector< Field >	childrenRecurse () const
	「(thisの名前).(追加の名前)」で公開されているデータのリスト(再帰)

bool	hasChildren () const
	「(thisの名前).(追加の名前)」で公開されているデータが存在するかどうかを返す

template<typename Value_ = Value, bool = ::webcface::traits::assertCompleteValue < std::enable_if_t<std::is_same_v< Value_, Value >, Value_>>()>
std::vector< Value_ >	valueEntries () const
	「(thisの名前).(追加の名前)」で公開されているvalueのリストを返す。

template<typename T , bool >
std::vector< T >	valueEntries () const

template<typename Text_ = Text, bool = ::webcface::traits::assertCompleteText < std::enable_if_t<std::is_same_v< Text_, Text >, Text_>>()>
std::vector< Text_ >	textEntries () const
	「(thisの名前).(追加の名前)」で公開されているtextのリストを返す。

template<typename T , bool >
std::vector< T >	textEntries () const

template<typename RobotModel_ = RobotModel, bool = ::webcface::traits::assertCompleteRobotModel < std::enable_if_t<std::is_same_v< RobotModel_, RobotModel >, RobotModel_>>()>
std::vector< RobotModel_ >	robotModelEntries () const
	「(thisの名前).(追加の名前)」で公開されているrobotModelのリストを返す。

template<typename T , bool >
std::vector< T >	robotModelEntries () const

template<typename Func_ = Func, bool = ::webcface::traits::assertCompleteFunc < std::enable_if_t<std::is_same_v< Func_, Func >, Func_>>()>
std::vector< Func_ >	funcEntries () const
	「(thisの名前).(追加の名前)」で公開されているfuncのリストを返す。

template<typename T , bool >
std::vector< T >	funcEntries () const

template<typename View_ = View, bool = ::webcface::traits::assertCompleteView < std::enable_if_t<std::is_same_v< View_, View >, View_>>()>
std::vector< View_ >	viewEntries () const
	「(thisの名前).(追加の名前)」で公開されているviewのリストを返す。

template<typename T , bool >
std::vector< T >	viewEntries () const

template<typename Canvas2D_ = Canvas2D, bool = ::webcface::traits::assertCompleteCanvas2D < std::enable_if_t<std::is_same_v< Canvas2D_, Canvas2D >, Canvas2D_>>()>
std::vector< Canvas2D_ >	canvas2DEntries () const
	「(thisの名前).(追加の名前)」で公開されているcanvas2Dのリストを返す。

template<typename T , bool >
std::vector< T >	canvas2DEntries () const

template<typename Canvas3D_ = Canvas3D, bool = ::webcface::traits::assertCompleteCanvas3D < std::enable_if_t<std::is_same_v< Canvas3D_, Canvas3D >, Canvas3D_>>()>
std::vector< Canvas3D_ >	canvas3DEntries () const
	「(thisの名前).(追加の名前)」で公開されているcanvas3Dのリストを返す。

template<typename T , bool >
std::vector< T >	canvas3DEntries () const

template<typename Image_ = Image, bool = ::webcface::traits::assertCompleteImage < std::enable_if_t<std::is_same_v< Image_, Image >, Image_>>()>
std::vector< Image_ >	imageEntries () const
	「(thisの名前).(追加の名前)」で公開されているimageのリストを返す。

template<typename T , bool >
std::vector< T >	imageEntries () const

template<typename Log_ = Log, bool = ::webcface::traits::assertCompleteLog < std::enable_if_t<std::is_same_v< Log_, Log >, Log_>>()>
std::vector< Log_ >	logEntries () const
	「(thisの名前).(追加の名前)」で公開されているlogのリストを返す。

template<typename T , bool >
std::vector< T >	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

(ver1.3から追加) 画像の送受信データを表すクラス

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

Constructor & Destructor Documentation

◆ Image() [1/3]

Image ( )

default

◆ Image() [2/3]

Image ( const Field & base )

◆ Image() [3/3]

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

inline

Member Function Documentation

◆ appendListener()

template<typename T >

void appendListener ( T && callback ) const

inline

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

◆ canvas2D() [1/2]

template<typename Canvas2D_ = Canvas2D, bool = ::webcface::traits::assertCompleteCanvas2D < std::enable_if_t<std::is_same_v< Canvas2D_, Canvas2D >, Canvas2D_>>()>

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

inlineinherited

◆ canvas2D() [2/2]

template<typename Canvas2D_ = Canvas2D, bool = ::webcface::traits::assertCompleteCanvas2D < std::enable_if_t<std::is_same_v< Canvas2D_, Canvas2D >, Canvas2D_>>()>

Canvas2D_ canvas2D ( std::wstring_view field ) const

inlineinherited

◆ canvas2DEntries() [1/2]

template<typename Canvas2D_ = Canvas2D, bool = ::webcface::traits::assertCompleteCanvas2D < std::enable_if_t<std::is_same_v< Canvas2D_, Canvas2D >, Canvas2D_>>()>

template std::vector< Canvas2D > canvas2DEntries< Canvas2D, true > ( ) const

inherited

「(thisの名前).(追加の名前)」で公開されているcanvas2Dのリストを返す。

Since: ver1.6

See also: childrenRecurse()

◆ canvas2DEntries() [2/2]

template<typename T , bool >

template std::vector< Canvas2D > canvas2DEntries< Canvas2D, true > ( ) const

inherited

◆ canvas3D() [1/2]

template<typename Canvas3D_ = Canvas3D, bool = ::webcface::traits::assertCompleteCanvas3D < std::enable_if_t<std::is_same_v< Canvas3D_, Canvas3D >, Canvas3D_>>()>

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

inlineinherited

◆ canvas3D() [2/2]

template<typename Canvas3D_ = Canvas3D, bool = ::webcface::traits::assertCompleteCanvas3D < std::enable_if_t<std::is_same_v< Canvas3D_, Canvas3D >, Canvas3D_>>()>

Canvas3D_ canvas3D ( std::wstring_view field ) const

inlineinherited

◆ canvas3DEntries() [1/2]

template<typename Canvas3D_ = Canvas3D, bool = ::webcface::traits::assertCompleteCanvas3D < std::enable_if_t<std::is_same_v< Canvas3D_, Canvas3D >, Canvas3D_>>()>

template std::vector< Canvas3D > canvas3DEntries< Canvas3D, true > ( ) const

inherited

「(thisの名前).(追加の名前)」で公開されているcanvas3Dのリストを返す。

Since: ver1.6

See also: childrenRecurse()

◆ canvas3DEntries() [2/2]

template<typename T , bool >

template std::vector< Canvas3D > canvas3DEntries< Canvas3D, true > ( ) const

inherited

◆ child() [1/4]

Field child ( const SharedString & field ) const

inherited

◆ child() [2/4]

Image child ( int index ) const

inline

Since: ver1.11

Deprecated:: ver2.8〜

◆ child() [3/4]

Image child ( std::string_view field ) const

inline

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

◆ child() [4/4]

Image child ( std::wstring_view field ) const

inline

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

Since: ver2.0

◆ children()

std::vector< Field > children ( ) const

inherited

「(thisの名前).(追加の名前)」で公開されているデータのリスト

Since: ver2.6

データ型を問わずすべてのデータを列挙する。
childrenRecurse() と異なり、名前にさらにピリオドが含まれる場合はその前までの名前を返す。
同名で複数のデータが存在する場合も1回のみカウントする。

See also: childrenRecurse(), hasChildren()

◆ childrenRecurse()

std::vector< Field > childrenRecurse ( ) const

inherited

「(thisの名前).(追加の名前)」で公開されているデータのリスト(再帰)

Since: ver2.6

データ型を問わずすべてのデータを列挙する。
同名で複数のデータが存在する場合も1回のみカウントする。

See also: children(), hasChildren()

◆ clear()

const Image & clear ( ) const

画像をクリア (リクエスト状態は解除しない)

◆ 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 Image & free ( ) const

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

◆ func() [1/2]

template<typename Func_ = Func, bool = ::webcface::traits::assertCompleteFunc < std::enable_if_t<std::is_same_v< Func_, Func >, Func_>>()>

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

inlineinherited

◆ func() [2/2]

template<typename Func_ = Func, bool = ::webcface::traits::assertCompleteFunc < std::enable_if_t<std::is_same_v< Func_, Func >, Func_>>()>

Func_ func ( std::wstring_view field ) const

inlineinherited

◆ funcEntries() [1/2]

template<typename Func_ = Func, bool = ::webcface::traits::assertCompleteFunc < std::enable_if_t<std::is_same_v< Func_, Func >, Func_>>()>

template std::vector< Func > funcEntries< Func, true > ( ) const

inherited

「(thisの名前).(追加の名前)」で公開されているfuncのリストを返す。

Since: ver1.6

See also: childrenRecurse()

◆ funcEntries() [2/2]

template<typename T , bool >

template std::vector< Func > funcEntries< Func, true > ( ) const

inherited

◆ funcListener() [1/2]

template<typename FuncListener_ = FuncListener, bool = ::webcface::traits::assertCompleteFuncListener < std::enable_if_t<std::is_same_v< FuncListener_, FuncListener >, FuncListener_>>()>

FuncListener_ funcListener ( std::string_view field = "" ) const

inlineinherited

◆ funcListener() [2/2]

template<typename FuncListener_ = FuncListener, bool = ::webcface::traits::assertCompleteFuncListener < std::enable_if_t<std::is_same_v< FuncListener_, FuncListener >, FuncListener_>>()>

FuncListener_ funcListener ( std::wstring_view field ) const

inlineinherited

◆ get()

ImageFrame get ( ) const

inline

画像を返す (データがない場合0x0の画像が返る)

リクエストしていない場合すべてデフォルトで(元画像のフォーマットで)リクエストする

◆ hasChildren()

bool hasChildren ( ) const

inherited

「(thisの名前).(追加の名前)」で公開されているデータが存在するかどうかを返す

Since: ver2.6

See also: children(), childrenRecurse()

◆ image() [1/2]

template<typename Image_ = Image, bool = ::webcface::traits::assertCompleteImage < std::enable_if_t<std::is_same_v< Image_, Image >, Image_>>()>

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

inlineinherited

◆ image() [2/2]

template<typename Image_ = Image, bool = ::webcface::traits::assertCompleteImage < std::enable_if_t<std::is_same_v< Image_, Image >, Image_>>()>

Image_ image ( std::wstring_view field ) const

inlineinherited

◆ imageEntries() [1/2]

template<typename Image_ = Image, bool = ::webcface::traits::assertCompleteImage < std::enable_if_t<std::is_same_v< Image_, Image >, Image_>>()>

template std::vector< Image > imageEntries< Image, true > ( ) const

inherited

「(thisの名前).(追加の名前)」で公開されているimageのリストを返す。

Since: ver1.6

See also: childrenRecurse()

◆ imageEntries() [2/2]

template<typename T , bool >

template std::vector< Image > imageEntries< Image, true > ( ) const

inherited

◆ 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]

template<typename Log_ = Log, bool = ::webcface::traits::assertCompleteLog < std::enable_if_t<std::is_same_v< Log_, Log >, Log_>>()>

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

inlineinherited

Since: ver2.4

◆ log() [2/2]

template<typename Log_ = Log, bool = ::webcface::traits::assertCompleteLog < std::enable_if_t<std::is_same_v< Log_, Log >, Log_>>()>

Log_ log ( std::wstring_view field ) const

inlineinherited

Since: ver2.4

◆ logEntries() [1/2]

template<typename Log_ = Log, bool = ::webcface::traits::assertCompleteLog < std::enable_if_t<std::is_same_v< Log_, Log >, Log_>>()>

template std::vector< Log > logEntries< Log, true > ( ) const

inherited

「(thisの名前).(追加の名前)」で公開されているlogのリストを返す。

Since: ver2.4

See also: childrenRecurse()

◆ logEntries() [2/2]

template<typename T , bool >

template std::vector< Log > logEntries< Log, true > ( ) const

inherited

◆ member()

template<typename Member_ = Member, bool = ::webcface::traits::assertCompleteMember < std::enable_if_t<std::is_same_v< Member_, Member >, Member_>>()>

Member_ member ( ) const

inline

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 Image & onChange ( F callback ) const

inline

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

Since: ver2.0

Parameters

callback 引数をとらない関数

◆ onChange() [2/2]

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

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

Since: ver2.0

Parameters

callback Image型の引数(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, Image >, std::nullptr_t > = nullptr>

bool operator!= ( const T & other ) const

inline

◆ operator=()

const Image & operator= ( const ImageFrame & img ) const

inline

画像をセットする

◆ 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, Image >, std::nullptr_t > = nullptr>

bool operator== ( const T & other ) const

inline

Imageの参照先を比較

Since: ver1.11

◆ operator[]() [1/5]

Image operator[] ( const char * field ) const

inline

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

Since: ver1.11

◆ operator[]() [2/5]

Image operator[] ( const wchar_t * field ) const

inline

Since: ver2.0

◆ operator[]() [3/5]

Image operator[] ( int index ) const

inline

child()と同じ

Since: ver1.11

Deprecated:: ver2.8〜

◆ operator[]() [4/5]

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

inline

child()と同じ

Since: ver1.11

◆ operator[]() [5/5]

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

inline

child()と同じ

Since: ver2.0

◆ parent()

Image parent ( ) const

inline

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

Since: ver1.11

◆ request() [1/4]

const Image & request	(	std::optional< int >	rows,
		std::optional< int >	cols,
		ImageCompressMode	cmp_mode,
		int	quality,
		std::optional< double >	frame_rate = `std::nullopt`
	)		const

inline

画像を圧縮されたフォーマットでリクエストする

Parameters

rows	画像の高さ
cols	画像の幅 rows,colsのどちらかのみがnulloptの場合縦横比を保ってリサイズ
cmp_mode	圧縮モード
quality	圧縮のパラメータ jpeg → 0〜100 (大きいほうが高品質) png → 0〜9 (大きいほうが圧縮後のサイズが小さい) webp → 1〜100 (大きいほうが高品質)
frame_rate	画像を受信する頻度 (指定しない場合元画像が更新されるたびに受信する)

Deprecated:: ver2.0〜 rows, colsの順番がややこしいので sizeHW() を使ってサイズ指定

◆ request() [2/4]

const Image & request	(	std::optional< int >	rows,
		std::optional< int >	cols = `std::nullopt`,
		std::optional< ImageColorMode >	color_mode = `std::nullopt`,
		std::optional< double >	frame_rate = `std::nullopt`
	)		const

inline

画像を生画像のフォーマットでリクエストする

Parameters

rows	画像の高さ
cols	画像の幅 rows,colsのどちらかのみがnulloptの場合縦横比を保ってリサイズ
color_mode	画像の色フォーマット (nulloptの場合元画像のフォーマット)
frame_rate	画像を受信する頻度 (指定しない場合元画像が更新されるたびに受信する)

Deprecated:: ver2.0〜 rows, colsの順番がややこしいので sizeHW() を使ってサイズ指定

◆ request() [3/4]

const Image & request	(	std::optional< SizeOption >	size,
		ImageCompressMode	cmp_mode,
		int	quality,
		std::optional< double >	frame_rate = `std::nullopt`
	)		const

inline

画像を圧縮されたフォーマットでリクエストする

Since: ver2.0

Parameters

sizeOption	画像のサイズ (sizeWH() または sizeHW(), std::nullopt可) rows,colsのどちらかのみがnulloptの場合縦横比を保ってリサイズ
cmp_mode	圧縮モード
quality	圧縮のパラメータ jpeg → 0〜100 (大きいほうが高品質) png → 0〜9 (大きいほうが圧縮後のサイズが小さい) webp → 1〜100 (大きいほうが高品質)
frame_rate	画像を受信する頻度 (指定しない場合元画像が更新されるたびに受信する)

◆ request() [4/4]

const Image & request	(	std::optional< SizeOption >	size = `std::nullopt`,
		std::optional< ImageColorMode >	color_mode = `std::nullopt`,
		std::optional< double >	frame_rate = `std::nullopt`
	)		const

inline

画像を生画像のフォーマットでリクエストする

Since: ver2.0

Parameters

sizeOption	画像のサイズ (sizeWH() または sizeHW(), std::nullopt可) rows,colsのどちらかのみがnulloptの場合縦横比を保ってリサイズ
color_mode	画像の色フォーマット (nulloptの場合元画像のフォーマット)
frame_rate	画像を受信する頻度 (指定しない場合元画像が更新されるたびに受信する)

◆ robotModel() [1/2]

template<typename RobotModel_ = RobotModel, bool = ::webcface::traits::assertCompleteRobotModel < std::enable_if_t<std::is_same_v< RobotModel_, RobotModel >, RobotModel_>>()>

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

inlineinherited

◆ robotModel() [2/2]

template<typename RobotModel_ = RobotModel, bool = ::webcface::traits::assertCompleteRobotModel < std::enable_if_t<std::is_same_v< RobotModel_, RobotModel >, RobotModel_>>()>

RobotModel_ robotModel ( std::wstring_view field ) const

inlineinherited

◆ robotModelEntries() [1/2]

template<typename RobotModel_ = RobotModel, bool = ::webcface::traits::assertCompleteRobotModel < std::enable_if_t<std::is_same_v< RobotModel_, RobotModel >, RobotModel_>>()>

template std::vector< RobotModel > robotModelEntries< RobotModel, true > ( ) const

inherited

「(thisの名前).(追加の名前)」で公開されているrobotModelのリストを返す。

Since: ver1.6

See also: childrenRecurse()

◆ robotModelEntries() [2/2]

template<typename T , bool >

template std::vector< RobotModel > robotModelEntries< RobotModel, true > ( ) const

inherited

◆ set()

const Image & set ( const ImageFrame & img ) const

画像をセットする

◆ setCheck()

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

inherited

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

◆ text() [1/2]

template<typename Text_ = Text, bool = ::webcface::traits::assertCompleteText < std::enable_if_t<std::is_same_v< Text_, Text >, Text_>>()>

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

inlineinherited

◆ text() [2/2]

template<typename Text_ = Text, bool = ::webcface::traits::assertCompleteText < std::enable_if_t<std::is_same_v< Text_, Text >, Text_>>()>

Text_ text ( std::wstring_view field ) const

inlineinherited

◆ textEntries() [1/2]

template<typename Text_ = Text, bool = ::webcface::traits::assertCompleteText < std::enable_if_t<std::is_same_v< Text_, Text >, Text_>>()>

template std::vector< Text > textEntries< Text, true > ( ) const

inherited

「(thisの名前).(追加の名前)」で公開されているtextのリストを返す。

Since: ver1.6

See also: childrenRecurse()

◆ textEntries() [2/2]

template<typename T , bool >

template std::vector< Text > textEntries< Text, true > ( ) const

inherited

◆ time()

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

syncの時刻を返す

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

◆ tryGet()

std::optional< ImageFrame > tryGet ( ) const

画像を返す

リクエストしていない場合すべてデフォルトで(元画像のフォーマットで)リクエストする

◆ tryRequest()

const Image & tryRequest ( ) const

protected

◆ value() [1/2]

template<typename Value_ = Value, bool = ::webcface::traits::assertCompleteValue < std::enable_if_t<std::is_same_v< Value_, Value >, Value_>>()>

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

inlineinherited

◆ value() [2/2]

template<typename Value_ = Value, bool = ::webcface::traits::assertCompleteValue < std::enable_if_t<std::is_same_v< Value_, Value >, Value_>>()>

Value_ value ( std::wstring_view field ) const

inlineinherited

◆ valueEntries() [1/2]

template<typename Value_ = Value, bool = ::webcface::traits::assertCompleteValue < std::enable_if_t<std::is_same_v< Value_, Value >, Value_>>()>

template std::vector< Value > valueEntries< Value, true > ( ) const

inherited

「(thisの名前).(追加の名前)」で公開されているvalueのリストを返す。

Since: ver1.6

See also: childrenRecurse()

◆ valueEntries() [2/2]

template<typename T , bool >

template std::vector< Value > valueEntries< Value, true > ( ) const

inherited

◆ view() [1/2]

template<typename View_ = View, bool = ::webcface::traits::assertCompleteView < std::enable_if_t<std::is_same_v< View_, View >, View_>>()>

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

inlineinherited

◆ view() [2/2]

template<typename View_ = View, bool = ::webcface::traits::assertCompleteView < std::enable_if_t<std::is_same_v< View_, View >, View_>>()>

View_ view ( std::wstring_view field ) const

inlineinherited

◆ viewEntries() [1/2]

template<typename View_ = View, bool = ::webcface::traits::assertCompleteView < std::enable_if_t<std::is_same_v< View_, View >, View_>>()>

template std::vector< View > viewEntries< View, true > ( ) const

inherited

「(thisの名前).(追加の名前)」で公開されているviewのリストを返す。

Since: ver1.6

See also: childrenRecurse()

◆ viewEntries() [2/2]

template<typename T , bool >

template std::vector< View > viewEntries< View, true > ( ) 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/image.h
client/src/image.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Image() [1/3]

◆ Image() [2/3]

◆ Image() [3/3]

Member Function Documentation

◆ appendListener()

◆ canvas2D() [1/2]

◆ canvas2D() [2/2]

◆ canvas2DEntries() [1/2]

◆ canvas2DEntries() [2/2]

◆ canvas3D() [1/2]

◆ canvas3D() [2/2]

◆ canvas3DEntries() [1/2]

◆ canvas3DEntries() [2/2]

◆ child() [1/4]

◆ child() [2/4]

◆ child() [3/4]

◆ child() [4/4]

◆ children()

◆ childrenRecurse()

◆ clear()

◆ dataLock()

◆ exists()

◆ expired()

◆ free()

◆ func() [1/2]

◆ func() [2/2]

◆ funcEntries() [1/2]

◆ funcEntries() [2/2]

◆ funcListener() [1/2]

◆ funcListener() [2/2]

◆ get()

◆ hasChildren()

◆ image() [1/2]

◆ image() [2/2]

◆ imageEntries() [1/2]

◆ imageEntries() [2/2]

◆ isSelf()

◆ lastName()

◆ lastName8()

◆ lastNameW()

◆ log() [1/2]

◆ log() [2/2]

◆ logEntries() [1/2]

◆ logEntries() [2/2]

◆ member()

◆ name()

◆ nameW()

◆ onChange() [1/2]

◆ onChange() [2/2]

◆ operator!=() [1/3]

◆ operator!=() [2/3]

◆ operator!=() [3/3]

◆ operator=()

◆ 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() [1/4]

◆ request() [2/4]

◆ request() [3/4]

◆ request() [4/4]

◆ robotModel() [1/2]

◆ robotModel() [2/2]

◆ robotModelEntries() [1/2]

◆ robotModelEntries() [2/2]

◆ set()

◆ setCheck()

◆ text() [1/2]

◆ text() [2/2]

◆ textEntries() [1/2]