This class implements the base class for all interaction libraries. More...

#include <Library.h>

Inheritance diagram for Ocean::Interaction::Library:

Public Types
using	FileExtensions = std::map< std::string, std::string >
	Definition of a map mapping file extensions to file type descriptions.

Public Member Functions
const std::string &	name () const
	Returns the name of this library.

virtual bool	isFileExtensionSupported (const std::string &extension) const
	Returns whether a specified file extension is supported by this interaction plugin.

virtual bool	load (const UserInterface &userInterface, const Rendering::EngineRef &engine, const Timestamp timestamp, const std::string &filename)=0
	Loads a new interaction file.

virtual bool	unload (const UserInterface &userInterface, const Rendering::EngineRef &engine, const Timestamp timestamp, const std::string &filename)=0
	Unloads one specific loaded interaction files.

virtual void	unload (const UserInterface &userInterface, const Rendering::EngineRef &engine, const Timestamp timestamp)=0
	Unloads all loaded scripts.

virtual void	preFileLoad (const UserInterface &userInterface, const std::string &filename)
	Pre file load interaction function.

virtual void	postFileLoad (const UserInterface &userInterface, const std::string &filename, const bool succeeded)
	Post file load interaction function.

virtual Timestamp	preUpdate (const UserInterface &userInterface, const Rendering::EngineRef &engine, const Rendering::ViewRef &view, const Timestamp timestamp)
	Pre update interaction function.

virtual void	postUpdate (const UserInterface &userInterface, const Rendering::EngineRef &engine, const Rendering::ViewRef &view, const Timestamp timestamp)
	Post update interaction function.

virtual void	onMousePress (const UserInterface &userInterface, const Rendering::EngineRef &engine, const std::string &button, const Vector2 &screenPosition, const Line3 &ray, const Rendering::ObjectId pickedObject, const Vector3 &pickedPosition, const Timestamp timestamp)
	Mouse press event function.

virtual void	onMouseMove (const UserInterface &userInterface, const Rendering::EngineRef &engine, const std::string &button, const Vector2 &screenPosition, const Line3 &ray, const Rendering::ObjectId pickedObject, const Vector3 &pickedPosition, const Timestamp timestamp)
	Mouse move event function.

virtual void	onMouseRelease (const UserInterface &userInterface, const Rendering::EngineRef &engine, const std::string &button, const Vector2 &screenPosition, const Line3 &ray, const Rendering::ObjectId pickedObject, const Vector3 &pickedPosition, const Timestamp timestamp)
	Mouse release event function.

virtual void	onKeyPress (const UserInterface &userInterface, const Rendering::EngineRef &engine, const std::string &key, const Timestamp timestamp)
	Key press function.

virtual void	onKeyRelease (const UserInterface &userInterface, const Rendering::EngineRef &engine, const std::string &key, const Timestamp timestamp)
	Key release function.

virtual void	release ()
	Releases this library.

Protected Member Functions
	Library (const std::string &name)
	Creates a new library object.

virtual	~Library ()
	Destructs a library object.

FileExtensions	registeredFileExtensions () const
	Returns all registered file extensions.

void	registerFileExtension (const std::string &extension, const std::string &description)
	Registers an additional file extension.

	Library (const Library &library)=delete
	Disabled copy constructor.

Library &	operator= (const Library &library)=delete
	Disabled copy operator.

Static Protected Member Functions
static bool	registerFactory (Library &library)
	Registers a library at the manager.

static bool	unregisterLibrary (const std::string &library)
	Unregisters a library at the manager.

Protected Attributes
std::string	libraryName
	Library name.

FileExtensions	libraryFileExtensions
	Map holding accepted file extensions supported by this library.

Friends
class	Manager

Detailed Description

This class implements the base class for all interaction libraries.

Member Typedef Documentation

◆ FileExtensions

using Ocean::Interaction::Library::FileExtensions = std::map<std::string, std::string>

Definition of a map mapping file extensions to file type descriptions.

Constructor & Destructor Documentation

◆ Library() [1/2]

Ocean::Interaction::Library::Library ( const std::string & name )

protected

Creates a new library object.

Parameters

name	The name of the library

◆ ~Library()

virtual Ocean::Interaction::Library::~Library ( )

protectedvirtual

Destructs a library object.

◆ Library() [2/2]

Ocean::Interaction::Library::Library ( const Library & library )

protecteddelete

Disabled copy constructor.

Parameters

library Object which would be copied

Member Function Documentation

◆ isFileExtensionSupported()

virtual bool Ocean::Interaction::Library::isFileExtensionSupported ( const std::string & extension ) const

virtual

Returns whether a specified file extension is supported by this interaction plugin.

Parameters

extension File extension to check

Returns: True, if suo

◆ load()

virtual bool Ocean::Interaction::Library::load	(	const UserInterface &	userInterface,
		const Rendering::EngineRef &	engine,
		const Timestamp	timestamp,
		const std::string &	filename
	)

pure virtual

Loads a new interaction file.

Parameters

userInterface	The application's UI elements
engine	Current engine
timestamp	Recent timestmap
filename	Name of the interaction file to load

Returns: True, if succeeded

Implemented in Ocean::Interaction::Empty::EPYLibrary, Ocean::Interaction::Experiences::ExperiencesLibrary, and Ocean::Interaction::JavaScript::JSLibrary.

◆ name()

const std::string & Ocean::Interaction::Library::name ( ) const

inline

Returns the name of this library.

Returns: Library name

◆ onKeyPress()

virtual void Ocean::Interaction::Library::onKeyPress	(	const UserInterface &	userInterface,
		const Rendering::EngineRef &	engine,
		const std::string &	key,
		const Timestamp	timestamp
	)

virtual

Key press function.

Parameters

userInterface	The application's UI elements
engine	Rendering engine currently used
key	Key which has been pressed
timestamp	Event timestamp

Reimplemented in Ocean::Interaction::Empty::EPYLibrary, Ocean::Interaction::Experiences::ExperiencesLibrary, and Ocean::Interaction::JavaScript::JSLibrary.

◆ onKeyRelease()

virtual void Ocean::Interaction::Library::onKeyRelease	(	const UserInterface &	userInterface,
		const Rendering::EngineRef &	engine,
		const std::string &	key,
		const Timestamp	timestamp
	)

virtual

Key release function.

Parameters

userInterface	The application's UI elements
engine	Rendering engine currently used
key	Key which has been pressed
timestamp	Event timestamp

Reimplemented in Ocean::Interaction::Empty::EPYLibrary, Ocean::Interaction::Experiences::ExperiencesLibrary, and Ocean::Interaction::JavaScript::JSLibrary.

◆ onMouseMove()

virtual void Ocean::Interaction::Library::onMouseMove	(	const UserInterface &	userInterface,
		const Rendering::EngineRef &	engine,
		const std::string &	button,
		const Vector2 &	screenPosition,
		const Line3 &	ray,
		const Rendering::ObjectId	pickedObject,
		const Vector3 &	pickedPosition,
		const Timestamp	timestamp
	)

virtual

Mouse move event function.

Parameters

userInterface	The application's UI elements
engine	Rendering engine currently used
button	Pressed mouse button
screenPosition	2D screen position of the mouse cursor
ray	3D picking ray
pickedObject	Name of the possible picked object
pickedPosition	Possible intersection point between mouse-pick-ray and 3D object
timestamp	Event timestamp

Reimplemented in Ocean::Interaction::Experiences::ExperiencesLibrary, and Ocean::Interaction::JavaScript::JSLibrary.

◆ onMousePress()

virtual void Ocean::Interaction::Library::onMousePress	(	const UserInterface &	userInterface,
		const Rendering::EngineRef &	engine,
		const std::string &	button,
		const Vector2 &	screenPosition,
		const Line3 &	ray,
		const Rendering::ObjectId	pickedObject,
		const Vector3 &	pickedPosition,
		const Timestamp	timestamp
	)

virtual

Mouse press event function.

Parameters

userInterface	The application's UI elements
engine	Rendering engine currently used
button	Pressed mouse button
screenPosition	2D screen position of the mouse cursor
ray	3D picking ray
pickedObject	Name of the possible picked object
pickedPosition	Possible intersection point between mouse-pick-ray and 3D object
timestamp	Event timestamp

Reimplemented in Ocean::Interaction::Experiences::ExperiencesLibrary, and Ocean::Interaction::JavaScript::JSLibrary.

◆ onMouseRelease()

virtual void Ocean::Interaction::Library::onMouseRelease	(	const UserInterface &	userInterface,
		const Rendering::EngineRef &	engine,
		const std::string &	button,
		const Vector2 &	screenPosition,
		const Line3 &	ray,
		const Rendering::ObjectId	pickedObject,
		const Vector3 &	pickedPosition,
		const Timestamp	timestamp
	)

virtual

Mouse release event function.

Parameters

userInterface	The application's UI elements
engine	Rendering engine currently used
button	Released mouse button
screenPosition	2D screen position of the mouse cursor
ray	3D picking ray
pickedObject	Name of the possible picked object
pickedPosition	Possible intersection point between mouse-pick-ray and 3D object
timestamp	Event timestamp

Reimplemented in Ocean::Interaction::Experiences::ExperiencesLibrary, and Ocean::Interaction::JavaScript::JSLibrary.

◆ operator=()

Library & Ocean::Interaction::Library::operator= ( const Library & library )

protecteddelete

Disabled copy operator.

Parameters

library Object which would be copied

Returns: Reference to this object

◆ postFileLoad()

virtual void Ocean::Interaction::Library::postFileLoad	(	const UserInterface &	userInterface,
		const std::string &	filename,
		const bool	succeeded
	)

virtual

Post file load interaction function.

Parameters

userInterface	The application's UI elements
filename	Filename of the loaded filename
succeeded	State determining whether the file has been loaded successfully

Reimplemented in Ocean::Interaction::Empty::EPYLibrary, Ocean::Interaction::Experiences::ExperiencesLibrary, and Ocean::Interaction::JavaScript::JSLibrary.

◆ postUpdate()

virtual void Ocean::Interaction::Library::postUpdate	(	const UserInterface &	userInterface,
		const Rendering::EngineRef &	engine,
		const Rendering::ViewRef &	view,
		const Timestamp	timestamp
	)

virtual

Post update interaction function.

Parameters

userInterface	The application's UI elements
engine	Engine which has been updated, must be valid
view	The view which will be used to render, must be valid
timestamp	Recent update timestamp

Reimplemented in Ocean::Interaction::Experiences::ExperiencesLibrary, and Ocean::Interaction::JavaScript::JSLibrary.

◆ preFileLoad()

virtual void Ocean::Interaction::Library::preFileLoad	(	const UserInterface &	userInterface,
		const std::string &	filename
	)

virtual

Pre file load interaction function.

Parameters

userInterface	The application's UI elements
filename	Filename of the file to be loaded

Reimplemented in Ocean::Interaction::Empty::EPYLibrary, Ocean::Interaction::Experiences::ExperiencesLibrary, and Ocean::Interaction::JavaScript::JSLibrary.

◆ preUpdate()

virtual Timestamp Ocean::Interaction::Library::preUpdate	(	const UserInterface &	userInterface,
		const Rendering::EngineRef &	engine,
		const Rendering::ViewRef &	view,
		const Timestamp	timestamp
	)

virtual

Pre update interaction function.

This function is invoked before each update process, the application interaction module has the possibility to return a different preferred update timestamp.

Parameters

userInterface	The application's UI elements
engine	Engine to be updated, must be valid
view	The view which will be used to render, must be valid
timestamp	Recent update timestmap

Returns: Timestamp which should be used for the update process, if the timestamp is null any timestamp can be used

Reimplemented in Ocean::Interaction::Experiences::ExperiencesLibrary, and Ocean::Interaction::JavaScript::JSLibrary.

◆ registeredFileExtensions()

Library::FileExtensions Ocean::Interaction::Library::registeredFileExtensions ( ) const

inlineprotected

Returns all registered file extensions.

Returns: Registered file extensions

◆ registerFactory()

static bool Ocean::Interaction::Library::registerFactory ( Library & library )

staticprotected

Registers a library at the manager.

Each library should be registered at most once.

Parameters

library Library to register

Returns: True, if the library hasn't been registered before

◆ registerFileExtension()

void Ocean::Interaction::Library::registerFileExtension	(	const std::string &	extension,
		const std::string &	description
	)

protected

Registers an additional file extension.

Parameters

extension	New file extension to register
description	Description of the file type

◆ release()

virtual void Ocean::Interaction::Library::release ( )

virtual

Releases this library.

Reimplemented in Ocean::Interaction::Experiences::ExperiencesLibrary.

◆ unload() [1/2]

virtual void Ocean::Interaction::Library::unload	(	const UserInterface &	userInterface,
		const Rendering::EngineRef &	engine,
		const Timestamp	timestamp
	)

pure virtual

Unloads all loaded scripts.

Parameters

userInterface	The application's UI elements
engine	Current engine
timestamp	Recent timestmap

Implemented in Ocean::Interaction::Empty::EPYLibrary, Ocean::Interaction::Experiences::ExperiencesLibrary, and Ocean::Interaction::JavaScript::JSLibrary.

◆ unload() [2/2]

virtual bool Ocean::Interaction::Library::unload	(	const UserInterface &	userInterface,
		const Rendering::EngineRef &	engine,
		const Timestamp	timestamp,
		const std::string &	filename
	)

pure virtual

Unloads one specific loaded interaction files.

Parameters

userInterface	The application's UI elements
engine	Current engine
timestamp	Recent timestmap
filename	Filename of the interaction to be unloaded

Returns: True, if succeeded

See also: Manager::unload().

Implemented in Ocean::Interaction::Empty::EPYLibrary, Ocean::Interaction::Experiences::ExperiencesLibrary, and Ocean::Interaction::JavaScript::JSLibrary.

◆ unregisterLibrary()

static bool Ocean::Interaction::Library::unregisterLibrary ( const std::string & library )

staticprotected

Unregisters a library at the manager.

Parameters

library Name of the library to unregister

Returns: True, if succeeded

Friends And Related Symbol Documentation

◆ Manager

friend class Manager

friend

Field Documentation

◆ libraryFileExtensions

FileExtensions Ocean::Interaction::Library::libraryFileExtensions

protected

Map holding accepted file extensions supported by this library.

◆ libraryName

std::string Ocean::Interaction::Library::libraryName

protected

Library name.

The documentation for this class was generated from the following file:

interaction/Library.h

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ FileExtensions

Constructor & Destructor Documentation

◆ Library() [1/2]

◆ ~Library()

◆ Library() [2/2]

Member Function Documentation

◆ isFileExtensionSupported()

◆ load()

◆ name()

◆ onKeyPress()

◆ onKeyRelease()

◆ onMouseMove()

◆ onMousePress()

◆ onMouseRelease()

◆ operator=()

◆ postFileLoad()

◆ postUpdate()

◆ preFileLoad()

◆ preUpdate()

◆ registeredFileExtensions()

◆ registerFactory()

◆ registerFileExtension()

◆ release()

◆ unload() [1/2]

◆ unload() [2/2]

◆ unregisterLibrary()

Friends And Related Symbol Documentation

◆ Manager

Field Documentation

◆ libraryFileExtensions

◆ libraryName