This namespace defines all the needed interfaces to load data, render them in the VisioDevKit view and move the camera programmatically. More...

Classes
struct	VgFunctorDescriptorMapEntry
	Creates a mapping between an animation channel and a functor descriptor. More...
class	VgFunctorDescriptorMap
	A list of VgFunctorDescriptorMapEntry's. More...
class	VgAnimationChannels
	Contains literals to identify animation channels. More...
class	VgLoopModes
	Contains literals to identify loop modes. More...
struct	VgAnimationDescriptor
	This class implements descriptors for animations. More...
class	VgAnimation
	This interface handles engine animations. More...
class	VgAxialRotationQuaternionFunctorDescriptor
	This class implements descriptors for axial rotation functors. More...
class	VgBinaryBuffer
	The VgBinaryBuffer class is used to manipulate binary data. More...
class	VgColorInterpolationFunctorDescriptor
	This class implements descriptors for color interpolation functors. More...
class	VgDiscreteQuaternionFunctorDescriptor
	This class describes a functor for orientations using discrete samples. More...
class	VgDiscreteVectorFunctorDescriptor
	This class describes a functor for positions using discrete samples. More...
class	VgFloatInterpolationFunctorDescriptor
	This class implements descriptors for float interpolation functors. More...
class	VgFloatSplineFunctorDescriptor
	This class describes a functor that approximates a sequence of floats with a spline. More...
class	VgFontManager
	Set the Font and configures it to render text. More...
class	VgFunctorDescriptor
	This is the super class for all functor descriptor classes in the SDK. More...
class	VgGeoReferencedSRSDescriptor
class	VgGeoReferencedSRS
	This class implements georeferenced spatial reference systems. More...
class	VgIAnimationCallback
	This class defines the interface for animation call backs. More...
class	VgIAnimationManager
	This class is a manager for animations. More...
struct	VgIViewPoint
	This structure encapsulates a camera's viewpoint parameters. More...
interface	VgICamera
	This interface is used to retreive and control the camera parameters. More...
struct	VgIDatabaseDatasetDescriptor
	This structure is used to retrieve information about the current dataset. More...
interface	VgIDatabase
	The VgIDatabase interface is used to load and select the data that will be displayed in the 3D view. More...
class	VgIEngineContext
	This class is used to encapsulate an engine context. More...
class	VgIEngine
	This interface provides an entry-point to retrieve objects from the Visioglobe engine. More...
class	VgIEnginePostDrawCallback
	This callback is used to draw some elements on the screen after the 3D view has been drawn. More...
interface	VgILicenseManager
	The VgILicenseManager class is used to manage licensing issues. More...
class	VgInstanceFactory
	Creates objects from their descriptor. More...
class	VgIResourceCallback
	Implements a behavior triggered when a VgIResourceRequest terminates. More...
struct	VgResourceRequestParameters
	Parametrizes a resource request. More...
class	VgIResourceManager
	Manages resources. More...
class	VgIResourceRequest
	Requests the reading of a resource. More...
class	VgITexture
	The VgITexture interface is used to handle texture in the application. More...
interface	VgITextureManager
	The VgITextureManager class is used to create VgITexture given a VgBinaryBuffer. More...
struct	VgLayerDescriptor
	Describes a layer. More...
class	VgLayer
	This class exposes the layer concept. More...
class	VgLayerManager
	Manages the layers. More...
class	VgLayoutDescriptor
	This abstract class is the base class for all layout descriptors. More...
class	VgLight
	This interface handles light management. More...
class	VgMetricSRS
	This class implements local metric spatial reference systems. More...
struct	VgPosition
	This struct encapsulates a 3D position. More...
class	VgPositionToolbox
	Provides various utility methods for VgEngine::VgPosition. More...
class	VgQuadtreeLayoutDescriptor
	This class is a descriptor for a quadtree based spatial layout. More...
class	VgQuaternionInterpolationFunctorDescriptor
	This class implements descriptors for orientation interpolation functors. More...
class	VgReferenced
	The VgReferenced class owns the number of references of an object. More...
class	VgConstRefPtr
	The VgRefPtr class is used to automatically reference and unreference reference counted objects (VgReferenced). More...
class	VgRefPtr
class	VgSinusoidalVectorOffsetFunctorDescriptor
	This class implements descriptors for sinusoidal animation of vectors. More...
class	VgSpatial
	This class gives access to the spatial aspect of an object (layer, point, etc). More...
class	VgSplineOrientationQuaternionFunctorDescriptor
	This class is a descriptor for quaternion functors that follow orientation of given spline definitions. More...
class	VgSplineVectorFunctorDescriptor
	This class describes a functor that approximates a sequence of vectors with a spline. More...
class	VgSRSDescriptor
class	VgSRS
	This abstract class is the superclass of all concrete SRS classes. More...
struct	VgColor
	This struct represents a color. More...
struct	VgOrientation
	This class describes the 3 values defining a 3D orientation azimuth, pitch, roll. More...
class	VgVectorInterpolationFunctorDescriptor
	This class implements descriptors for vector interpolation functors. More...
Typedefs
typedef unsigned char	Byte
	A byte type.
typedef unsigned int	UInt
	A unsigned int type.
Enumerations
enum	VgErrorCode { eNoError = 0, eInvalidLicenseError = 1, eInvalidLicenseRenewFailure = 2, eInvalidLicenseErrorInvalidSDK = 3, eInvalidLicenseErrorInvalidMachines = 4, eInvalidLicenseErrorInvalidSDKorMachines = 5, eInvalidLicenseErrorBadXML = 6, eInvalidLicenseErrorInvalidSecret = 7, eConfigFileMissingOrEmptyError = 8, eInvalidConfigErrorBadXML = 9, eInvalidConfigErrorBadLoad = 10, eConfigAndLicenseErrorMax = 99, eViewerArchiveParseError = 100, eViewerDatasetIndexError = 101, eViewerDatasetProjectionError = 102, eViewerDatasetNoValidLayerFound = 103, eViewerRenderingTechniqueError = 104, eViewerErrorMax = 199, eOtherErrors = 200, eManipulatorError = 200, eDatabaseConfigurationError, eDatabaseBadDatasetError, eInvalidFile, eInvalidOperation, eNbErrors }
	Engine error codes. More...
enum	VgResourceRequestStatus { eSuccess, eCancelled, eError }
	Status of a resource request. More...
enum	VgPixelFormat { eRGB, eRGBA }
	The pixel format to use in the image data. More...
enum	VgAltitudeMode { eRelative, eAbsolute }
	This enum defines how to interpret an altitude. More...
enum	VgOrientationType { eVgOrientationFixed, eVgOrientationFixedModulo180degrees, eVgOrientationCameraFacing }
	This enum controls the orientation of the geometry object in relation to the camera. More...
enum	VgTextAttributes { eVgTextAttributeNone = 0, eVgTextAttributeOutline = 1 << 0 }
	This enum controls the text attributes. More...
enum	VgAnchorMode { eVgTopLeft, eVgTopCenter, eVgTopRight, eVgCenterLeft, eVgCenter, eVgCenterRight, eVgBottomLeft, eVgBottomCenter, eVgBottomRight }
	This enum defines the possible anchor points. More...
enum	VgGestureState { eVgGestureBegin = 0, eVgGestureUpdate = 1, eVgGestureEnd = 2 }
	This enum defines the possible states of a gesture. More...
Functions
template<>
VgEngine::VgRefPtr < Vg3DModule::VgLine >	VgInstanceFactory::instantiate< Vg3DModule::VgLine::Descriptor > (VgEngine::VgConstRefPtr< Vg3DModule::VgLine::Descriptor > const &pDescriptor)
	The VgEngine::VgInstanceFactory::instantiate template instantiation to allow user instantiation through descriptors.
template<>
VgEngine::VgRefPtr < Vg3DModule::VgLink >	VgInstanceFactory::instantiate< Vg3DModule::VgLink::Descriptor > (VgEngine::VgConstRefPtr< Vg3DModule::VgLink::Descriptor >const &pDescriptor)
	The VgEngine::VgInstanceFactory::instantiate template instantiation to allow user instantiation through descriptors.
template<>
VgEngine::VgRefPtr < Vg3DModule::VgPoint >	VgEngine::VgInstanceFactory::instantiate< Vg3DModule::VgPoint::Descriptor > (VgEngine::VgConstRefPtr< Vg3DModule::VgPoint::Descriptor > const &pDescriptor)
	The VgEngine::VgInstanceFactory::instantiate template instantiation to allow user instantiation through descriptors.
template<>
VgEngine::VgRefPtr < VgEngine::VgAnimation >	VgInstanceFactory::instantiate< VgEngine::VgAnimation::Descriptor > (VgEngine::VgConstRefPtr< VgEngine::VgAnimation::Descriptor > const &pDescriptor)
	The VgEngine::VgInstanceFactory::instantiate template instantiation to allow user instantiation through descriptors.
template<>
VgEngine::VgRefPtr < VgEngine::VgLayer >	VgInstanceFactory::instantiate< VgEngine::VgLayerDescriptor > (VgEngine::VgConstRefPtr< VgEngine::VgLayerDescriptor > const &pDescriptor)
	The VgEngine::VgInstanceFactory::instantiate template instantiation to allow user instantiation through descriptors.
Variables
static const std::string	msEmptyString = ""
	An empty std::string.

Detailed Description

This namespace defines all the needed interfaces to load data, render them in the VisioDevKit view and move the camera programmatically.

Date:: 25/02/2010

Typedef Documentation

typedef unsigned char VgEngine::Byte

A byte type.

typedef unsigned int VgEngine::UInt

A unsigned int type.

(32 bits)

Enumeration Type Documentation

enum VgEngine::VgAltitudeMode

This enum defines how to interpret an altitude.

Enumerator:

eRelative

The altitude is interpreted relative to the terrain.

Note:: eRelative is effective only after the data has been displayed. It should be used only when inserting POIs into an already loaded map.

eAbsolute

The altitude is interpreted as the height above the WGS84 ellipsoid.

enum VgEngine::VgAnchorMode

This enum defines the possible anchor points.

An anchor mode determines how an object (containing a bounding box) is anchored to a given position.

Version:: 1.1.6861

Enumerator:

eVgTopLeft	Anchor to the top left.
eVgTopCenter	Anchor to the top center.
eVgTopRight	Anchor to the top right.
eVgCenterLeft	Anchor to the center left.
eVgCenter	Anchor to the center.
eVgCenterRight	Anchor to the center right.
eVgBottomLeft	Anchor to the bottom left.
eVgBottomCenter	Anchor to the bottom center.
eVgBottomRight	Anchor to the bottom right.

enum VgEngine::VgErrorCode

Engine error codes.

Enumerator:

eNoError	No error has occurred.
eInvalidLicenseError	Configuration Errors (internal VgConfig)
eInvalidLicenseRenewFailure	Failure while renewing or fetching license.
eInvalidLicenseErrorInvalidSDK	Invalid License SDK. Either The license's SDK (1.1, 2.0, etc) or architecture (iOS, Android, Linux, etc) doesn't correspond to the requesting SDK/architecture.
eInvalidLicenseErrorInvalidMachines	Invalid License Machine. The device is not authorized because the license either has no remaining free slots (VgSlot) or is not valid for this machine.
eInvalidLicenseErrorInvalidSDKorMachines	Possible either eInvalidLicenseErrorInvalidSDK or eInvalidLicenseErrorInvalidMachines.
eInvalidLicenseErrorBadXML	Invalid License: Bad XML parse (modified by hand?)
eInvalidLicenseErrorInvalidSecret	Invalid License: Incorrect secret code.
eConfigFileMissingOrEmptyError	Could not find configuration file or it is empty.
eInvalidConfigErrorBadXML	Invalid Configuration File: Bad XML parse (modified by hand? corrupted?)
eInvalidConfigErrorBadLoad	Could not load config file (loadFromContent failed)
eConfigAndLicenseErrorMax	The maximum possible config and licence error. IMPORANT: This should always be the last item in the Config and Licence section.
eViewerArchiveParseError	Error Parsing Archive on loadDataset()
eViewerDatasetIndexError	Invalid Dataset Index (larger than number of datasets?)
eViewerDatasetProjectionError	Error on Dataset Projection (probably problem with mixing multiple projections)
eViewerDatasetNoValidLayerFound	Error on Dataset no valid layer found (maybe no Data is licensed. check that Data on license maches your Data)
eViewerRenderingTechniqueError	Cannot load RenderingTechniques.
eViewerErrorMax	The maximum possible viewer error IMPORANT: This should always be the last item in the Viewer section.
eOtherErrors	Other errors.
eManipulatorError	VgIManipulatorManager::selectManipulator: Cannot find the specified manipulator.
eDatabaseConfigurationError	VgIDatabase::loadConfiguration: Cannot load configuration (VgConfig is NULL).
eDatabaseBadDatasetError	VgIDatabase::selectDataset: Cannot find the specified dataset.
eInvalidFile	Invalid file. The file is either not found or corrupted.
eInvalidOperation	Invalid operation. This operation is not allowed in the current state.
eNbErrors	The maximum possible error number. IMPORANT: This should always be the last item in this enum.

enum VgEngine::VgGestureState

This enum defines the possible states of a gesture.

Version:: 2.0

Enumerator:

eVgGestureBegin	The gesture begins.
eVgGestureUpdate	The gesture continues.
eVgGestureEnd	The gesture ends.

enum VgEngine::VgOrientationType

This enum controls the orientation of the geometry object in relation to the camera.

Generally geometry objects face the camera no matter the orientation (pitch/heading) of the camera.

Enumerator:

eVgOrientationFixed

The orientation does not change in relation to the camera.

eVgOrientationFixedModulo180degrees

The orientation is fixed except when the camera "switches" sides, at which point the orientation changes 180 degrees.

Used such that geometry objects can always viewed left to right.

eVgOrientationCameraFacing

The orientation is updated such that the attributed (be it heading, pitch or roll) always faces the camera.

enum VgEngine::VgPixelFormat

The pixel format to use in the image data.

Enumerator:

eRGB	Each pixel is in RGB format (the first byte is for the red component, the second for the green component and the third one is for the blue component).
eRGBA	Each pixel is in RGBA format (same as RGB with a fourth component representing alpha).

enum VgEngine::VgResourceRequestStatus

Status of a resource request.

Enumerator:

eSuccess	Request was successful.
eCancelled	Request was cancelled.
eError	Request failure for unspecified reason.

enum VgEngine::VgTextAttributes

This enum controls the text attributes.

The attributes

Enumerator:

eVgTextAttributeNone	No special attributes are given to the text.
eVgTextAttributeOutline	Adds an outline around the text.

Function Documentation

template<>

VgEngine::VgRefPtr< Vg3DModule::VgPoint > VgEngine::VgEngine::VgInstanceFactory::instantiate< Vg3DModule::VgPoint::Descriptor > ( VgEngine::VgConstRefPtr< Vg3DModule::VgPoint::Descriptor > const & pDescriptor )

The VgEngine::VgInstanceFactory::instantiate template instantiation to allow user instantiation through descriptors.

Parameters: