VgMyAvatarDiscDisplay Class Reference

Displays an avatar disc that represents the accuracy of the current location on the map. More...

Inheritance diagram for VgMyAvatarDiscDisplay:

Public Member Functions
	VgMyAvatarDiscDisplay (VgApplication::VgIApplication *pVgApplication, VgMyTextureLoader *pTextureLoader)
	Constructor. More...
	~VgMyAvatarDiscDisplay ()
void	createAvatar ()
	Create the basic avatar. More...
void	notifyPositionDidChange (const std::string &pProvider, const VgEngine::VgPosition &pPosition)
	Called when the location has changed. More...
void	notifyFloorDidChange (const std::string &pProvider, const std::string &pFloor)
	Called when the floor has changed. More...
void	notifyAccuracyDidChange (const std::string &pProvider, double pAccuracy)
	Called when the accuracy has changed. More...
void	notifyContextDidChange (const std::string &pProvider, int pContext)
	Called when the context has changed. More...
void	notifyHeadingDidChange (const std::string &pProvider, double pHeading)
	Called when the heading has changed. More...
void	notifyStatusDidChange (const std::string &pProvider, int pStatus)
	Called when the status has changed. More...
void	notifyLocationProviderEnabled (const std::string &pProvider)
	Called when the provider is enabled. More...
void	notifyLocationProviderDisabled (const std::string &pProvider)
	Called when the provider is disabled. More...
void	show ()
void	hide ()
bool	isVisible ()

Protected Attributes
VgApplication::VgIApplication *	mVgApplication
VgEngine::VgRefPtr < Vg3DModule::VgPoint >	mAvatarPoint
VgMyTextureLoader *	mTextureLoader
VgEngine::VgPosition	mPosition
float	mAccuracy
std::string	mCurrentAvatarLayerName

Static Protected Attributes
static float	kAccuracyMin

Additional Inherited Members
Protected Member Functions inherited from VgMyLocationListener
virtual	~VgMyLocationListener ()

Detailed Description

Displays an avatar disc that represents the accuracy of the current location on the map.

Must be registered with VgMyLocationManager before it will receive location notification.

IMPLEMENTATION TIPS: You can customize its texture and its animation.

Constructor & Destructor Documentation

VgMyAvatarDiscDisplay::VgMyAvatarDiscDisplay	(	VgApplication::VgIApplication *	pVgApplication,
		VgMyTextureLoader *	pTextureLoader
	)

Constructor.

Parameters

pVgApplication	VgIApplication to use. Can't be NULL
pTextureLoader	VgMyTextureLoader to use. Can't be NULL.

Note

You may change its texture within this constructor.

VgMyAvatarDiscDisplay::~VgMyAvatarDiscDisplay

(

)

Member Function Documentation

void VgMyAvatarDiscDisplay::createAvatar

(

)

Create the basic avatar.

void VgMyAvatarDiscDisplay::hide

(

)

bool VgMyAvatarDiscDisplay::isVisible

(

)

void VgMyAvatarDiscDisplay::notifyAccuracyDidChange ( const std::string &  pProvider, double  pAccuracy  )

virtual

Called when the accuracy has changed.

Parameters

pProvider	The location provider responsible for sending the notification.
pAccuracy	The new accuracy

Implements VgMyLocationListener.

void VgMyAvatarDiscDisplay::notifyContextDidChange ( const std::string &  pProvider, int  pContext  )

virtual

Called when the context has changed.

Parameters

pProvider	The location provider responsible for sending the notification.
pContext	The new context

Implements VgMyLocationListener.

void VgMyAvatarDiscDisplay::notifyFloorDidChange ( const std::string &  pProvider, const std::string &  pFloor  )

virtual

Called when the floor has changed.

Parameters

pProvider	The location provider responsible for sending the notification.
pFloor	The new floor

Implements VgMyLocationListener.

void VgMyAvatarDiscDisplay::notifyHeadingDidChange ( const std::string &  pProvider, double  pHeading  )

virtual

Called when the heading has changed.

Heading is the horizontal direction of travel of this device, and is not related to the device orientation.

Parameters

pProvider	The location provider responsible for sending the notification.
pHeading	The new heading. The valid range for the heading is [0.0, 360.0]. Where 0.0 is North, and increasing values starts towards the East.

Implements VgMyLocationListener.

void VgMyAvatarDiscDisplay::notifyLocationProviderDisabled ( const std::string &  pProvider )

virtual

Called when the provider is disabled.

Parameters

pProvider

The location provider responsible for sending the notification.

Implements VgMyLocationListener.

void VgMyAvatarDiscDisplay::notifyLocationProviderEnabled ( const std::string &  pProvider )

virtual

Called when the provider is enabled.

Parameters

pProvider

The location provider responsible for sending the notification.

Implements VgMyLocationListener.

void VgMyAvatarDiscDisplay::notifyPositionDidChange ( const std::string &  pProvider, const VgEngine::VgPosition &  pPosition  )

virtual

Called when the location has changed.

Parameters

pProvider	The location provider responsible for sending the notification
pPosition	The new position

Implements VgMyLocationListener.

void VgMyAvatarDiscDisplay::notifyStatusDidChange ( const std::string &  pProvider, int  pStatus  )

virtual

Called when the status has changed.

Parameters

pProvider	The location provider responsible for sending the notification.
pStatus	The new status. See for available values.

Implements VgMyLocationListener.

void VgMyAvatarDiscDisplay::show

(

)

Member Data Documentation

float VgMyAvatarDiscDisplay::kAccuracyMin

staticprotected

float VgMyAvatarDiscDisplay::mAccuracy

protected

VgEngine::VgRefPtr< Vg3DModule::VgPoint > VgMyAvatarDiscDisplay::mAvatarPoint

protected

std::string VgMyAvatarDiscDisplay::mCurrentAvatarLayerName

protected

VgEngine::VgPosition VgMyAvatarDiscDisplay::mPosition

protected

VgMyTextureLoader* VgMyAvatarDiscDisplay::mTextureLoader

protected

VgApplication::VgIApplication* VgMyAvatarDiscDisplay::mVgApplication

protected

---

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

• VgMyAvatarDiscDisplay.h