Client for the remoting server provided by ShelfModel. More...

#include <remoteshelfmodel.h>

Inheritance diagram for RemoteShelfModel:

[legend]

Collaboration diagram for RemoteShelfModel:

[legend]

Signals
void	readyChanged () const
	Whether the connection is healthy and remote data is available.

void	serverAddressChanged () const
	The address used to connect to a ShelfModel instance has changed.

void	enabledChanged () const

void	rowsChanged () const

void	columnsChanged () const

void	densityChanged () const

void	wallThicknessChanged () const

void	shelfRowsChanged () const

void	shelfColumnsChanged () const

void	brightnessChanged () const

void	animateBrightnessTransitionsChanged () const

void	averageColorChanged () const

void	animateAverageColorTransitionsChanged () const

void	transitionDurationChanged () const

void	animatingChanged () const

Public Member Functions
	RemoteShelfModel (QObject *parent=nullptr)
	Create a remote client to a ShelfModel.

QUrl	serverAddress () const
	The address used to connect to a ShelfModel instance.

void	setServerAddress (const QUrl &url)
	Set the address used to connect to a ShelfModel instance.

bool	ready () const
	Whether the connection is healthy and remote data is available.

bool	enabled () const

void	setEnabled (bool enabled)

int	rows () const

void	setRows (int rows)

int	columns () const

void	setColumns (int columns)

int	density () const

void	setDensity (int density)

int	wallThickness () const

void	setWallThickness (int thickness)

qreal	brightness () const

void	setBrightness (qreal brightness)

bool	animateBrightnessTransitions () const

void	setAnimateBrightnessTransitions (bool animate)

QColor	averageColor () const

void	setAverageColor (const QColor &color)

bool	animateAverageColorTransitions () const

void	setAnimateAverageColorTransitions (bool animate)

int	transitionDuration () const

void	setTransitionDuration (int duration)

bool	animating () const

void	setAnimating (bool animating)

void	classBegin () override
	Implements the `QQmlParserStatus` interface.

void	componentComplete () override
	Implements the `QQmlParserStatus` interface.

Properties
QUrl	serverAddress
	Address used to connect to a ShelfModel instance.

bool	ready
	Whether the connection is healthy and remote data is available.

bool	enabled

int	rows

int	columns

int	density

int	wallThickness

qreal	brightness

bool	animateBrightnessTransitions

QColor	averageColor

bool	animateAverageColorTransitions

int	transitionDuration

bool	animating

Detailed Description

Client for the remoting server provided by ShelfModel.

Connects to the remoting server provided by a ShelfModel instance and makes most of the ShelfModel API available out of process or over the network. This allows running the onboard GUI out of process and also enables the PC/Android offboard instances of the application.

For detailed documentation of the mirrored API please see ShelfModel.

Communication between RemoteShelfModel and ShelfModel is implemented using Qt Remote Objects.

Implements QQmlParserStatus for use from QML.

See also: ShelfModel; QAbstractListModel; QQmlParserStatus

Constructor & Destructor Documentation

◆ RemoteShelfModel()

RemoteShelfModel::RemoteShelfModel ( QObject * parent = nullptr )

explicit

Create a remote client to a ShelfModel.

Parameters

parent Parent object

Member Function Documentation

◆ animateAverageColorTransitions()

bool RemoteShelfModel::animateAverageColorTransitions ( ) const

See also: ShelfModel::animateAverageColorTransitions

◆ animateAverageColorTransitionsChanged

void RemoteShelfModel::animateAverageColorTransitionsChanged ( ) const

signal

See also: ShelfModel::animateAverageColorTransitionsChanged

◆ animateBrightnessTransitions()

bool RemoteShelfModel::animateBrightnessTransitions ( ) const

See also: ShelfModel::animateBrightnessTransitions

◆ animateBrightnessTransitionsChanged

void RemoteShelfModel::animateBrightnessTransitionsChanged ( ) const

signal

See also: ShelfModel::animateBrightnessTransitionsChanged

◆ animating()

bool RemoteShelfModel::animating ( ) const

See also: ShelfModel::animating

◆ animatingChanged

void RemoteShelfModel::animatingChanged ( ) const

signal

See also: ShelfModel::animatingChanged

◆ averageColor()

QColor RemoteShelfModel::averageColor ( ) const

See also: ShelfModel::averageColor

◆ averageColorChanged

void RemoteShelfModel::averageColorChanged ( ) const

signal

See also: ShelfModel::averageColorChanged

◆ brightness()

qreal RemoteShelfModel::brightness ( ) const

See also: ShelfModel::brightness

◆ brightnessChanged

void RemoteShelfModel::brightnessChanged ( ) const

signal

See also: ShelfModel::brightnessChanged

◆ columns()

int RemoteShelfModel::columns ( ) const

See also: ShelfModel::columns

◆ columnsChanged

void RemoteShelfModel::columnsChanged ( ) const

signal

See also: ShelfModel::columnsChanged

◆ density()

int RemoteShelfModel::density ( ) const

See also: ShelfModel::density

◆ densityChanged

void RemoteShelfModel::densityChanged ( ) const

signal

See also: ShelfModel::densityChanged

◆ enabled()

bool RemoteShelfModel::enabled ( ) const

See also: ShelfModel::enabled

◆ enabledChanged

void RemoteShelfModel::enabledChanged ( ) const

signal

See also: ShelfModel::enabledChanged

◆ ready()

bool RemoteShelfModel::ready ( ) const

Whether the connection is healthy and remote data is available.

Returns: Ready or not.

See also: serverAddress

◆ readyChanged

void RemoteShelfModel::readyChanged ( ) const

signal

Whether the connection is healthy and remote data is available.

See also: ready

◆ rows()

int RemoteShelfModel::rows ( ) const

See also: ShelfModel::rows

◆ rowsChanged

void RemoteShelfModel::rowsChanged ( ) const

signal

See also: ShelfModel::rowsChanged

◆ serverAddress()

QUrl RemoteShelfModel::serverAddress ( ) const

The address used to connect to a ShelfModel instance.

Returns: Server address, e.g. tcp:// or local:.

See also: serverAddress (property); setServerAddress; serverAddressChanged

◆ serverAddressChanged

void RemoteShelfModel::serverAddressChanged ( ) const

signal

The address used to connect to a ShelfModel instance has changed.

See also: serverAddress; setServerAddress

◆ setAnimateAverageColorTransitions()

void RemoteShelfModel::setAnimateAverageColorTransitions ( bool animate )

See also: ShelfModel::setAnimateAverageColorTransitions

◆ setAnimateBrightnessTransitions()

void RemoteShelfModel::setAnimateBrightnessTransitions ( bool animate )

See also: ShelfModel::setAnimateBrightnessTransitions

◆ setAnimating()

void RemoteShelfModel::setAnimating ( bool animating )

See also: ShelfModel::setAnimating

◆ setAverageColor()

void RemoteShelfModel::setAverageColor ( const QColor & color )

See also: ShelfModel::setAverageColor

◆ setBrightness()

void RemoteShelfModel::setBrightness ( qreal brightness )

See also: ShelfModel::setBrightness

◆ setColumns()

void RemoteShelfModel::setColumns ( int columns )

See also: ShelfModel::setColumns

◆ setDensity()

void RemoteShelfModel::setDensity ( int density )

See also: ShelfModel::setDensity

◆ setEnabled()

void RemoteShelfModel::setEnabled ( bool enabled )

See also: ShelfModel::setEnabled

◆ setRows()

void RemoteShelfModel::setRows ( int rows )

See also: ShelfModel::setRows

◆ setServerAddress()

void RemoteShelfModel::setServerAddress ( const QUrl & url )

Set the address used to connect to a ShelfModel instance.

Parameters

url	Server address, e.g. `tcp://` or `local:`.

See also: serverAddress; serverAddressChanged

◆ setTransitionDuration()

void RemoteShelfModel::setTransitionDuration ( int duration )

See also: ShelfModel::setTransitionDuration

◆ setWallThickness()

void RemoteShelfModel::setWallThickness ( int thickness )

See also: ShelfModel::setWallThickness

◆ shelfColumnsChanged

void RemoteShelfModel::shelfColumnsChanged ( ) const

signal

See also: ShelfModel::shelfColumnsChanged

◆ shelfRowsChanged

void RemoteShelfModel::shelfRowsChanged ( ) const

signal

See also: ShelfModel::shelfRowsChanged

◆ transitionDuration()

int RemoteShelfModel::transitionDuration ( ) const

See also: ShelfModel::transitionDuration

◆ transitionDurationChanged

void RemoteShelfModel::transitionDurationChanged ( ) const

signal

See also: ShelfModel::transitionDurationChanged

◆ wallThickness()

int RemoteShelfModel::wallThickness ( ) const

See also: ShelfModel::wallThickness

◆ wallThicknessChanged

void RemoteShelfModel::wallThicknessChanged ( ) const

signal

See also: ShelfModel::wallThicknessChanged

Property Documentation

◆ animateAverageColorTransitions

bool RemoteShelfModel::animateAverageColorTransitions

readwrite

See also: ShelfModel::animateAverageColorTransitions

◆ animateBrightnessTransitions

bool RemoteShelfModel::animateBrightnessTransitions

readwrite

See also: ShelfModel::animateBrightnessTransitions

◆ animating

bool RemoteShelfModel::animating

readwrite

See also: ShelfModel::animating

◆ averageColor

QColor RemoteShelfModel::averageColor

readwrite

See also: ShelfModel::averageColor

◆ brightness

qreal RemoteShelfModel::brightness

readwrite

See also: ShelfModel::brightness

◆ columns

int RemoteShelfModel::columns

readwrite

See also: ShelfModel::columns

◆ density

int RemoteShelfModel::density

readwrite

See also: ShelfModel::density

◆ enabled

bool RemoteShelfModel::enabled

readwrite

See also: ShelfModel::enabled

◆ ready

bool RemoteShelfModel::ready

read

Whether the connection is healthy and remote data is available.

See also: serverAddress

◆ rows

int RemoteShelfModel::rows

readwrite

See also: ShelfModel::rows

◆ serverAddress

QUrl RemoteShelfModel::serverAddress

readwrite

Address used to connect to a ShelfModel instance.

Can be e.g. tcp:// or local:.

Defaults to tcp://192.168.178.129:8042.

See also: setServerAddress; serverAddressChanged

◆ transitionDuration

int RemoteShelfModel::transitionDuration

readwrite

See also: ShelfModel::transitionDuration

◆ wallThickness

int RemoteShelfModel::wallThickness

readwrite

See also: ShelfModel::wallThickness

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

/__w/hyelicht/hyelicht/src/remoteshelfmodel.h
/__w/hyelicht/hyelicht/src/remoteshelfmodel.cpp

Signals

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ RemoteShelfModel()

Member Function Documentation

◆ animateAverageColorTransitions()

◆ animateAverageColorTransitionsChanged

◆ animateBrightnessTransitions()

◆ animateBrightnessTransitionsChanged

◆ animating()

◆ animatingChanged

◆ averageColor()

◆ averageColorChanged

◆ brightness()

◆ brightnessChanged

◆ columns()

◆ columnsChanged

◆ density()

◆ densityChanged

◆ enabled()

◆ enabledChanged

◆ ready()

◆ readyChanged

◆ rows()

◆ rowsChanged

◆ serverAddress()

◆ serverAddressChanged

◆ setAnimateAverageColorTransitions()

◆ setAnimateBrightnessTransitions()

◆ setAnimating()

◆ setAverageColor()

◆ setBrightness()

◆ setColumns()

◆ setDensity()

◆ setEnabled()

◆ setRows()

◆ setServerAddress()

◆ setTransitionDuration()

◆ setWallThickness()

◆ shelfColumnsChanged

◆ shelfRowsChanged

◆ transitionDuration()

◆ transitionDurationChanged

◆ wallThickness()

◆ wallThicknessChanged

Property Documentation

◆ animateAverageColorTransitions

◆ animateBrightnessTransitions

◆ animating

◆ averageColor

◆ brightness

◆ columns

◆ density

◆ enabled

◆ ready

◆ rows

◆ serverAddress

◆ transitionDuration

◆ wallThickness