IVisualisationManager Class Referenceabstract

The VisualisationManager handles IVisualisationTree objects It maintains a list of IVisualisationTree objects, each of which is associated to a scenario. This manager is used both at scenario creation time (to load or create IVisualisationTree objects), and when the scenario is being run (to forward IVisualisationWidget pointers to the related IVisualisationTree). More...

Inherits IKernelObject.

Inherited by TKernelObject< OpenViBE::Kernel::IVisualisationManager >.

Classes

class  IVisualisationTreeEnum
 An interface used to iteratively notify its creator of the existence of IVisualisationTree objects. More...
 

Public Member Functions

virtual OpenViBE::boolean initialize3DContext (void)=0
 Initialize 3D context and primary render window. More...
 
virtual OpenViBE::boolean createResourceGroup (OpenViBE::CIdentifier &rResourceGroupIdentifier, const OpenViBE::CString &rResourceGroupName)=0
 Create a resource group. More...
 
virtual OpenViBE::boolean addResourceLocation (const OpenViBE::CIdentifier &rResourceGroupIdentifier, const OpenViBE::CString &rResourceName, OpenViBE::Kernel::EResourceType rResourceType, OpenViBE::boolean bRecursive)=0
 Add a resource location. More...
 
virtual OpenViBE::boolean initializeResourceGroup (const OpenViBE::CIdentifier &rResourceGroupIdentifier)=0
 Initialize resource group. More...
 
virtual OpenViBE::boolean destroyResourceGroup (const OpenViBE::CIdentifier &rResourceGroupIdentifier)=0
 Destroy resource group. More...
 
virtual OpenViBE::boolean createVisualisationTree (OpenViBE::CIdentifier &rVisualisationTreeIdentifier)=0
 Creates an IVisualisationTree object. More...
 
virtual OpenViBE::boolean releaseVisualisationTree (const OpenViBE::CIdentifier &rVisualisationTreeIdentifier)=0
 Releases an IVisualisationTree object. More...
 
virtual
OpenViBE::Kernel::IVisualisationTree
getVisualisationTree (const OpenViBE::CIdentifier &rVisualisationTreeIdentifier)=0
 Looks for an IVisualisationTree object. More...
 
virtual OpenViBE::boolean enumerateVisualisationTrees (OpenViBE::Kernel::IVisualisationManager::IVisualisationTreeEnum &rCallBack) const =0
 Enumerates IVisualisationTree objects registered in this manager. More...
 
virtual OpenViBE::boolean setToolbar (const CIdentifier &rVisualisationTreeIdentifier, const CIdentifier &rBoxIdentifier,::GtkWidget *pToolbar)=0
 Set the toolbar of a visualisation plugin. This method is to be called by visualisation plugins as they are being initialized. It lets them send a pointer to their toolbar (if they have one) to the scenario's IVisualisationTree. More...
 
virtual OpenViBE::boolean setWidget (const CIdentifier &rVisualisationTreeIdentifier, const CIdentifier &rBoxIdentifier,::GtkWidget *pTopmostWidget)=0
 Set the topmost widget of a visualisation plugin. This method is to be called by visualisation plugins as they are being initialized. It lets them send a pointer to their topmost widget to the scenario's IVisualisationTree. More...
 

Detailed Description

The VisualisationManager handles IVisualisationTree objects It maintains a list of IVisualisationTree objects, each of which is associated to a scenario. This manager is used both at scenario creation time (to load or create IVisualisationTree objects), and when the scenario is being run (to forward IVisualisationWidget pointers to the related IVisualisationTree).

Author
Vincent Delannoy (INRIA/IRISA)
Date
2007-11

Member Function Documentation

virtual OpenViBE::boolean initialize3DContext ( void  )
pure virtual

Initialize 3D context and primary render window.

Returns
True if 3d context was successfully initialized, false otherwise
virtual OpenViBE::boolean createResourceGroup ( OpenViBE::CIdentifier rResourceGroupIdentifier,
const OpenViBE::CString rResourceGroupName 
)
pure virtual

Create a resource group.

Parameters
[out]rResourceGroupIdentifierIdentifier of resource group created
[in]rResourceGroupNameResource group name
Returns
True if resource group could be created, false otherwise
virtual OpenViBE::boolean addResourceLocation ( const OpenViBE::CIdentifier rResourceGroupIdentifier,
const OpenViBE::CString rResourceName,
OpenViBE::Kernel::EResourceType  rResourceType,
OpenViBE::boolean  bRecursive 
)
pure virtual

Add a resource location.

Remarks
Resources can't be added once Resource Group has been initialized
Parameters
rResourceGroupIdentifierResource group identifier
rResourceNameResource name
eResourceTypeResource type
bRecursiveResources are added recursively from location passed in parameter if true
Returns
True if resource location could be added, false otherwise
virtual OpenViBE::boolean initializeResourceGroup ( const OpenViBE::CIdentifier rResourceGroupIdentifier)
pure virtual

Initialize resource group.

Remarks
Each call to this method increments the group's internal reference counter. When it is set to one (upon first call to this method) the group is actually initialized, but isn't upon subsequent calls. It has to be destroyed (its ref count set back to 0) and recreated to be reinitialized.
Parameters
rResourceGroupIdentifierResource group identifier
Returns
True if resource group could be initialized (or was initialized already), false if an error occurred
virtual OpenViBE::boolean destroyResourceGroup ( const OpenViBE::CIdentifier rResourceGroupIdentifier)
pure virtual

Destroy resource group.

Remarks
Each call to this method decrements the group's internal reference counter. Only when this counter reaches 0 is the group actually destroyed.
Parameters
rResourceGroupIdentifierResource group identifier
Returns
True if resource group could be destroyed (or was initialized already), false if an error occurred
virtual OpenViBE::boolean createVisualisationTree ( OpenViBE::CIdentifier rVisualisationTreeIdentifier)
pure virtual

Creates an IVisualisationTree object.

Parameters
rVisualisationTreeIdentifier[out] identifier of the IVisualisationTree object created by this method
Returns
True if object was successfully created, false otherwise
virtual OpenViBE::boolean releaseVisualisationTree ( const OpenViBE::CIdentifier rVisualisationTreeIdentifier)
pure virtual

Releases an IVisualisationTree object.

Parameters
rVisualisationTreeIdentifier[in] identifier of the IVisualisationTree object to be released
Returns
True if object was successfully released, false otherwise
virtual OpenViBE::Kernel::IVisualisationTree& getVisualisationTree ( const OpenViBE::CIdentifier rVisualisationTreeIdentifier)
pure virtual

Looks for an IVisualisationTree object.

Parameters
rVisualisationTreeIdentifier[in] identifier of the IVisualisationTree object to be returned
Returns
Reference on IVisualisationTree looked for, OV_Undefined otherwise
virtual OpenViBE::boolean enumerateVisualisationTrees ( OpenViBE::Kernel::IVisualisationManager::IVisualisationTreeEnum rCallBack) const
pure virtual

Enumerates IVisualisationTree objects registered in this manager.

Parameters
rCallback[in] IVisualisationTreeEnum object to be notified for each IVisualisationTree registered in this manager.
Returns
True if IVisualisationTree objects were successfully enumerated, false otherwise
virtual OpenViBE::boolean setToolbar ( const CIdentifier rVisualisationTreeIdentifier,
const CIdentifier rBoxIdentifier,
::GtkWidget *  pToolbar 
)
pure virtual

Set the toolbar of a visualisation plugin. This method is to be called by visualisation plugins as they are being initialized. It lets them send a pointer to their toolbar (if they have one) to the scenario's IVisualisationTree.

Parameters
rVisualisationTreeIdentifier[in] identifier of IVisualisationTree to which the toolbar pointer is to be forwarded
rBoxIdentifier[in] Identifier of IBox whose toolbar pointer is being set
pToolbarWidget[in] pointer to the toolbar of the widget
Returns
True if pointer was successfully forwarded to IVisualisationTree, false otherwise
virtual OpenViBE::boolean setWidget ( const CIdentifier rVisualisationTreeIdentifier,
const CIdentifier rBoxIdentifier,
::GtkWidget *  pTopmostWidget 
)
pure virtual

Set the topmost widget of a visualisation plugin. This method is to be called by visualisation plugins as they are being initialized. It lets them send a pointer to their topmost widget to the scenario's IVisualisationTree.

Parameters
rVisualisationTreeIdentifier[in] identifier of IVisualisationTree to which the toolbar pointer is to be forwarded
rBoxIdentifier[in] Identifier of IBox whose topmost widget pointer is being set
pWidget[in] pointer to the main window of the widget
Returns
True if pointer was successfully forwarded to IVisualisationTree, false otherwise