Handles a world map file. More...

#include <WorldmapFile.h>

Inheritance diagram for VGears::WorldmapFile:

Collaboration diagram for VGears::WorldmapFile:

Public Member Functions
	WorldmapFile (Ogre::ResourceManager creator, const Ogre::String &name, Ogre::ResourceHandle handle, const Ogre::String &group, bool is_manual=false, Ogre::ManualResourceLoader loader=0)
	Constructor. More...

virtual	~WorldmapFile ()
	Destructor. More...

Public Member Functions inherited from VGears::Resource
	Resource (Ogre::ResourceManager creator, const String &name, Ogre::ResourceHandle handle, const String &group, bool manual, Ogre::ManualResourceLoader loader)
	Constructor. More...

virtual	~Resource ()=default
	Destructor. More...

Static Public Attributes
static const String	RESOURCE_TYPE
	The type of resource. More...

Private Member Functions
virtual void	loadImpl () override final
	Loads the map file. More...

virtual void	unloadImpl () override final
	Unloads the map file. More...

Additional Inherited Members
Protected Member Functions inherited from VGears::Resource
virtual Ogre::DataStreamPtr	openResource ()
	Opens the resource. More...

Detailed Description

Handles a world map file.

Constructor & Destructor Documentation

◆ WorldmapFile()

VGears::WorldmapFile::WorldmapFile	(	Ogre::ResourceManager *	creator,
		const Ogre::String &	name,
		Ogre::ResourceHandle	handle,
		const Ogre::String &	group,
		bool	is_manual = `false`,
		Ogre::ManualResourceLoader *	loader = `0`
	)

Constructor.

Parameters

[in]	creator	Pointer to the ResourceManager that is creating this resource.
[in]	name	The unique name of the resource.
[in]	handle

Todo:: Understand and document.

Parameters

[in]	group	The name of the resource group to which this resource belong.
[in]	is_manual	True if the resource is manually loaded, false otherwise.
[in]	loader	Pointer to a ManualResourceLoader implementation which will be called when the Resource wishes to load (should be supplied if is_manual is set to true). It can be null, but the Resource will never be able to reload if anything ever causes it to unload. Therefore provision of a proper ManualResourceLoader instance is strongly recommended.

◆ ~WorldmapFile()

VGears::WorldmapFile::~WorldmapFile ( )

virtual

Destructor.

Member Function Documentation

◆ loadImpl()

void VGears::WorldmapFile::loadImpl ( void )

finaloverrideprivatevirtual

Loads the map file.

◆ unloadImpl()

void VGears::WorldmapFile::unloadImpl ( void )

finaloverrideprivatevirtual

Unloads the map file.

Member Data Documentation

◆ RESOURCE_TYPE

const String VGears::WorldmapFile::RESOURCE_TYPE

static

The type of resource.

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

src/data/worldmap/WorldmapFile.h
src/data/worldmap/WorldmapFile.cpp

Public Member Functions

Static Public Attributes

Private Member Functions

Additional Inherited Members