Ocean
Ocean Interaction Empty Demo Library

The Ocean Interaction Empty Demo Library gives an exampl how to implement an interaction library for the Ocean framework. More...

Collaboration diagram for Ocean Interaction Empty Demo Library:

Data Structures

class  Ocean::Interaction::Empty::EPYLibrary
 This class implements the empty demo interaction library object. More...
 

Functions

void Ocean::Interaction::Empty::registerEmptyLibrary ()
 Registers this empty demo interaction library at the global interaction manager. More...
 
bool Ocean::Interaction::Empty::unregisterEmptyLibrary ()
 Unregisters this empty demo interaction library at the global interaction manager. More...
 
OCEAN_INTERACTION_EPY_EXPORT bool pluginLoad ()
 Tries to load the plugin and initializes all internal 3rd party libraries. More...
 
OCEAN_INTERACTION_EPY_EXPORT bool pluginUnload ()
 Tries to unload the plugin and all internal resources of 3rd party libraries. More...
 
OCEAN_INTERACTION_EPY_EXPORT const char * pluginVersion ()
 Returns informations about the used 3rd party libraries. More...
 

Detailed Description

The Ocean Interaction Empty Demo Library gives an exampl how to implement an interaction library for the Ocean framework.


Function Documentation

◆ pluginLoad()

OCEAN_INTERACTION_EPY_EXPORT bool pluginLoad ( )

Tries to load the plugin and initializes all internal 3rd party libraries.

Make sure that the plugin will be loaded only once!

Returns
True, if succeeded

◆ pluginUnload()

OCEAN_INTERACTION_EPY_EXPORT bool pluginUnload ( )

Tries to unload the plugin and all internal resources of 3rd party libraries.

Make sure that all resources of this plugin has been released before!

Returns
True, if succeeded

◆ pluginVersion()

OCEAN_INTERACTION_EPY_EXPORT const char* pluginVersion ( )

Returns informations about the used 3rd party libraries.

Returns
Name and version of the 3rd party libraries

◆ registerEmptyLibrary()

void Ocean::Interaction::Empty::registerEmptyLibrary ( )

Registers this empty demo interaction library at the global interaction manager.

This function calls EPYLibrary::registerLibrary() only.

◆ unregisterEmptyLibrary()

bool Ocean::Interaction::Empty::unregisterEmptyLibrary ( )

Unregisters this empty demo interaction library at the global interaction manager.

This function calls EPYLibrary::unregisterLibrary() only.

Returns
True, if succeeded