Abstract loader implementation base class, derive your concrete loader implementations from this class. More...

#include <LoaderImpl.h>

Inheritance diagram for PLCore::LoaderImpl:

[legend]

Public Member Functions
	pl_class (PLCORE_RTTI_EXPORT, LoaderImpl,"PLCore", PLCore::Object,"Abstract loader implementation base class, derive your concrete loader implementations from this class") pl_properties pl_property("Type"
Unknown	pl_property ("Formats","") pl_property("Load"
Unknown pl_property("Save","0") pl_properties_end pl_class_end protected virtual PLCORE_API	~LoaderImpl ()
	Default constructor.
Static Public Attributes
static PLCORE_API const String	UnknownFormatVersion
static PLCORE_API const String	DeprecatedFormatVersion
static PLCORE_API const String	NoLongerSupportedFormatVersion
static PLCORE_API const String	InvalidFormatVersion

Detailed Description

Abstract loader implementation base class, derive your concrete loader implementations from this class.

Remarks:: A loader implementation is ONLY responsible for loading & saving, NOT for opening/closing concrete file objects or for clearing the given loadable! There's only one instance of each loader within the system, do NOT use class member variables, do ONLY use local variables else you may get in trouble when using multi-threading. By default, the loadable system looks for "Load" and "LoadParams" RTTI methods for loading, and "Save" and "SaveParams" for saving. For example "Load" is used if there are no special user provided parameters, "LoadParams" is used if a loader supports special format dependent parameters and the user explicitly set them. Please note that it's also possible to add methods with other names, when loading a loadable, this method name can be used explicitly. The first method parameter has to be a reference to the loadable, the second parameter has to be a reference to the file to operate on.

Each loader should have the following properties:

"Type": Loader type, usually only defined once within the abstract loader base class
"Formats": File format extensions this loader can load in (for example: "bmp" or "jpg,jpeg")
"Load": "1" if loading is implemented, else "0"
"Save": "1" if saving is implemented, else "0"

Constructor & Destructor Documentation

Unknown pl_property ("Save", "0") pl_properties_end pl_class_end protected virtual PLCORE_API PLCore::LoaderImpl::~LoaderImpl ( ) [virtual]

Default constructor.

Destructor

PLCore::LoaderImpl::pl_class	(	PLCORE_RTTI_EXPORT	,
		LoaderImpl	,
		"PLCore"	,
		PLCore::Object	,
		"Abstract loader implementation base	class,
		derive your concrete loader implementations from this class"
	)