VgEngine::VgIEngine Class Reference

This interface provides an entry-point to retrieve objects from the Visioglobe engine. More...

List of all members.

Public Member Functions
virtual	~VgIEngine ()
	Destructor.
virtual void	addPostDrawCallback (VgEngine::VgRefPtr< VgEngine::VgIEnginePostDrawCallback >const &pCallback)=0
	This method is used to add a VgIEnginePostDrawCallback to the engine.
virtual void	removePostDrawCallback (VgEngine::VgRefPtr< VgEngine::VgIEnginePostDrawCallback >const &pCallback)=0
	This method is used to remove a VgIEnginePostDrawCallback to the engine.
virtual const std::vector < VgEngine::VgRefPtr < VgEngine::VgIEnginePostDrawCallback > > &	getPostDrawCallbacks () const =0
virtual VgIDatabase *	editDatabase ()=0
virtual VgICamera *	editCamera ()=0
virtual VgILicenseManager *	editLicenseManager ()=0
virtual VgITextureManager *	editTextureManager ()=0
virtual VgIAnimationManager *	editAnimationManager ()=0
virtual VgIResourceManager *	editResourceManager ()=0
virtual VgLayerManager *	editLayerManager ()=0
virtual VgInstanceFactory *	editInstanceFactory ()=0
virtual VgFontManager *	editFontManager ()=0
virtual const VgPositionToolbox *	getPositionToolbox ()=0
virtual VgErrorCode	getLastError () const =0
virtual const std::string &	getErrorString (VgErrorCode pErrorCode) const =0
virtual void	resetGraphicResources (bool pIsContextLost)=0
	Resets all the GPU graphic resources.
virtual void	reloadShaders ()=0
	This method causes the engine to reinstantiate the shaders from source files.
virtual VgConstRefPtr< VgLight >	getLight (UInt pLightNum) const =0
	This method gives read-only access to one of the engine lights.
virtual VgRefPtr< VgLight >	editLight (UInt pLightNum)=0
	This method gives read-write access to one of the engine lights.
virtual UInt	getNumLights () const =0
	This method returns the number of lights in the scene.
virtual void	replaceNamedTexture (const std::string &pResourceName, VgEngine::VgRefPtr< VgEngine::VgITexture > &pTexture)=0
	This method is used to override a given texture resource (defined in the configuration file).
virtual void	setClearColor (const VgEngine::VgColor &pClearColor)=0
	This method is used to change the clear color of the view.
Protected Member Functions
	VgIEngine ()
	Constructor.

---

Detailed Description

This interface provides an entry-point to retrieve objects from the Visioglobe engine.

---

Constructor & Destructor Documentation

VgEngine::VgIEngine::VgIEngine

(

)

[inline, protected]

Constructor.

virtual VgEngine::VgIEngine::~VgIEngine

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

virtual void VgEngine::VgIEngine::addPostDrawCallback

(

VgEngine::VgRefPtr< VgEngine::VgIEnginePostDrawCallback >const &

pCallback )

[pure virtual]

This method is used to add a VgIEnginePostDrawCallback to the engine.

Note:

Note that adding too many post draw callbacks (or having a post draw callback that takes time to execute) can lead to bad performance.

Parameters:

pCallback

the post draw callback.

virtual VgIAnimationManager* VgEngine::VgIEngine::editAnimationManager

(

)

[pure virtual]

Returns:

The animation manager.

virtual VgICamera* VgEngine::VgIEngine::editCamera

(

)

[pure virtual]

Returns:

The camera.

virtual VgIDatabase* VgEngine::VgIEngine::editDatabase

(

)

[pure virtual]

Returns:

The database.

virtual VgFontManager* VgEngine::VgIEngine::editFontManager

(

)

[pure virtual]

Returns:

The font manager.

Version:

2.0.8387

virtual VgInstanceFactory* VgEngine::VgIEngine::editInstanceFactory

(

)

[pure virtual]

Returns:

The instance factory.

virtual VgLayerManager* VgEngine::VgIEngine::editLayerManager

(

)

[pure virtual]

Returns:

The layer manager.

virtual VgILicenseManager* VgEngine::VgIEngine::editLicenseManager

(

)

[pure virtual]

Returns:

The license manager.

virtual VgRefPtr< VgLight > VgEngine::VgIEngine::editLight

(

UInt

pLightNum )

[pure virtual]

This method gives read-write access to one of the engine lights.

Parameters:

pLightNum

The index of the queried light.

Returns:

A VgRefPtr containing the pointer to the light, or NULL if there is no light with this index.

Version:

2.0.8744

virtual VgIResourceManager* VgEngine::VgIEngine::editResourceManager

(

)

[pure virtual]

Returns:

The resource manager.

virtual VgITextureManager* VgEngine::VgIEngine::editTextureManager

(

)

[pure virtual]

Returns:

The texture manager.

virtual const std::string& VgEngine::VgIEngine::getErrorString

(

VgErrorCode

pErrorCode )

const [pure virtual]

Returns:

The error string corresponding to an error code.

virtual VgErrorCode VgEngine::VgIEngine::getLastError

(

)

const [pure virtual]

Returns:

The last error (an empty string is returned if no error occured).

virtual VgConstRefPtr< VgLight > VgEngine::VgIEngine::getLight

(

UInt

pLightNum )

const [pure virtual]

This method gives read-only access to one of the engine lights.

Parameters:

pLightNum

The index of the queried light.

Returns:

A VgConstRefPtr containing the pointer to the light, or NULL if there is no light with this index.

Version:

2.0.8744

virtual UInt VgEngine::VgIEngine::getNumLights

(

)

const [pure virtual]

This method returns the number of lights in the scene.

Returns:

The number of lights in the scene.

Version:

2.0.8744

virtual const VgPositionToolbox* VgEngine::VgIEngine::getPositionToolbox

(

)

[pure virtual]

Returns:

The toolbox for positions.

virtual const std::vector< VgEngine::VgRefPtr< VgEngine::VgIEnginePostDrawCallback > >& VgEngine::VgIEngine::getPostDrawCallbacks

(

)

const [pure virtual]

Returns:

Registred post draw callbacks.

virtual void VgEngine::VgIEngine::reloadShaders

(

)

[pure virtual]

This method causes the engine to reinstantiate the shaders from source files.

Version:

2.0.8744

virtual void VgEngine::VgIEngine::removePostDrawCallback

(

VgEngine::VgRefPtr< VgEngine::VgIEnginePostDrawCallback >const &

pCallback )

[pure virtual]

This method is used to remove a VgIEnginePostDrawCallback to the engine.

Parameters:

pCallback

the post draw callback.

virtual void VgEngine::VgIEngine::replaceNamedTexture	(	const std::string &	pResourceName,
		VgEngine::VgRefPtr< VgEngine::VgITexture > &	pTexture
	)		[pure virtual]

This method is used to override a given texture resource (defined in the configuration file).

If a resource exists by that name, it is replaced by the provided texture instance and all items in the scene referencing it are updated. If there is no matching texture nothing happens.

Parameters:

pResourceName	the name of the texture resource to override.
pTexture	The texture to override with.

Version:

2.0.8744

virtual void VgEngine::VgIEngine::resetGraphicResources

(

bool

pIsContextLost )

[pure virtual]

Resets all the GPU graphic resources.

Parameters:

pIsContextLost

Use true to specify that the context has been lost, false otherwise. Note: if the context was not lost and you specify true, it will produce memory leaks in the GPU.

Version:

2.0.7885.7885

virtual void VgEngine::VgIEngine::setClearColor

(

const VgEngine::VgColor &

pClearColor )

[pure virtual]

This method is used to change the clear color of the view.

This has no effect if an opaque background image is used.

Parameters:

pClearColor

The new color to use for screen clearing.

Version:

2.0.8955

---

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

• VgIEngine.h