Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 123]
![]() ![]() | A VRPN peripheral abstraction, client side |
![]() ![]() | Base class to work with EBML identifiers |
![]() ![]() | Globally 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 |
![]() ![]() | This 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 |
![]() ![]() | OpenViBE Observable class |
![]() ![]() ![]() | Complete 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 |
![]() ![]() | An OgreObject manages a 3D object in an Ogre scene |
![]() ![]() | Ogre 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 |
![]() ![]() | Management of an Ogre scene This class creates a scene manager and a default 3D scene which can be populated using a simplified 3D API |
![]() ![]() | High level Ogre initialisation & management This class initializes the Ogre library, creates 3D scenes, windows (views of 3D scenes) and objects that populate such scenes |
![]() ![]() | Basic framework to design VR applications |
![]() ![]() ![]() | Ogre application for the Handball application |
![]() ![]() ![]() | Ogre application for the application "Use-The-Force" |
![]() ![]() | An OgreWindow visualises a 3D scene This class manages a RenderWindow which contents are visualised in a single viewport |
![]() ![]() | String 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 |
![]() ![]() | Visualisation 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 |
![]() ![]() | A class providing a very simple generic VRPN server capable of creating Analog and Button controls |
![]() ![]() | Exectution context for algorithm objects |
![]() ![]() | Manager for all kind of plugin algorithms |
![]() ![]() | Prototype interface for algorithm |
![]() ![]() | Application interface to an algorithm plugin |
![]() ![]() | |
![]() ![]() ![]() | Complete 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 |
![]() ![]() ![]() | A 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 |
![]() ![]() ![]() | Link information between OpenViBE boxThis class collects informations between OpenViBE boxes : box identifiers and input / output indices |
![]() ![]() ![]() | Processing unit information for OpenViBE boxes |
![]() ![]() ![]() | A static OpenViBE scenarioThis class is a static scenario description. It is used to manipulate an OpenViBE box/connection collection.. |
![]() ![]() ![]() | Handles 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 |
![]() ![]() ![]() | Interface 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 |
![]() ![]() | Specific 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) |
![]() ![]() | Main 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) |
![]() ![]() | Exectution context for box algorithm descriptors |
![]() ![]() | Configurable object interface |
![]() ![]() | Manager for all kind of configuration |
![]() ![]() | Base class for all the OpenViBE acquisition server drivers |
![]() ![]() | Base class for all the OpenViBE acquisition server driver callbacks |
![]() ![]() | Base class for kernel functioanlities access from the driver classes |
![]() ![]() | Base class for an OpenViBE header container |
![]() ![]() | Kernel context interface, gives access to each manager the kernel owns |
![]() ![]() | A kernel description |
![]() ![]() | Kernel object factory, creates all kernel objects |
![]() ![]() | Log manager's listener interface |
![]() ![]() ![]() | Log manager |
![]() ![]() | A class which calls the action for each pass of each technique |
![]() ![]() ![]() | Action to set the awareness color. Carefull MaterialSetAwareness is exclusive, you have to choose beetween, MaterialSetMaterialName and MaterialSetAwareness |
![]() ![]() ![]() | Action to set the diffuse color. Sets the color |
![]() ![]() ![]() | Action to set the scene blending. Sets the blending method to use to adjust transparency |
![]() ![]() ![]() | Action to change this instance transparency |
![]() ![]() | Base message class |
![]() ![]() ![]() | Clock message |
![]() ![]() ![]() | Event message |
![]() ![]() ![]() | Signal message |
![]() ![]() ![]() | A 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 |
![]() ![]() | Base class for all the OpenViBE platform objects |
![]() ![]() ![]() | This class allows an OpenViBE application to load a kernel module |
![]() ![]() ![]() | Basic OpenViBE matrix interface |
![]() ![]() ![]() | Basic OpenViBE memory buffer interface |
![]() ![]() ![]() | Basic OpenViBE stimulation set interface |
![]() ![]() ![]() | Base class for all kernel objects |
![]() ![]() ![]() | Base 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 |
![]() ![]() ![]() | Base 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 |
![]() ![]() | Exectution context for visitor objects |
![]() ![]() | OpenViBE Observer interface |
![]() ![]() | Generic parameter handler for configurable objects |
![]() ![]() | The 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 |
![]() ![]() | Player 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.. |
![]() ![]() | The 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 |
![]() ![]() | Log manager |
![]() ![]() | Plugin module |
![]() ![]() | Plugin context |
![]() ![]() | EBML processing class |
![]() ![]() | Callback class to use when parsing the EBML stream |
![]() ![]() | Helper to read basic EBML types |
![]() ![]() | The scenario managerThis manager is responsible to organize and handle all the scenarios of the kernel |
![]() ![]() | Static context of a Server Extension object |
![]() ![]() | Dynamic 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 |
![]() ![]() | Prototype interface for a server extension |
![]() ![]() | Action to know if is programmable. Main pass is programmable ? ie includes either a vertex or fragment program |
![]() ![]() | Tree view interface It must be implemented by classes which communicate with the IVisualisationTree class in order to display the contents of the visualisation tree |
![]() ![]() | Type manager, provides information on platform's handled types, parameters, streams etc.. |
![]() ![]() | Visualisation manager interface for plugin objects |
![]() ![]() | 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) |
![]() ![]() | An interface used to iteratively notify its creator of the existence of IVisualisationTree objects |
![]() ![]() | EBML formating class |
![]() ![]() | Callback class to use when creating the EBML stream |
![]() ![]() | Helper to write basic EBML types |
![]() ![]() | This class is design to help about XML manipulation |
![]() ![]() | Symbolize a node in a XML tree structure |
![]() ![]() | |
![]() ![]() | Action to set shader. Allow user to add fragment and shader on a new Pass |
![]() ![]() | Action to modify a Vertex Buffer |
![]() ![]() | Base class for properties. A property is essentially a <name,value> pair |
![]() ![]() | Helper class in order to manipulate IParameter and IParameter values natively |
![]() ![]() | |
![]() ![]() | |
![]() ![]() | |
![]() ![]() | |
![]() ![]() |
Generated on Tue Jun 26 2012 15:25:54 for Documentation by
