RobWorkProject  24.12.4-
Modules | Classes | Typedefs | Functions
Loaders

Workcell loaders and other loaders. More...

Modules

 Extension Points
 This group should contain all extension points of RobWork.
 

Classes

class  ImageLoader
 Image loader interface. More...
 
class  ImageLoader::Factory
 a factory for ImageLoader. This factory also defines an extension point for image loaders. More...
 
class  LoaderAssimp
 Load 3D models using the Open Asset Import Library (Assimp). More...
 
class  Model3DLoader
 interface for classes that are able to load 3d models More...
 

Typedefs

typedef rw::core::Ptr< ImageLoaderPtr
 smart pointer type
 
typedef ImageLoader::Factory ImageFactory
 Shortcut type for the ImageLoader::Factory. More...
 

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)
 
 Factory ()
 constructor
 
static rw::core::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...
 

Detailed Description

Workcell loaders and other loaders.

Typedef Documentation

◆ ImageFactory

Shortcut type for the ImageLoader::Factory.

Deprecated:
Please use ImageLoader::Factory instead.

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 RGBLoader, PPMLoader, and PGMLoader.

◆ getImageLoader()

static rw::core::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

◆ isImageSupported()

virtual bool isImageSupported ( const std::string &  format)
virtual
Parameters
format
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.

◆ 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 RGBLoader, PPMLoader, and PGMLoader.