VGears::Utility Class Reference

Provides utilities for the application. More...

#include <VGearsUtility.h>

Inheritance diagram for VGears::Utility:

Collaboration diagram for VGears::Utility:

Public Member Functions
	Utility (int argc, char *argv[])
	Constructor. More...
virtual	~Utility ()
	Destructor. More...
virtual Ogre::Camera *	GetCamera (void)
	Retrieves the camera. More...
Public Member Functions inherited from VGears::Application
	Application (Ogre::String pluginsFileName, Ogre::String resourcesFile, Ogre::String logFileName)
	Constructor. More...
	Application (int argc, char *argv[])
	Constructor. More...
virtual	~Application ()
	Destructor. More...
bool	initOgre (bool hideWindow=false)
	Initializes the Ogre rendering system. More...
Ogre::Root *	getRoot (void)
	Retrieves the Ogre system main component. More...
Ogre::RenderWindow *	getRenderWindow (void)
	Retrieves the Ogre main window. More...
const String &	getResourcesFilename (void)
	Retrieves the Ogre resources file name. More...
Ogre::ResourceGroupManager *	ResMgr ()
	Retrieves the Ogre resource manager. More...

Static Public Member Functions
static std::string	DecodeString (const u8 *bytes, const unsigned int size)
	Decodes a FF7 encoded string. More...

Protected Member Functions
virtual void	InitComponents ()
	Initializes components used by the utilities. More...
virtual void	DestroyComponents ()
	Initializes components used by the utilities. More...
Protected Member Functions inherited from VGears::Application
String	getWindowTitle (void) const
	Retrieves the main window title. More...
bool	processCommandLine (int argc, char *argv[])
	Processes command line arguments. More...
void	registerArchiveFactories (void)
	Registers an {. More...
void	loadResourcesConfig (void)
	Loads the resource configuration from the file. More...
void	initComponents (void)
	Initializes components. More...
void	destroyComponents (void)
	Unloads components. More...
void	createResourceManagers (void)
	Initializes the resource manager. More...
void	destroyResourceManagers (void)
	Unloads the resource manager. More...

Private Member Functions
	Utility ()
	Constructor. More...

Private Attributes
DisplayFrameListener *	frame_listener_
	The frame listener. More...
Ogre::SceneManager *	scene_manager_
	The application scene manager. More...
Ogre::Camera *	camera_
	The engine camera. More...
Ogre::Viewport *	viewport_
	The engine viewport. More...

Detailed Description

Provides utilities for the application.

Constructor & Destructor Documentation

Utility() [1/2]

VGears::Utility::Utility	(	int	argc,
		char *	argv[]
	)

Constructor.

Parameters

[in]	argc	Number of arguments passed to the application.
[in]	argv	List of arguments passed to the application.

~Utility()

VGears::Utility::~Utility ( )

virtual

Destructor.

Utility() [2/2]

VGears::Utility::Utility ( )

private

Constructor.

Member Function Documentation

DecodeString()

std::string VGears::Utility::DecodeString ( const u8 *  bytes, const unsigned int  size  )

static

Decodes a FF7 encoded string.

It doesn't work for compressed strings.

Parameters

[in]	bytes	Raw bytes to read from.
[in]	size	Number of bytes in the bytes parameter.

Returns

The decoded string.

DestroyComponents()

void VGears::Utility::DestroyComponents ( )

protectedvirtual

Initializes components used by the utilities.

GetCamera()

Ogre::Camera * VGears::Utility::GetCamera ( void  )

virtual

Retrieves the camera.

Returns

The camera.

InitComponents()

void VGears::Utility::InitComponents ( )

protectedvirtual

Initializes components used by the utilities.

Member Data Documentation

camera_

Ogre::Camera* VGears::Utility::camera_

private

The engine camera.

frame_listener_

DisplayFrameListener* VGears::Utility::frame_listener_

private

The frame listener.

scene_manager_

Ogre::SceneManager* VGears::Utility::scene_manager_

private

The application scene manager.

viewport_

Ogre::Viewport* VGears::Utility::viewport_

private

The engine viewport.

---

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

• src/installer/VGearsUtility.h
• src/installer/VGearsUtility.cpp