RobWorkProject
Classes | Public Types | Public Member Functions | List of all members
ImageLoader Class Referenceabstract

Image loader interface. More...

#include <ImageLoader.hpp>

Inherited by PGMLoader, PPMLoader, and RGBLoader.

Classes

class  Factory
 a factory for ImageLoader. This factory also defines an extension point for image loaders. More...
 

Public Types

typedef rw::common::Ptr< ImageLoaderPtr
 smart pointer type
 

Public Member Functions

virtual ~ImageLoader ()
 destructor
 
virtual rw::sensor::Image::Ptr loadImage (const std::string &filename)=0
 
virtual std::vector< std::string > getImageFormats ()=0
 get the list of supported image formats (as extensions) example (PNG,PGM,GIF) More...
 
virtual bool isImageSupported (const std::string &format)
 

Detailed Description

Image loader interface.

Member Function Documentation

◆ getImageFormats()

virtual std::vector<std::string> getImageFormats ( )
pure virtual

get the list of supported image formats (as extensions) example (PNG,PGM,GIF)

Returns

Implemented in PGMLoader, PPMLoader, and RGBLoader.

◆ isImageSupported()

virtual bool isImageSupported ( const std::string &  format)
virtual
Parameters
format
Returns

◆ loadImage()

virtual rw::sensor::Image::Ptr loadImage ( const std::string &  filename)
pure virtual
Parameters
filename[in] name of the file that is to be loaded.
Returns
if loaded successfully a pointer to the image is returned else NULL

Implemented in PGMLoader, PPMLoader, and RGBLoader.


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