Visualization Library v1.0.3

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | Protected Attributes

vl::ResourceLoadWriter Class Reference

The ResourceLoadWriter class is an abstract class used to implement read/write support for one or more resource types. More...

#include <ResourceLoadWriter.hpp>

Inheritance diagram for vl::ResourceLoadWriter:
vl::Object vl::LoadWriter3DS vl::LoadWriterAC3D vl::LoadWriterBMP vl::LoadWriterDae vl::LoadWriterDAT vl::LoadWriterDDS vl::LoadWriterDICOM vl::LoadWriterJPG vl::LoadWriterMD2 vl::LoadWriterOBJ vl::LoadWriterPLY vl::LoadWriterPNG vl::LoadWriterSTL vl::LoadWriterTGA vl::LoadWriterTIFF vl::LoadWriterVLX

List of all members.

Public Member Functions

 ResourceLoadWriter (const String &load_extensions, const String &write_extensions)
virtual ref< ResourceDatabaseloadResource (const String &path) const =0
virtual ref< ResourceDatabaseloadResource (VirtualFile *file) const =0
virtual bool writeResource (const String &path, ResourceDatabase *resource) const =0
virtual bool writeResource (VirtualFile *file, ResourceDatabase *resource) const =0
bool canLoad (const String &extension) const
 Returns true if the given file type can be loaded.
const StringloadExtensions () const
 Returns the string containing the file types that can be loaded.
void setLoadExtensions (const String &extensions)
 Sets the set of file extensions that can be loaded.
bool canWrite (const String &extension) const
 Returns true if the given file type can be written.
const StringwriteExtensions () const
 Returns the string containing the file types that can be written.
void setWriteExtensions (const String &extensions)
 Sets the set of file extensions that can be written.

Protected Attributes

String mLoadExtensions
String mWriteExtensions

Detailed Description

The ResourceLoadWriter class is an abstract class used to implement read/write support for one or more resource types.

Definition at line 44 of file ResourceLoadWriter.hpp.


Constructor & Destructor Documentation

vl::ResourceLoadWriter::ResourceLoadWriter ( const String load_extensions,
const String write_extensions 
) [inline]

Definition at line 49 of file ResourceLoadWriter.hpp.


Member Function Documentation

virtual ref<ResourceDatabase> vl::ResourceLoadWriter::loadResource ( const String path ) const [pure virtual]
virtual ref<ResourceDatabase> vl::ResourceLoadWriter::loadResource ( VirtualFile file ) const [pure virtual]
virtual bool vl::ResourceLoadWriter::writeResource ( const String path,
ResourceDatabase resource 
) const [pure virtual]
virtual bool vl::ResourceLoadWriter::writeResource ( VirtualFile file,
ResourceDatabase resource 
) const [pure virtual]
bool vl::ResourceLoadWriter::canLoad ( const String extension ) const [inline]

Returns true if the given file type can be loaded.

Note that the check is not case sensitive.

Definition at line 58 of file ResourceLoadWriter.hpp.

References vl::String::find(), mLoadExtensions, and vl::String::toLowerCase().

const String& vl::ResourceLoadWriter::loadExtensions (  ) const [inline]

Returns the string containing the file types that can be loaded.

The extensions returned are always lower-case.

Definition at line 62 of file ResourceLoadWriter.hpp.

References mLoadExtensions.

void vl::ResourceLoadWriter::setLoadExtensions ( const String extensions ) [inline]

Sets the set of file extensions that can be loaded.

The string must be of the form "|.ext1|.ext2|.ext3|" for example "|.jpg|.png|.gif|". Note that the file extension matching is non case sensitive, so for example the above extension includes also files with the following extensions: .JPG .Png, GiF and so on.

Definition at line 68 of file ResourceLoadWriter.hpp.

References mLoadExtensions, and vl::String::toLowerCase().

bool vl::ResourceLoadWriter::canWrite ( const String extension ) const [inline]

Returns true if the given file type can be written.

Note that the check is not case sensitive.

Definition at line 72 of file ResourceLoadWriter.hpp.

References vl::String::find(), mWriteExtensions, and vl::String::toLowerCase().

const String& vl::ResourceLoadWriter::writeExtensions (  ) const [inline]

Returns the string containing the file types that can be written.

The extensions returned are always lower-case.

Definition at line 76 of file ResourceLoadWriter.hpp.

References mWriteExtensions.

void vl::ResourceLoadWriter::setWriteExtensions ( const String extensions ) [inline]

Sets the set of file extensions that can be written.

The string must be of the form "|.ext1|.ext2|.ext3|" for example "|.jpg|.png|.gif|". Note that the file extension matching is non case sensitive, so for example the above extension includes also files with the following extensions: .JPG .Png, GiF and so on.

Definition at line 82 of file ResourceLoadWriter.hpp.

References mWriteExtensions, and vl::String::toLowerCase().


Member Data Documentation

Definition at line 85 of file ResourceLoadWriter.hpp.

Referenced by canLoad(), loadExtensions(), and setLoadExtensions().

Definition at line 86 of file ResourceLoadWriter.hpp.

Referenced by canWrite(), setWriteExtensions(), and writeExtensions().


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

Visualization Library v1.0.3 Reference Documentation
Copyright Michele Bosi. All rights reserved.
Updated on Tue Feb 7 2017 00:55:07.
Permission is granted to use this page to write and publish articles regarding Visualization Library.