VgMapModule::VgPOIDescriptor Struct Reference

The VgPOIDescriptor describes location, footprint, height and other information tied to a POI. More...

Public Types
typedef std::vector < VgEngine::VgPosition >	PositionVector

Public Attributes
std::string	mLayerName
	The floor (which must correspond with one of the VgEngine::VgLayer::getName from VgEngine::VgLayerManager::getLayers) with which to associate the place object. More...
VgEngine::VgPosition	mCenter
	Center of interest or of focus. More...
double	mHeight
	Height relative to floor of POI. More...
double	mHeading
	Heading in degrees, can be used to understand the orientation of a POI. More...
PositionVector	mBoundingPositions
	Positions that bound the POI. More...

Detailed Description

The VgPOIDescriptor describes location, footprint, height and other information tied to a POI.

This class replaces the old VgMapModule::VgPlaceDescriptor.

This structure contains POI information that can be used to construct an appropriate viewpoint for a POI

// Set the viewpoint of the camera to look at a POI (e.g. a shop, a hall, lobby...)
VgMapModule::VgIMapModule* lMapModule = (VgMapModule::VgIMapModule*)mVgApplication->editModuleManager()->queryModule("Map");
VgMapModule::VgPOIDescriptor lPOIDescriptor;
if ( lMapModule && lMapModule->queryPOIDescriptor("vg-start-position", lPOIDescriptor))
{
   VgEngine::VgICamera* lCamera = mVgApplication->editEngine()->editCamera();
   double lCameraPitch = lCamera->getPitch();

   const VgMapModule::VgPOIDescriptor::PositionVector& lBoundingPositions = lPOIDescriptor.mBoundingPositions;

   VgEngine::VgIViewPoint lStartViewpoint = lCamera->getViewpoint();
   lStartViewpoint.mPosition.mZOrAltitude = 0.0;
   lCamera->setPosition(lStartViewpoint.mPosition);

   int padding = 30; // 30 pixels of padding all around
   VgEngine::VgIViewPoint lViewpoint = lCamera->getViewpointFromPositions(lBoundingPositions,
                                                                       padding, padding, padding, padding, 
                                                                       lCameraPitch, lPOIDescriptor.mHeading);
   lCamera->setViewpoint(lViewpoint);
}

Version

2.1.3

See Also

VgEngine::VgICamera::getViewpointFromPositions

Member Typedef Documentation

typedef std::vector< VgEngine::VgPosition > VgMapModule::VgPOIDescriptor::PositionVector

Member Data Documentation

PositionVector VgMapModule::VgPOIDescriptor::mBoundingPositions

Positions that bound the POI.

this in conjunction with mHeading can be used with VgEngine::VgICamera::getViewpointFromPositions to calculate a viewpoint where the whole POI is visible, for example a building lobby.

VgEngine::VgPosition VgMapModule::VgPOIDescriptor::mCenter

Center of interest or of focus.

double VgMapModule::VgPOIDescriptor::mHeading

Heading in degrees, can be used to understand the orientation of a POI.

double VgMapModule::VgPOIDescriptor::mHeight

Height relative to floor of POI.

std::string VgMapModule::VgPOIDescriptor::mLayerName

The floor (which must correspond with one of the VgEngine::VgLayer::getName from VgEngine::VgLayerManager::getLayers) with which to associate the place object.

---

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

• VgPOIDescriptor.h