yarp::sig::LayeredImage Class Reference

A Layered Image, composed by a background and multiple layers. More...

#include <yarp/sig/LayeredImage.h>

Inheritance diagram for yarp::sig::LayeredImage:

Public Member Functions
	LayeredImage ()
	Default constructor.
	LayeredImage (const LayeredImage &alt)
	Copy constructor.
	LayeredImage (LayeredImage &&other) noexcept
	Move constructor.
LayeredImage &	operator= (const LayeredImage &alt)
	Assignment operator.
LayeredImage &	operator= (LayeredImage &&other) noexcept
	Move assignment operator.
bool	operator== (const LayeredImage &alt) const
	Comparison operator.
	~LayeredImage () override
	Destructor.
yarp::sig::FlexImage	convert_to_flexImage ()
	Conversion operator.
	operator yarp::sig::FlexImage ()
	Conversion operator.
void	clear ()
	Clear the layered Image.
bool	read (yarp::os::ConnectionReader &connection) override
	Read a LayeredImage from a connection.
bool	write (yarp::os::ConnectionWriter &connection) const override
	Write a LayeredImage to a connection.
yarp::os::Type	getReadType () const override
Public Member Functions inherited from yarp::os::Portable
virtual Type	getType () const
Public Member Functions inherited from yarp::os::PortReader
virtual	~PortReader ()
	Destructor.
Public Member Functions inherited from yarp::os::PortWriter
virtual	~PortWriter ()
	Destructor.
virtual void	onCompletion () const
	This is called when the port has finished all writing operations.
virtual void	onCommencement () const
	This is called when the port is about to begin writing operations.
virtual yarp::os::Type	getWriteType () const

Public Attributes
yarp::sig::FlexImage	background
std::vector< yarp::sig::ImageLayer >	layers

Additional Inherited Members
Static Public Member Functions inherited from yarp::os::Portable
static bool	copyPortable (const PortWriter &writer, PortReader &reader)
	Copy one portable to another, via writing and reading.

Detailed Description

A Layered Image, composed by a background and multiple layers.

Definition at line 80 of file LayeredImage.h.

Constructor & Destructor Documentation

LayeredImage() [1/3]

LayeredImage::LayeredImage

(

)

Default constructor.

Creates an empty LayeredImage.

Definition at line 71 of file LayeredImage.cpp.

LayeredImage() [2/3]

LayeredImage::LayeredImage

(

const LayeredImage &

alt

)

Copy constructor.

Clones the content of another LayeredImage.

Parameters

alt	the LayeredImage to clone

Definition at line 186 of file LayeredImage.cpp.

LayeredImage() [3/3]

LayeredImage::LayeredImage ( LayeredImage &&  other )

noexcept

Move constructor.

Parameters

other

the LayeredImage to be moved

Definition at line 193 of file LayeredImage.cpp.

~LayeredImage()

LayeredImage::~LayeredImage ( )

override

Destructor.

Definition at line 76 of file LayeredImage.cpp.

Member Function Documentation

clear()

void LayeredImage::clear

(

)

Clear the layered Image.

Definition at line 81 of file LayeredImage.cpp.

convert_to_flexImage()

yarp::sig::FlexImage LayeredImage::convert_to_flexImage

(

)

Conversion operator.

Definition at line 238 of file LayeredImage.cpp.

getReadType()

yarp::os::Type yarp::sig::LayeredImage::getReadType ( ) const

inlineoverridevirtual

Reimplemented from yarp::os::PortReader.

Definition at line 162 of file LayeredImage.h.

operator yarp::sig::FlexImage()

LayeredImage::operator yarp::sig::FlexImage

(

)

Conversion operator.

Definition at line 256 of file LayeredImage.cpp.

operator=() [1/2]

LayeredImage & LayeredImage::operator=

(

const LayeredImage &

alt

)

Assignment operator.

Clones the content of another LayeredImage.

Parameters

alt	the LayeredImage to clone

Definition at line 197 of file LayeredImage.cpp.

operator=() [2/2]

LayeredImage & yarp::sig::LayeredImage::operator= ( LayeredImage &&  other )

noexcept

Move assignment operator.

Parameters

other

the LayeredImage to be moved

Returns

this object

operator==()

bool LayeredImage::operator==

(

const LayeredImage &

alt

)

const

Comparison operator.

Compares two LayeredImage

Returns

true if the two LayeredImages are identical

Definition at line 204 of file LayeredImage.cpp.

read()

bool LayeredImage::read ( yarp::os::ConnectionReader &  connection )

overridevirtual

Read a LayeredImage from a connection.

Returns

true iff LayeredImage was read correctly

Implements yarp::os::Portable.

Definition at line 87 of file LayeredImage.cpp.

write()

bool LayeredImage::write ( yarp::os::ConnectionWriter &  connection ) const

overridevirtual

Write a LayeredImage to a connection.

Returns

true iff LayeredImage was written correctly

Implements yarp::os::Portable.

Definition at line 143 of file LayeredImage.cpp.

Member Data Documentation

background

yarp::sig::FlexImage yarp::sig::LayeredImage::background

Definition at line 84 of file LayeredImage.h.

layers

std::vector<yarp::sig::ImageLayer> yarp::sig::LayeredImage::layers

Definition at line 85 of file LayeredImage.h.

---

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

• src/libYARP_sig/src/yarp/sig/LayeredImage.h
• src/libYARP_sig/src/yarp/sig/LayeredImage.cpp