YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
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.
 
virtual ~LayeredImage ()
 Destructor.
 
yarp::sig::FlexImage convert_to_flexImage ()
 Conversion operator.
 
 operator yarp::sig::FlexImage ()
 Conversion operator.
 
void clear ()
 Clear the layered Image.
 
- Public Member Functions inherited from yarp::sig::LayeredImageData
 LayeredImageData ()=default
 
 LayeredImageData (const yarp::sig::FlexImage &background, const std::vector< yarp::sig::ImageLayer > &layers)
 
bool read (yarp::os::idl::WireReader &reader) override
 
bool read (yarp::os::ConnectionReader &connection) override
 Read this object from a network connection.
 
bool write (const yarp::os::idl::WireWriter &writer) const override
 
bool write (yarp::os::ConnectionWriter &connection) const override
 Write this object to a network connection.
 
std::string toString () const
 
- Public Member Functions inherited from yarp::os::idl::WirePortable
virtual bool readBare (yarp::os::ConnectionReader &reader)
 
virtual bool writeBare (yarp::os::ConnectionWriter &writer) const
 
virtual bool readBottle (yarp::os::ConnectionReader &reader)
 
virtual bool writeBottle (yarp::os::ConnectionWriter &writer) const
 
- Public Member Functions inherited from yarp::os::Portable
virtual Type getType () const
 
- Public Member Functions inherited from yarp::os::PortReader
virtual ~PortReader ()
 Destructor.
 
virtual Type getReadType () const
 
- 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
 

Additional Inherited Members

- Public Types inherited from yarp::sig::LayeredImageData
typedef yarp::os::idl::Unwrapped< LayeredImageData > unwrapped
 
- 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.
 
- Public Attributes inherited from yarp::sig::LayeredImageData
yarp::sig::FlexImage background {}
 
std::vector< yarp::sig::ImageLayer > layers {}
 

Detailed Description

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

Definition at line 23 of file LayeredImage.h.

Constructor & Destructor Documentation

◆ LayeredImage() [1/3]

LayeredImage::LayeredImage ( )

Default constructor.

Creates an empty LayeredImage.

Definition at line 29 of file LayeredImage.cpp.

◆ LayeredImage() [2/3]

LayeredImage::LayeredImage ( const LayeredImage &  alt)

Copy constructor.

Clones the content of another LayeredImage.

Parameters
altthe LayeredImage to clone

Definition at line 45 of file LayeredImage.cpp.

◆ LayeredImage() [3/3]

LayeredImage::LayeredImage ( LayeredImage &&  other)
noexcept

Move constructor.

Parameters
otherthe LayeredImage to be moved

Definition at line 52 of file LayeredImage.cpp.

◆ ~LayeredImage()

LayeredImage::~LayeredImage ( )
virtual

Destructor.

Definition at line 34 of file LayeredImage.cpp.

Member Function Documentation

◆ clear()

void LayeredImage::clear ( )

Clear the layered Image.

Definition at line 39 of file LayeredImage.cpp.

◆ convert_to_flexImage()

yarp::sig::FlexImage LayeredImage::convert_to_flexImage ( )

Conversion operator.

Definition at line 97 of file LayeredImage.cpp.

◆ operator yarp::sig::FlexImage()

LayeredImage::operator yarp::sig::FlexImage ( )

Conversion operator.

Definition at line 115 of file LayeredImage.cpp.

◆ operator=() [1/2]

LayeredImage & LayeredImage::operator= ( const LayeredImage &  alt)

Assignment operator.

Clones the content of another LayeredImage.

Parameters
altthe LayeredImage to clone

Definition at line 56 of file LayeredImage.cpp.

◆ operator=() [2/2]

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

Move assignment operator.

Parameters
otherthe 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 63 of file LayeredImage.cpp.


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