NaviLibrary::NaviCursor Class Reference

#include <NaviCursor.h>

List of all members.

Public Member Functions
NaviCursor *	addFrame (unsigned short durationMS, const std::string &imageFilename, const std::string &imageResourceGroup=Ogre::ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)
std::string	getName ()

---

Detailed Description

A quick little class that lets you define animated/static cursors for use with NaviMouse.

Note:

You should instantiate this class through NaviMouse::createCursor.

---

Member Function Documentation

NaviCursor * NaviCursor::addFrame	(	unsigned short	durationMS,
		const std::string &	imageFilename,
		const std::string &	imageResourceGroup = Ogre::ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME
	)

Adds a new frame (image) to the cursor. If you add more than one frame to a cursor, they will be animated by looping the images.

Parameters:

	durationMS	The number of milliseconds to display this frame for. Use a duration of '0' to lock the animation when it reaches this frame.
	imageFilename	The filename of the image to use for this frame. Please note that the width and height of the image must each be greater than or equal to 64.
	imageResourceGroup	The Ogre Resource Group to find the image filename. Defaults to Ogre::ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME.

Exceptions:

Ogre::Exception::ERR_INVALIDPARAMS

Throws this if the width or height of the image is less than 64.

Returns:

A pointer to the NaviCursor you added a frame to.

std::string NaviCursor::getName

(

)

Gets the name of this NaviCursor.

Returns:

The name of this cursor as a string.

---

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

• Navi/Include/NaviCursor.h
• Navi/Source/NaviCursor.cpp

---