QtYARPView Class Reference

The plugin Core class. More...

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/src/guis/yarpview/plugin/qtyarpview.h>

Inheritance diagram for QtYARPView:

Signals
void	optionsSet ()
void	refreshIntervalChanged ()
void	videoProducerChanged ()
void	posXChanged ()
void	posYChanged ()
void	widthChanged ()
void	heightChanged ()
void	sizeChanged ()
void	sendPortFps (QString avg, QString min, QString max)
void	sendDisplayFps (QString avg, QString min, QString max)
void	synchRate (bool check)
void	autosize (bool check)
void	setName (QString name)
void	setTitle (QString inputTitle)

Public Member Functions
	QtYARPView (QQuickItem *parent=0)
	~QtYARPView ()
Q_INVOKABLE void	freeze (bool check)
	Freeze the video stream.
Q_INVOKABLE void	synchDisplayPeriod (bool check)
	Synchs the video stream to the display.
Q_INVOKABLE void	synchDisplaySize (bool check)
	Synchs the size of the window with the size of the video stream.
Q_INVOKABLE void	changeRefreshInterval (int)
	Changes the refresh interval.
Q_INVOKABLE void	saveFrame ()
	Saves the current frame.
Q_INVOKABLE void	setFileName (QUrl url)
	Sets the current filename of the frame is going to be saved.
Q_INVOKABLE void	setFilesName (QUrl url)
	Sets the current filename of the frame set is going to be saved.
Q_INVOKABLE void	startDumpFrames ()
	Saves the current frame set.
Q_INVOKABLE void	stopDumpFrames ()
	Stops the current frame set save mode.
Q_INVOKABLE bool	parseParameters (QStringList)
	parse the parameters received from the main container in QstringList form
Q_INVOKABLE bool	rightClickEnabled ()
Q_INVOKABLE void	clickCoords_2 (int x, int y)
Q_INVOKABLE void	clickCoords_4 (int start_x, int start_y, int end_x, int end_y)
Q_INVOKABLE void	rightClickCoords_2 (int x, int y)
Q_INVOKABLE void	rightClickCoords_4 (int start_x, int start_y, int end_x, int end_y)
Q_INVOKABLE QString	getPixelAsStr (int x, int y)
	Pics the rgb value of the pixel specified by x and y and return it as a string.
QObject *	getVideoProducer ()
	returns the videoproducer that acts as bridge between C++ code and QML VideoOutput.
int	posX ()
int	posY ()
int	windowWidth ()
int	windowHeight ()
int	refreshInterval ()

Properties
QObject *	videoProducer
int	posX
	Returns the x position from the options.
int	posY
	Returns the y position from the options.
int	windowWidth
	Returns the width from the options.
int	windowHeight
	Returns the height from the options.
int	refreshInterval
	Gets the refresh interval from options.

Detailed Description

The plugin Core class.

this is the plugin core class which acts as bridge between the QML and c++. in the C++ code is implemented the backend logic, instead in the QML is implemented the Visual part.

Definition at line 56 of file qtyarpview.h.

Constructor & Destructor Documentation

QtYARPView()

QtYARPView::QtYARPView

(

QQuickItem *

parent = 0

)

Definition at line 10 of file qtyarpview.cpp.

~QtYARPView()

QtYARPView::~QtYARPView

(

)

Definition at line 30 of file qtyarpview.cpp.

Member Function Documentation

autosize

void QtYARPView::autosize ( bool  check )

signal

changeRefreshInterval()

void QtYARPView::changeRefreshInterval

(

int

interval

)

Changes the refresh interval.

Parameters

interval

an int value representing the interval

Definition at line 105 of file qtyarpview.cpp.

clickCoords_2()

void QtYARPView::clickCoords_2	(	int	x,
		int	y
	)

Definition at line 539 of file qtyarpview.cpp.

clickCoords_4()

void QtYARPView::clickCoords_4	(	int	start_x,
		int	start_y,
		int	end_x,
		int	end_y
	)

Definition at line 513 of file qtyarpview.cpp.

freeze()

void QtYARPView::freeze

(

bool

check

)

Freeze the video stream.

Parameters

check

a bool parameter that enables or disables the freeze state

Definition at line 44 of file qtyarpview.cpp.

getPixelAsStr()

QString QtYARPView::getPixelAsStr	(	int	x,
		int	y
	)

Pics the rgb value of the pixel specified by x and y and return it as a string.

Parameters

x	Integer: The x coordinate of the pixel
y	Integer: The y coordinate of the pixel

Definition at line 151 of file qtyarpview.cpp.

getVideoProducer()

QObject * QtYARPView::getVideoProducer

(

)

returns the videoproducer that acts as bridge between C++ code and QML VideoOutput.

Returns

A pointer to the videoproducer

Definition at line 53 of file qtyarpview.cpp.

heightChanged

void QtYARPView::heightChanged ( )

signal

optionsSet

void QtYARPView::optionsSet ( )

signal

parseParameters()

bool QtYARPView::parseParameters

(

QStringList

params

)

parse the parameters received from the main container in QstringList form

Parameters

params

the parameter list

Definition at line 231 of file qtyarpview.cpp.

posX()

int QtYARPView::posX

(

)

posXChanged

void QtYARPView::posXChanged ( )

signal

posY()

int QtYARPView::posY

(

)

posYChanged

void QtYARPView::posYChanged ( )

signal

refreshInterval()

int QtYARPView::refreshInterval

(

)

refreshIntervalChanged

void QtYARPView::refreshIntervalChanged ( )

signal

rightClickCoords_2()

void QtYARPView::rightClickCoords_2	(	int	x,
		int	y
	)

Definition at line 588 of file qtyarpview.cpp.

rightClickCoords_4()

void QtYARPView::rightClickCoords_4	(	int	start_x,
		int	start_y,
		int	end_x,
		int	end_y
	)

Definition at line 562 of file qtyarpview.cpp.

rightClickEnabled()

bool QtYARPView::rightClickEnabled

(

)

Definition at line 611 of file qtyarpview.cpp.

saveFrame()

void QtYARPView::saveFrame

(

)

Saves the current frame.

Definition at line 111 of file qtyarpview.cpp.

sendDisplayFps

void QtYARPView::sendDisplayFps ( QString  avg, QString  min, QString  max  )

signal

sendPortFps

void QtYARPView::sendPortFps ( QString  avg, QString  min, QString  max  )

signal

setFileName()

void QtYARPView::setFileName

(

QUrl

url

)

Sets the current filename of the frame is going to be saved.

Parameters

url	the url to the file

Definition at line 120 of file qtyarpview.cpp.

setFilesName()

void QtYARPView::setFilesName

(

QUrl

url

)

Sets the current filename of the frame set is going to be saved.

Parameters

url	the url to the file

Definition at line 129 of file qtyarpview.cpp.

setName

void QtYARPView::setName ( QString  name )

signal

setTitle

void QtYARPView::setTitle ( QString  inputTitle )

signal

sizeChanged

void QtYARPView::sizeChanged ( )

signal

startDumpFrames()

void QtYARPView::startDumpFrames

(

)

Saves the current frame set.

Definition at line 135 of file qtyarpview.cpp.

stopDumpFrames()

void QtYARPView::stopDumpFrames

(

)

Stops the current frame set save mode.

Definition at line 141 of file qtyarpview.cpp.

synchDisplayPeriod()

void QtYARPView::synchDisplayPeriod

(

bool

check

)

Synchs the video stream to the display.

Parameters

check

a bool parameter that enables or disables the synch option

Definition at line 87 of file qtyarpview.cpp.

synchDisplaySize()

void QtYARPView::synchDisplaySize

(

bool

check

)

Synchs the size of the window with the size of the video stream.

Parameters

check

a bool parameter that enables or disables the synch option

Definition at line 96 of file qtyarpview.cpp.

synchRate

void QtYARPView::synchRate ( bool  check )

signal

videoProducerChanged

void QtYARPView::videoProducerChanged ( )

signal

widthChanged

void QtYARPView::widthChanged ( )

signal

windowHeight()

int QtYARPView::windowHeight

(

)

windowWidth()

int QtYARPView::windowWidth

(

)

Property Documentation

posX

int QtYARPView::posX

read

Returns the x position from the options.

Definition at line 62 of file qtyarpview.h.

posY

int QtYARPView::posY

read

Returns the y position from the options.

Definition at line 63 of file qtyarpview.h.

refreshInterval

int QtYARPView::refreshInterval

read

Gets the refresh interval from options.

Returns

the refresh interval

Definition at line 66 of file qtyarpview.h.

videoProducer

QObject * QtYARPView::videoProducer

read

Definition at line 61 of file qtyarpview.h.

windowHeight

int QtYARPView::windowHeight

read

Returns the height from the options.

Definition at line 65 of file qtyarpview.h.

windowWidth

int QtYARPView::windowWidth

read

Returns the width from the options.

Definition at line 64 of file qtyarpview.h.

---

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

• src/guis/yarpview/plugin/qtyarpview.h
• src/guis/yarpview/plugin/qtyarpview.cpp