Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 123]
oCCAbstractVrpnPeripheralA VRPN peripheral abstraction, client side
oCCIdentifierBase class to work with EBML identifiers
oCCIdentifierGlobally used identification classThis class is the basic class to use in order to identify objects in the OpenViBE platform. It can be used for class identification, for object identification and any user needed identification process
oCCNameValuePairListThis class handles a list of name/value pairs. It handles a (hidden) map associating string keys to string values.This class avoids the need to include stl's map header file in the C++ interface, thus preventing potential compile/link errors when dynamically loading modules
oCCObservableOpenViBE Observable class
|\CIBoxComplete OpenViBE box interfaceThis interface can be used in order to fully describe an OpenViBE black box. It describes its identification values, its inputs, its outputs and its settings
oCCOgreObjectAn OgreObject manages a 3D object in an Ogre scene
oCCOgreResourceGroupOgre Resource Group management This class handles a resource group, possibly shared by multiple scenarios. Its reference count keeps track of when it is actually needed. Resources are freed when the count reaches 0
oCCOgreSceneManagement of an Ogre scene This class creates a scene manager and a default 3D scene which can be populated using a simplified 3D API
oCCOgreVisualisationHigh level Ogre initialisation & management This class initializes the Ogre library, creates 3D scenes, windows (views of 3D scenes) and objects that populate such scenes
oCCOgreVRApplicationBasic framework to design VR applications
|oCCHandballBCIOgre application for the Handball application
|\CCSpaceshipBCIOgre application for the application "Use-The-Force"
oCCOgreWindowAn OgreWindow visualises a 3D scene This class manages a RenderWindow which contents are visualised in a single viewport
oCCStringString class to avoid std::string in the interfaceThis class helps avoiding std::string being present in exposed C++ interface, eventually resulting in compile/link errors when dynamically loading modules
oCCVisualisationContextVisualisation context made available to plugins and allowing them to interact with a 3D scene This class offers a simplified, library independent 3D API to be used by plugin developers
oCGenericVRPNServerA class providing a very simple generic VRPN server capable of creating Analog and Button controls
oCIAlgorithmContextExectution context for algorithm objects
oCIAlgorithmManagerManager for all kind of plugin algorithms
oCIAlgorithmProtoPrototype interface for algorithm
oCIAlgorithmProxyApplication interface to an algorithm plugin
|oCIBoxComplete OpenViBE box interfaceThis interface can be used in order to fully describe an OpenViBE black box. It describes its identification values, its inputs, its outputs and its settings
|oCICommentA comment class for scenariosThis interface can be used in order to fully describe an OpenViBE comment in order to help the understanding of a given scenario
|oCILinkLink information between OpenViBE boxThis class collects informations between OpenViBE boxes : box identifiers and input / output indices
|oCIProcessingUnitProcessing unit information for OpenViBE boxes
|oCIScenarioA static OpenViBE scenarioThis class is a static scenario description. It is used to manipulate an OpenViBE box/connection collection..
|oCIVisualisationTreeHandles visualisation widgets and their arrangement in space This interface lets applications configure visualisation widgets by adding them to windows and tabs, positioning them next to each other using paned widgets, and resizing them as the user sees fit. All widgets are saved in a symbolic way as IVisualisationWidget instances referenced in a tree store. Methods of this class are essentially meant to be called from an external class inheriting from the ITreeViewCB interface, for offline design or online use of the widgets
|\CIVisualisationWidgetInterface of visualisation widgets that are handled by an IVisualisationTree These objects are stored in an IVisualisationTree object as they are being created and modified to suit the graphical needs of a scenario
oCIBoxAlgorithmContextSpecific context to use for box algorithm pluginsThis 'context' is given by the player to an algorithm plugin so it has all the necessary tools to work. This algorithm context mainly consists in getting other contexts which could be defined and used more generically (such as the box interface or a global player interface for example)
oCIBoxIOMain OpenViBE box interface to communicate with the kernelThis context allows the object which uses it to check inputs states, read them, write outputs while being in a dynamic context (used by player)
oCIBoxListenerContextExectution context for box algorithm descriptors
oCIConfigurableConfigurable object interface
oCIConfigurationManagerManager for all kind of configuration
oCIDriverBase class for all the OpenViBE acquisition server drivers
oCIDriverCallbackBase class for all the OpenViBE acquisition server driver callbacks
oCIDriverContextBase class for kernel functioanlities access from the driver classes
oCIHeaderBase class for an OpenViBE header container
oCIKernelContextKernel context interface, gives access to each manager the kernel owns
oCIKernelDescA kernel description
oCIKernelObjectFactoryKernel object factory, creates all kernel objects
oCILogListenerLog manager's listener interface
|\CILogManagerLog manager
oCIMaterialPassActionA class which calls the action for each pass of each technique
|oCMaterialSetAwarenessAction to set the awareness color. Carefull MaterialSetAwareness is exclusive, you have to choose beetween, MaterialSetMaterialName and MaterialSetAwareness
|oCMaterialSetDiffuseAction to set the diffuse color. Sets the color
|oCMaterialSetSceneBlendingAction to set the scene blending. Sets the blending method to use to adjust transparency
|\CMaterialSetTransparencyAction to change this instance transparency
oCIMessageBase message class
|oCIMessageClockClock message
|oCIMessageEventEvent message
|oCIMessageSignalSignal message
|\CIMessageWithDataA type of message that can contain different kinds of arbitrary dataA message that can contain different kinds of data. The intended usage is for the message to be exchanged between boxes. A message can hold four types of data: uint64, float64, CString and IMatrix. Each data item is accessed by its string identifier key using a getter/setter corresponding to the data type. The key is unique within the data type
oCIObjectBase class for all the OpenViBE platform objects
|oCIKernelLoaderThis class allows an OpenViBE application to load a kernel module
|oCIMatrixBasic OpenViBE matrix interface
|oCIMemoryBufferBasic OpenViBE memory buffer interface
|oCIStimulationSetBasic OpenViBE stimulation set interface
|oCIKernelObjectBase class for all kernel objects
|oCIPluginObjectBase class for plugin objectThis class is the base class for all the concrete plugin classes that extend the OpenViBE platform. It comes with several basic functions each plugin should have in order to work in the OpenViBE platform
|\CIPluginObjectDescBase class for plugin descriptorThis class is the base class for all the plugin description classes. It contains basic functions that could be used for each plugin description. Derived plugin descriptions will be used as a prototype of what they can create
oCIObjectVisitorContextExectution context for visitor objects
oCIObserverOpenViBE Observer interface
oCIParameterGeneric parameter handler for configurable objects
oCIPlayerThe main player classA player is responsible for the playback of a specific scenario. This player scenario is provided at initialisation stage and should not be changed until the player terminates. The player idea of calling a "play" function forces the use of threads in order to avoid CPU locking. Thus we prefer the idea of having a "short-time" function that is to be called repeatedly until the player terminates. This is the role of the IPlayer::loop function, that should be called repeatedly by the outside application
oCIPlayerContextPlayer interface for plugin objectsInstances of this class are given to plugin object so they can communicate with the platform kernel, providing services such as message sending etc..
oCIPlayerManagerThe manager responsible for scenario playbackThe player manager is responsible for creating the different player instances. Each player is responsible for the playback of a specific scenario
oCIPluginManagerLog manager
oCIPluginModulePlugin module
oCIPluginModuleContextPlugin context
oCIReaderEBML processing class
oCIReaderCallbackCallback class to use when parsing the EBML stream
oCIReaderHelperHelper to read basic EBML types
oCIScenarioManagerThe scenario managerThis manager is responsible to organize and handle all the scenarios of the kernel
oCIServerExtensionContextStatic context of a Server Extension object
oCIServerExtensionDynamicContextDynamic context of a Server Extension objectThis class contains accessors to data structures made available by the driver running in the Acquisition Server during the acquisition
oCIServerExtensionProtoPrototype interface for a server extension
oCIsProgrammableAction to know if is programmable. Main pass is programmable ? ie includes either a vertex or fragment program
oCITreeViewCBTree view interface It must be implemented by classes which communicate with the IVisualisationTree class in order to display the contents of the visualisation tree
oCITypeManagerType manager, provides information on platform's handled types, parameters, streams etc..
oCIVisualisationContextVisualisation manager interface for plugin objects
oCIVisualisationManagerThe 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)
oCIVisualisationManager::IVisualisationTreeEnumAn interface used to iteratively notify its creator of the existence of IVisualisationTree objects
oCIWriterEBML formating class
oCIWriterCallbackCallback class to use when creating the EBML stream
oCIWriterHelperHelper to write basic EBML types
oCIXMLHandlerThis class is design to help about XML manipulation
oCIXMLNodeSymbolize a node in a XML tree structure
oCMaterialSetShaderAction to set shader. Allow user to add fragment and shader on a new Pass
oCMaterialVertexBufferAction to modify a Vertex Buffer
oCPropertyBase class for properties. A property is essentially a <name,value> pair
oCTParameterHandler< T >Helper class in order to manipulate IParameter and IParameter values natively
oCTParameterHandler< OpenViBE::boolean >
oCTParameterHandler< OpenViBE::IMatrix * >
oCTParameterHandler< OpenViBE::IMemoryBuffer * >
oCTParameterHandler< OpenViBE::IStimulationSet * >
\CTParameterHandler< OpenViBE::uint64 >