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:

List of all members.

Public Member Functions
virtual const char *	className ()
	Returns the name of the class.
	ResourceLoadWriter (const String &load_extensions, const String &write_extensions)
virtual ref< ResourceDatabase >	loadResource (const String &path) const =0
virtual ref< ResourceDatabase >	loadResource (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 String &	loadExtensions () 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 String &	writeExtensions () 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.

---

Constructor & Destructor Documentation

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

---

Member Function Documentation

virtual const char* vl::ResourceLoadWriter::className

(

)

[inline, virtual]

Returns the name of the class.

Reimplemented from vl::Object.

Reimplemented in vl::LoadWriter3DS, vl::LoadWriterAC3D, vl::LoadWriterBMP, vl::LoadWriterDAT, vl::LoadWriterDDS, vl::LoadWriterDICOM, vl::LoadWriterJPG, vl::LoadWriterMD2, vl::LoadWriterOBJ, vl::LoadWriterPLY, vl::LoadWriterPNG, vl::LoadWriterSTL, vl::LoadWriterTGA, and vl::LoadWriterTIFF.

virtual ref<ResourceDatabase> vl::ResourceLoadWriter::loadResource

(

const String &

path

)

const [pure virtual]

Implemented in vl::LoadWriter3DS, vl::LoadWriterAC3D, vl::LoadWriterBMP, vl::LoadWriterDAT, vl::LoadWriterDDS, vl::LoadWriterDICOM, vl::LoadWriterJPG, vl::LoadWriterMD2, vl::LoadWriterOBJ, vl::LoadWriterPLY, vl::LoadWriterPNG, vl::LoadWriterSTL, vl::LoadWriterTGA, and vl::LoadWriterTIFF.

virtual ref<ResourceDatabase> vl::ResourceLoadWriter::loadResource

(

VirtualFile *

file

)

const [pure virtual]

Implemented in vl::LoadWriter3DS, vl::LoadWriterAC3D, vl::LoadWriterBMP, vl::LoadWriterDAT, vl::LoadWriterDDS, vl::LoadWriterDICOM, vl::LoadWriterJPG, vl::LoadWriterMD2, vl::LoadWriterOBJ, vl::LoadWriterPLY, vl::LoadWriterPNG, vl::LoadWriterSTL, vl::LoadWriterTGA, and vl::LoadWriterTIFF.

virtual bool vl::ResourceLoadWriter::writeResource	(	const String &	path,
		ResourceDatabase *	resource
	)			const [pure virtual]

Implemented in vl::LoadWriter3DS, vl::LoadWriterAC3D, vl::LoadWriterBMP, vl::LoadWriterDAT, vl::LoadWriterDDS, vl::LoadWriterDICOM, vl::LoadWriterJPG, vl::LoadWriterMD2, vl::LoadWriterOBJ, vl::LoadWriterPLY, vl::LoadWriterPNG, vl::LoadWriterSTL, vl::LoadWriterTGA, and vl::LoadWriterTIFF.

virtual bool vl::ResourceLoadWriter::writeResource	(	VirtualFile *	file,
		ResourceDatabase *	resource
	)			const [pure virtual]

Implemented in vl::LoadWriter3DS, vl::LoadWriterAC3D, vl::LoadWriterBMP, vl::LoadWriterDAT, vl::LoadWriterDDS, vl::LoadWriterDICOM, vl::LoadWriterJPG, vl::LoadWriterMD2, vl::LoadWriterOBJ, vl::LoadWriterPLY, vl::LoadWriterPNG, vl::LoadWriterSTL, vl::LoadWriterTGA, and vl::LoadWriterTIFF.

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.

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.

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.

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.

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.

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.

---

Member Data Documentation

String vl::ResourceLoadWriter::mLoadExtensions [protected]

String vl::ResourceLoadWriter::mWriteExtensions [protected]

---

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

• E:/VisualizationLibrary/Visualization_Library_SDK/src/vl/ResourceLoadWriter.hpp