Ocean
Ocean SceneDescription SDL OBJ Library

The Ocean SceneDescription SDL OBJ Library implements a scene description interface for obj files. More...

Collaboration diagram for Ocean SceneDescription SDL OBJ Library:

Modules

 Ocean Scene Description SDL OBJ JNI Library
 The Ocean Scene Description SDL OBJ JNI Library provides a Java Native Interface for Android.
 

Data Structures

class  Ocean::SceneDescription::SDL::OBJ::Material
 This class hold a material defined in a mtl obj material file. More...
 
class  Ocean::SceneDescription::SDL::OBJ::MtlParser
 This class implements a obj material parser able to parse mtl files. More...
 
class  Ocean::SceneDescription::SDL::OBJ::MtlScanner
 This class implements a scanner able to scan obj mtl token. More...
 
class  Ocean::SceneDescription::SDL::OBJ::OBJLibrary
 This class implements the scene library for all obj file types. More...
 
class  Ocean::SceneDescription::SDL::OBJ::OBJScanner
 This class implements a scanner able to scan obj token. More...
 
class  Ocean::SceneDescription::SDL::OBJ::OBJScene
 This class holds the entire scene contained in one obj file. More...
 

Functions

OCEAN_SCENEDESCRIPTION_SDL_OBJ_EXPORT std::string Ocean::SceneDescription::SDL::OBJ::nameOBJLibrary ()
 Returns the name of this OBJ scenedescription library. More...
 
void Ocean::SceneDescription::SDL::OBJ::registerOBJLibrary ()
 Registers this scenedescription library at the global scenedescription manager. More...
 
bool Ocean::SceneDescription::SDL::OBJ::unregisterOBJLibrary ()
 Unregisters this scenedescription library at the global scenedescription manager. More...
 
bool OCEAN_SCENEDESCRIPTION_SDL_OBJ_EXPORT pluginLoad ()
 Tries to load the plugin and initializes all internal 3rd party libraries. More...
 
bool OCEAN_SCENEDESCRIPTION_SDL_OBJ_EXPORT pluginUnload ()
 Tries to unload the plugin and all internal resources of 3rd party libraries. More...
 

Detailed Description

The Ocean SceneDescription SDL OBJ Library implements a scene description interface for obj files.


The library is platform independent.
Do not use any specific function of this library directly, use the abstract interface of the Manager object instead.

See also
Manager.

Function Documentation

◆ nameOBJLibrary()

OCEAN_SCENEDESCRIPTION_SDL_OBJ_EXPORT std::string Ocean::SceneDescription::SDL::OBJ::nameOBJLibrary ( )

Returns the name of this OBJ scenedescription library.

◆ pluginLoad()

bool OCEAN_SCENEDESCRIPTION_SDL_OBJ_EXPORT 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().

◆ pluginUnload()

bool OCEAN_SCENEDESCRIPTION_SDL_OBJ_EXPORT 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().

◆ registerOBJLibrary()

void Ocean::SceneDescription::SDL::OBJ::registerOBJLibrary ( )

Registers this scenedescription library at the global scenedescription manager.

This function calls OBJLibrary::registerLibrary() only.

◆ unregisterOBJLibrary()

bool Ocean::SceneDescription::SDL::OBJ::unregisterOBJLibrary ( )

Unregisters this scenedescription library at the global scenedescription manager.

This function calls OBJLibrary::unregisterLibrary() only.

Returns
True, if succeeded