RobWorkProject
Public Member Functions | Static Public Member Functions | List of all members
ImageLoader::Factory Class Reference

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

#include <ImageLoader.hpp>

Inherits ExtensionPoint< ImageLoader >.

Public Member Functions

 Factory ()
 constructor
 
- Public Member Functions inherited from ExtensionPoint< ImageLoader >
 ExtensionPoint (const std::string &id, const std::string &name, Plugin *plugin=NULL)
 Constructor. More...
 
const std::string & getId () const
 get unique identifier of this extensionpoint
 
const std::string & getName () const
 get human readable name of this extension point
 
const rw::common::PropertyMapgetSchema () const
 the schema describe the possible properties/configurations elements which is used in the PropertyMap. It contain examples of all possible configuration options. This can be used to configure any extensions that needs to attach to this extension point.
 
std::vector< Extension::DescriptorgetExtensionDescriptors () const
 get all extension descriptions of this extension point
 
std::vector< rw::common::Ptr< Extension > > getExtensions () const
 get all extensions of this extension point
 

Static Public Member Functions

static rw::common::Ptr< ImageLoadergetImageLoader (const std::string &format)
 get an image loader for a specific file format More...
 
static bool hasImageLoader (const std::string &format)
 test if a imageloader for a specific fileformat exists. More...
 
static std::vector< std::string > getSupportedFormats ()
 get a list of supported formats More...
 
static rw::sensor::Image::Ptr load (const std::string &filename)
 Loads/imports an image from a file. More...
 

Additional Inherited Members

- Public Types inherited from ExtensionPoint< ImageLoader >
typedef rw::common::Ptr< ExtensionPointPtr
 smart pointer type of ExtensionPoint
 
- Protected Member Functions inherited from ExtensionPoint< ImageLoader >
rw::common::PropertyMapgetSchema ()
 the schema describe the possible properties/configurations elements which is used in the PropertyMap. The schema property map should just be loaded with all possible configuration options which the extension might use. More...
 

Detailed Description

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

Member Function Documentation

◆ getImageLoader()

static rw::common::Ptr<ImageLoader> getImageLoader ( const std::string &  format)
static

get an image loader for a specific file format

Parameters
format[in] image format eg. png, jpeg, ...
Returns

◆ getSupportedFormats()

static std::vector<std::string> getSupportedFormats ( )
static

get a list of supported formats

Returns

◆ hasImageLoader()

static bool hasImageLoader ( const std::string &  format)
static

test if a imageloader for a specific fileformat exists.

Parameters
format[in] image format eg. png, jpeg ...
Returns

◆ load()

static rw::sensor::Image::Ptr load ( const std::string &  filename)
static

Loads/imports an image from a file.

An exception is thrown if the file can't be loaded.

Parameters
filename[in] name of image file.

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