YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::sig::ImageLayerData Class Reference

A single layer of a layered image. More...

#include <idl_generated_code/yarp/sig/ImageLayerData.h>

+ Inheritance diagram for yarp::sig::ImageLayerData:

Public Types

typedef yarp::os::idl::Unwrapped< ImageLayerData > unwrapped
 

Public Member Functions

 ImageLayerData ()=default
 
 ImageLayerData (const bool enable, const yarp::sig::FlexImage &layer, const yarp::sig::ImageColorKey &colorkey, const yarp::sig::ImageAlphaData &alpha, const bool can_be_compressed, const std::int32_t offset_x, const std::int32_t offset_y)
 
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
 

Public Attributes

bool enable {true}
 
yarp::sig::FlexImage layer {}
 
yarp::sig::ImageColorKey colorkey {}
 
yarp::sig::ImageAlphaData alpha {}
 
bool can_be_compressed {true}
 
std::int32_t offset_x {0}
 
std::int32_t offset_y {0}
 

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 single layer of a layered image.

Definition at line 28 of file ImageLayerData.h.

Member Typedef Documentation

◆ unwrapped

Constructor & Destructor Documentation

◆ ImageLayerData() [1/2]

yarp::sig::ImageLayerData::ImageLayerData ( )
default

◆ ImageLayerData() [2/2]

yarp::sig::ImageLayerData::ImageLayerData ( const bool  enable,
const yarp::sig::FlexImage &  layer,
const yarp::sig::ImageColorKey &  colorkey,
const yarp::sig::ImageAlphaData &  alpha,
const bool  can_be_compressed,
const std::int32_t  offset_x,
const std::int32_t  offset_y 
)

Definition at line 16 of file ImageLayerData.cpp.

Member Function Documentation

◆ read() [1/2]

bool yarp::sig::ImageLayerData::read ( yarp::os::ConnectionReader &  reader)
overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters
readeran interface to the network connection for reading
Returns
true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 65 of file ImageLayerData.cpp.

◆ read() [2/2]

bool yarp::sig::ImageLayerData::read ( yarp::os::idl::WireReader &  reader)
overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 35 of file ImageLayerData.cpp.

◆ toString()

std::string yarp::sig::ImageLayerData::toString ( ) const

Definition at line 121 of file ImageLayerData.cpp.

◆ write() [1/2]

bool yarp::sig::ImageLayerData::write ( const yarp::os::idl::WireWriter &  writer) const
overridevirtual

Reimplemented from yarp::os::idl::WirePortable.

Definition at line 78 of file ImageLayerData.cpp.

◆ write() [2/2]

bool yarp::sig::ImageLayerData::write ( yarp::os::ConnectionWriter &  writer) const
overridevirtual

Write this object to a network connection.

Override this for your particular class. Be aware that depending on the nature of the connections a port has, and what protocol they use, and how efficient the YARP implementation is, this method may be called once, twice, or many times, as the result of a single call to Port::write

Parameters
writeran interface to the network connection for writing
Returns
true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 108 of file ImageLayerData.cpp.

Member Data Documentation

◆ alpha

yarp::sig::ImageAlphaData yarp::sig::ImageLayerData::alpha {}

Definition at line 36 of file ImageLayerData.h.

◆ can_be_compressed

bool yarp::sig::ImageLayerData::can_be_compressed {true}

Definition at line 37 of file ImageLayerData.h.

◆ colorkey

yarp::sig::ImageColorKey yarp::sig::ImageLayerData::colorkey {}

Definition at line 35 of file ImageLayerData.h.

◆ enable

bool yarp::sig::ImageLayerData::enable {true}

Definition at line 33 of file ImageLayerData.h.

◆ layer

yarp::sig::FlexImage yarp::sig::ImageLayerData::layer {}

Definition at line 34 of file ImageLayerData.h.

◆ offset_x

std::int32_t yarp::sig::ImageLayerData::offset_x {0}

Definition at line 38 of file ImageLayerData.h.

◆ offset_y

std::int32_t yarp::sig::ImageLayerData::offset_y {0}

Definition at line 39 of file ImageLayerData.h.


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