Ocean
Ocean Interaction JavaScript Library

The Ocean Interaction JavaScript Library implements a java script interaction library. More...

Collaboration diagram for Ocean Interaction JavaScript Library:

Data Structures

class  Ocean::Interaction::JavaScript::JSBase
 This class implements the base class for all JavaScript wrappers. More...
 
class  Ocean::Interaction::JavaScript::JSColor
 This class implements a wrapper for a JavaScript Color object. More...
 
class  Ocean::Interaction::JavaScript::JSContext
 This class implements a wrapper for a JavaScript context. More...
 
class  Ocean::Interaction::JavaScript::JSDevice
 This class is a lightweight helper class for device objects to allow event callback handling. More...
 
class  Ocean::Interaction::JavaScript::JSDeviceManager
 This class implements a wrapper for a JavaScript DeviceManager object. More...
 
class  Ocean::Interaction::JavaScript::JSDeviceObject
 This class implements a wrapper for a JavaScript DeviceObject object. More...
 
class  Ocean::Interaction::JavaScript::JSDeviceSample
 This class implements a wrapper for a JavaScript DeviceSample object. More...
 
class  Ocean::Interaction::JavaScript::JSEuler
 This class implements a wrapper for a JavaScript Euler object. More...
 
class  Ocean::Interaction::JavaScript::JSExternal
 This class implements a type-safe object wrapper for non-JavaScript objects. More...
 
class  Ocean::Interaction::JavaScript::JSHomogenousMatrix4
 This class implements a wrapper for a JavaScript HomogenousMatrix4 object. More...
 
class  Ocean::Interaction::JavaScript::JSLibrary
 This class implements the java script interaction library object. More...
 
class  Ocean::Interaction::JavaScript::JSLine3
 This class implements a wrapper for a JavaScript Line3 object. More...
 
class  Ocean::Interaction::JavaScript::JSMediaManager
 This class implements a wrapper for a JavaScript MediaManager object. More...
 
class  Ocean::Interaction::JavaScript::JSMediaObject
 This class implements a wrapper for a JavaScript MediaObject object. More...
 
class  Ocean::Interaction::JavaScript::JSObject< T, TNative >
 This class implements the base class for all native wrapper of JavaScript objects. More...
 
class  Ocean::Interaction::JavaScript::JSOcean
 This class implements the JavaScript Ocean objevct. More...
 
class  Ocean::Interaction::JavaScript::JSPlane3
 This class implements a wrapper for a JavaScript Plane object. More...
 
class  Ocean::Interaction::JavaScript::JSQuaternion
 This class implements a wrapper for a JavaScript Quaternion object. More...
 
class  Ocean::Interaction::JavaScript::JSRenderingEngine
 This class implements a wrapper for a JavaScript RenderingEngine object. More...
 
class  Ocean::Interaction::JavaScript::JSRenderingObject
 This class implements a wrapper for a JavaScript RenderingObject object. More...
 
class  Ocean::Interaction::JavaScript::JSRotation
 This class implements a wrapper for a JavaScript Rotation object. More...
 
class  Ocean::Interaction::JavaScript::JSSceneDescriptionManager
 This class implements a wrapper for a JavaScript SceneDescriptionManager object. More...
 
class  Ocean::Interaction::JavaScript::JSSceneDescriptionNode
 This class implements a wrapper for a JavaScript SceneDescriptionNode object. More...
 
class  Ocean::Interaction::JavaScript::JSScript
 This class implements an object holding a JavaScript code. More...
 
class  Ocean::Interaction::JavaScript::JSSquareMatrix3
 This class implements a wrapper for a JavaScript SquareMatrix3 object. More...
 
class  Ocean::Interaction::JavaScript::JSSquareMatrix4
 This class implements a wrapper for a JavaScript SquareMatrix4 object. More...
 
class  Ocean::Interaction::JavaScript::JSVector2
 This class implements a wrapper for a JavaScript Vector2 object. More...
 
class  Ocean::Interaction::JavaScript::JSVector3
 This class implements a wrapper for a JavaScript Vector3 object. More...
 
class  Ocean::Interaction::JavaScript::JSVector4
 This class implements a wrapper for a JavaScript Vector4 object. More...
 

Functions

OCEAN_INTERACTION_JS_EXPORT std::string Ocean::Interaction::JavaScript::nameJavaScriptLibrary ()
 Returns the name of this interaction library. More...
 
void Ocean::Interaction::JavaScript::registerJavaScriptLibrary ()
 Registers this JavaScript interaction library at the global interaction manager. More...
 
bool Ocean::Interaction::JavaScript::unregisterJavaScriptLibrary ()
 Unregisters this JavaScript interaction library at the global interaction manager. More...
 
OCEAN_INTERACTION_JS_EXPORT bool pluginLoad ()
 Tries to load the plugin and initializes all internal 3rd party libraries. More...
 
OCEAN_INTERACTION_JS_EXPORT bool pluginUnload ()
 Tries to unload the plugin and all internal resources of 3rd party libraries. More...
 
OCEAN_INTERACTION_JS_EXPORT const char * pluginVersion ()
 Returns informations about the used 3rd party libraries. More...
 

Detailed Description

The Ocean Interaction JavaScript Library implements a java script interaction library.


Function Documentation

◆ nameJavaScriptLibrary()

OCEAN_INTERACTION_JS_EXPORT std::string Ocean::Interaction::JavaScript::nameJavaScriptLibrary ( )

Returns the name of this interaction library.

◆ pluginLoad()

OCEAN_INTERACTION_JS_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
See also
pluginUnload(), pluginVersion().

◆ pluginUnload()

OCEAN_INTERACTION_JS_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
See also
pluginLoad().

◆ pluginVersion()

OCEAN_INTERACTION_JS_EXPORT const char* pluginVersion ( )

Returns informations about the used 3rd party libraries.

Returns
Name and version of the 3rd party libraries

◆ registerJavaScriptLibrary()

void Ocean::Interaction::JavaScript::registerJavaScriptLibrary ( )

Registers this JavaScript interaction library at the global interaction manager.

This function calls JSLibrary::registerLibrary() only.

◆ unregisterJavaScriptLibrary()

bool Ocean::Interaction::JavaScript::unregisterJavaScriptLibrary ( )

Unregisters this JavaScript interaction library at the global interaction manager.

This function calls JSLibrary::unregisterLibrary() only.

Returns
True, if succeeded