VgEngine Namespace Reference

Classes
class	VgAnimation
class	VgAnimationChannels
struct	VgAnimationDescriptor
class	VgAxialRotationQuaternionFunctorDescriptor
class	VgBinaryBuffer
struct	VgColor
class	VgColorInterpolationFunctorDescriptor
class	VgConstRefPtr
class	VgDiscreteQuaternionFunctorDescriptor
class	VgDiscreteVectorFunctorDescriptor
class	VgFloatInterpolationFunctorDescriptor
class	VgFloatSplineFunctorDescriptor
class	VgFontManager
class	VgFunctorDescriptor
class	VgFunctorDescriptorMap
struct	VgFunctorDescriptorMapEntry
class	VgGeoReferencedSRS
class	VgIAnimationCallback
class	VgIAnimationManager
interface	VgICamera
interface	VgIDatabase
struct	VgIDatabaseDatasetDescriptor
class	VgIEngine
class	VgIEngineContext
class	VgIEnginePostDrawCallback
interface	VgILicenseManager
class	VgInstanceFactory
class	VgIResourceCallback
class	VgIResourceManager
class	VgIResourceRequest
class	VgITexture
interface	VgITextureManager
struct	VgIViewPoint
class	VgLayer
struct	VgLayerDescriptor
class	VgLayerManager
class	VgLayoutDescriptor
class	VgLight
class	VgLoopModes
class	VgMatrixInterpolationFunctorDescriptor
class	VgMetricSRS
struct	VgOrientation
struct	VgOrientationConstraints
struct	VgPosition
class	VgPositionToolbox
class	VgQuadtreeLayoutDescriptor
class	VgQuaternionInterpolationFunctorDescriptor
class	VgQuery
class	VgReferenced
class	VgRefPtr
struct	VgResourceRequestParameters
class	VgSinusoidalVectorOffsetFunctorDescriptor
class	VgSpatial
class	VgSplineOrientationQuaternionFunctorDescriptor
class	VgSplineVectorFunctorDescriptor
class	VgSRS
class	VgValue
class	VgVectorInterpolationFunctorDescriptor
struct	VgVisibilityRamp

Typedefs
typedef unsigned char	Byte
typedef unsigned int	UInt

Enumerations

Functions
template<>
VgEngine::VgRefPtr< Vg3DModule::VgLine >	VgInstanceFactory::instantiate< Vg3DModule::VgLine::Descriptor > (VgEngine::VgConstRefPtr< Vg3DModule::VgLine::Descriptor > const &pDescriptor)
template<>
VgEngine::VgRefPtr< Vg3DModule::VgLink >	VgInstanceFactory::instantiate< Vg3DModule::VgLink::Descriptor > (VgEngine::VgConstRefPtr< Vg3DModule::VgLink::Descriptor >const &pDescriptor)
template<>
VgEngine::VgRefPtr< Vg3DModule::VgPoint >	VgEngine::VgInstanceFactory::instantiate< Vg3DModule::VgPoint::Descriptor > (VgEngine::VgConstRefPtr< Vg3DModule::VgPoint::Descriptor > const &pDescriptor)
template<>
VgEngine::VgRefPtr< VgEngine::VgAnimation >	VgInstanceFactory::instantiate< VgEngine::VgAnimation::Descriptor > (VgEngine::VgConstRefPtr< VgEngine::VgAnimation::Descriptor > const &pDescriptor)
template<>
VgEngine::VgRefPtr< VgEngine::VgLayer >	VgInstanceFactory::instantiate< VgEngine::VgLayerDescriptor > (VgEngine::VgConstRefPtr< VgEngine::VgLayerDescriptor > const &pDescriptor)

Variables
static const std::string	msEmptyString = ""

Detailed Description

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

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 (check that data referenced by the license matches data within map bundle)
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::VgSizePolicy

This enum controls the fitting mode for VgMarkers of a VgPoint.

Enumerator
eVgSizePolicyConstantScale	The size is controlled by the Vg3DModule::VgGeometryDescriptor::mScale.
eVgSizePolicyFitRectangle	The scale of the object is recomputed to fit the bounding rectangle of the VgPoint. See also Vg3DModule::VgPoint::setBoundingRect Vg3DModule::VgPointDescriptor::mRectangleHeight Vg3DModule::VgPointDescriptor::mRectangleWidth
eVgSizePolicyRectangleMultiline	The scale of the markers is recomputed based on camera-to-ground distance, and constrained to the provided rectangle. If rectangle can't fit the markers, then they will be hidden. See also Vg3DModule::VgPoint::setBoundingRect Vg3DModule::VgPointDescriptor::mRectangleHeight Vg3DModule::VgPointDescriptor::mRectangleWidth Version 2.1.22
eVgSizePolicyFixedRectangleMultiline	The scale is adapted to best fit in the provided rectangle (i.e. the maximal fitting scale will be used) See also Vg3DModule::VgPoint::setBoundingRect Vg3DModule::VgPointDescriptor::mRectangleHeight Vg3DModule::VgPointDescriptor::mRectangleWidth Version 2.1.22

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

pDescriptor

The descriptor to use. Invalid Vg3DModule::VgPoint::Descriptor::mMarkerDescriptors will be ignored. You can check how many markers where created with Vg3DModule::VgPoint::getNbMarkers

Returns

a reference to a VgPoint. use isValid() to verify the VgPoint was successfully created.

Version

2.1.3 updated documentation

template<>

VgEngine::VgRefPtr< Vg3DModule::VgLine > VgEngine::VgInstanceFactory::instantiate< Vg3DModule::VgLine::Descriptor >

(

VgEngine::VgConstRefPtr< Vg3DModule::VgLine::Descriptor > const &

pDescriptor

)

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

Parameters

pDescriptor

The descriptor to use.

template<>

VgEngine::VgRefPtr< Vg3DModule::VgLink > VgEngine::VgInstanceFactory::instantiate< Vg3DModule::VgLink::Descriptor >

(

VgEngine::VgConstRefPtr< Vg3DModule::VgLink::Descriptor >const &

pDescriptor

)

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

Parameters

pDescriptor

The descriptor to use.

template<>

VgEngine::VgRefPtr< VgEngine::VgAnimation > VgEngine::VgInstanceFactory::instantiate< VgEngine::VgAnimation::Descriptor >

(

VgEngine::VgConstRefPtr< VgEngine::VgAnimation::Descriptor > const &

pDescriptor

)

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

Parameters

pDescriptor

The descriptor to use.

template<>

VgEngine::VgRefPtr< VgEngine::VgLayer > VgEngine::VgInstanceFactory::instantiate< VgEngine::VgLayerDescriptor >

(

VgEngine::VgConstRefPtr< VgEngine::VgLayerDescriptor > const &

pDescriptor

)

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

Parameters

pDescriptor

The descriptor to use.

Variable Documentation

const std::string VgEngine::msEmptyString = ""

static

An empty std::string.

Referenced by VgEngine::VgIDatabase::~VgIDatabase().