#include <SLAssetLoader.h>

Public Member Functions
	SLAssetLoader (SLstring modelPath, SLstring texturePath, SLstring shaderPath, SLstring fontPath)

	~SLAssetLoader ()

void	scene (SLScene *scene)

bool	isLoading () const

SLstring	modelPath () const

SLstring	shaderPath () const

SLstring	texturePath () const

void	addRawDataToLoad (SLIOBuffer &buffer, SLstring filename, SLIOStreamKind kind)

void	addTextureToLoad (SLGLTexture *&texture, const SLstring &path, SLint min_filter=GL_LINEAR_MIPMAP_LINEAR, SLint mag_filter=GL_LINEAR, SLTextureType type=TT_unknown, SLint wrapS=GL_REPEAT, SLint wrapT=GL_REPEAT)
	Add 2D textures with internal image allocation. More...

void	addTextureToLoad (SLGLTexture *&texture, const SLstring &imageFilenameXPos, const SLstring &imageFilenameXNeg, const SLstring &imageFilenameYPos, const SLstring &imageFilenameYNeg, const SLstring &imageFilenameZPos, const SLstring &imageFilenameZNeg, SLint min_filter=GL_LINEAR, SLint mag_filter=GL_LINEAR, SLTextureType type=TT_unknown)
	Add cube map texture with internal image allocation. More...

void	addTextureToLoad (SLGLTexture *&texture, SLint depth, const SLstring &path, SLint min_filter=GL_LINEAR, SLint mag_filter=GL_LINEAR, SLint wrapS=GL_REPEAT, SLint wrapT=GL_REPEAT, const SLstring &name="3D-Texture", SLbool loadGrayscaleIntoAlpha=false)
	Add 3D texture from a single file with depth as 3rd dimension. More...

void	addTextureToLoad (SLGLTexture *&texture, const SLVstring &imagePaths, SLint min_filter, SLint mag_filter, SLint wrapS, SLint wrapT, const SLstring &name, SLbool loadGrayscaleIntoAlpha)
	Add 3D texture from a vector of files. More...

void	addGeoTiffToLoad (SLDeviceLocation &devLoc, const SLstring &imageFileWithPath)
	Add GeoTiff file to load for the SLDevLocation. More...

void	addNodeToLoad (SLNode &node, const SLstring &modelPath, SLSkybox skybox=nullptr, SLbool deleteTexImgAfterBuild=false, SLbool loadMeshesOnly=true, SLMaterial *overrideMat=nullptr, float ambientFactor=0.5f, SLbool forceCookTorranceRM=false, SLuint flags=SLProcess_Triangulate\|SLProcess_JoinIdenticalVertices\|SLProcess_RemoveRedundantMaterials\|SLProcess_FindDegenerates\|SLProcess_FindInvalidData\|SLProcess_SplitLargeMeshes)
	Add mesh from file to load via assimp loader. More...

void	addProgramToLoad (SLGLProgram *&program, const SLstring &vertShaderFile, const SLstring &fragShaderFile)
	Add generic GLSL program with shader files to load. More...

void	addSkyboxToLoad (SLSkybox *&skybox, const SLstring &path, SLVec2i resolution, SLstring name)
	Add skybox with HDR texture to load. More...

void	addSkyboxToLoad (SLSkybox *&skybox, const SLstring &cubeMapXPos, const SLstring &cubeMapXNeg, const SLstring &cubeMapYPos, const SLstring &cubeMapYNeg, const SLstring &cubeMapZPos, const SLstring &cubeMapZNeg)
	Add skybox with 6 textures for a cubemap to load. More...

void	addLoadTask (SLAssetLoadTask task)
	Add generic task. More...

void	loadAssetsSync ()

void	loadAssetsAsync (function< void()> onDone)

void	checkIfAsyncLoadingIsDone ()

Public Attributes
SLScene *	_scene

SLAssetManager *	_am

SLstring	_modelPath

SLstring	_texturePath

SLstring	_shaderPath

SLstring	_fontPath

SLVAssetLoadTask	_loadTasks

function< void()>	_onDoneLoading
	Callback after threaded loading. More...

thread	_worker
	worker thread for parallel loading More...

atomic< State >	_state
	current state (used for communication between threads) More...

mutex	_messageMutex
	mutex protecting state between threads More...

condition_variable	_messageCondVar
	mutex for waiting until state has changed More...

Private Types
enum class	State { IDLE , SUBMITTED , WORKING , DONE , STOPPING , STOPPED }

Detailed Description

Definition at line 44 of file SLAssetLoader.h.

Member Enumeration Documentation

◆ State

enum SLAssetLoader::State

strongprivate

Enumerator
IDLE
SUBMITTED
WORKING
DONE
STOPPING
STOPPED

Definition at line 47 of file SLAssetLoader.h.

     {
         IDLE,
         SUBMITTED,
         WORKING,
         DONE,
         STOPPING,
         STOPPED
     };

Constructor & Destructor Documentation

◆ SLAssetLoader()

SLAssetLoader::SLAssetLoader	(	SLstring	modelPath,
		SLstring	texturePath,
		SLstring	shaderPath,
		SLstring	fontPath
	)

Definition at line 27 of file SLAssetLoader.cpp.

   : _modelPath(modelPath),
     _texturePath(texturePath),
     _shaderPath(shaderPath),
     _fontPath(fontPath),
     _state(State::IDLE)
 {
     auto workerFunc = [this]()
     {
         while (true)
         {
             // Wait until the main thread sends a message.
             // 'Sending a message' means updating the state to a value that instructs
             // the worker thread to do something.
             unique_lock lock(_messageMutex);
             _messageCondVar.wait(lock, [this]()
                                  { return _state == State::SUBMITTED || _state == State::STOPPING; });
  
             // Do something depending on the current state.
             if (_state == State::SUBMITTED)
             {
                 // Process the tasks defined by the main thread.
                 for (SLAssetLoadTask& task : _loadTasks)
                     task();
  
                 // Notify the main thread that the worker thread is done.
                 // The main thread checks this in checkIfAsyncLoadingIsDone.
                 _state = State::DONE;
             }
             else if (_state == State::STOPPING)
             {
                 // Stops the worker thread by jumping...
                 break;
             }
         }
  
         // ...here and notifying the main thread that it can now join the worker thread.
         _state = State::STOPPED;
         _messageCondVar.notify_one();
     };
  
     _worker = std::thread(workerFunc);
 }

◆ ~SLAssetLoader()

SLAssetLoader::~SLAssetLoader ( )

Definition at line 74 of file SLAssetLoader.cpp.

 {
     // Instruct the worker thread to stop.
     unique_lock lock(_messageMutex);
     _state = State::STOPPING;
     lock.unlock();
     _messageCondVar.notify_one();
  
     // Wait until the worker thread has stopped so we can join it.
     lock.lock();
     _messageCondVar.wait(lock, [this]()
                          { return _state == State::STOPPED; });
     _worker.join();
 }

Member Function Documentation

◆ addGeoTiffToLoad()

void SLAssetLoader::addGeoTiffToLoad	(	SLDeviceLocation &	devLoc,
		const SLstring &	imageFileWithPath
	)

Add GeoTiff file to load for the SLDevLocation.

Definition at line 229 of file SLAssetLoader.cpp.

 {
     _loadTasks.push_back([this,
                           &devLoc,
                           imageFileWithPath]
                          { devLoc.loadGeoTiff(imageFileWithPath); });
 }

◆ addLoadTask()

void SLAssetLoader::addLoadTask ( SLAssetLoadTask task )

Add generic task.

Definition at line 304 of file SLAssetLoader.cpp.

 {
     _loadTasks.push_back(task);
 }

◆ addNodeToLoad()

void SLAssetLoader::addNodeToLoad	(	SLNode *&	node,
		const SLstring &	modelPath,
		SLSkybox *	skybox = `nullptr`,
		SLbool	deleteTexImgAfterBuild = `false`,
		SLbool	loadMeshesOnly = `true`,
		SLMaterial *	overrideMat = `nullptr`,
		float	ambientFactor = `0.5f`,
		SLbool	forceCookTorranceRM = `false`,
		SLuint	flags = `SLProcess_Triangulate \| SLProcess_JoinIdenticalVertices \| SLProcess_RemoveRedundantMaterials \| SLProcess_FindDegenerates \| SLProcess_FindInvalidData \| SLProcess_SplitLargeMeshes`
	)

Add mesh from file to load via assimp loader.

Definition at line 251 of file SLAssetLoader.cpp.

 {
     _loadTasks.push_back([this,
                           &node,
                           modelPath,
                           skybox,
                           deleteTexImgAfterBuild,
                           loadMeshesOnly,
                           overrideMat,
                           ambientFactor,
                           forceCookTorranceRM,
                           flags]
                          {
         SLAssimpImporter importer;
         node = importer.load(_scene->animManager(),
                              _scene->assetManager(),
                              modelPath,
                              _texturePath,
                              skybox,
                              deleteTexImgAfterBuild,
                              loadMeshesOnly,
                              overrideMat,
                              ambientFactor,
                              forceCookTorranceRM,
                              nullptr,
                              flags); });
 }

◆ addProgramToLoad()

void SLAssetLoader::addProgramToLoad	(	SLGLProgram *&	program,
		const SLstring &	vertShaderFile,
		const SLstring &	fragShaderFile
	)

Add generic GLSL program with shader files to load.

Definition at line 238 of file SLAssetLoader.cpp.

 {
     _loadTasks.push_back([this,
                           &program,
                           vertShaderPath,
                           fragShaderPath]
                          { program = new SLGLProgramGeneric(_scene->assetManager(),
                                                             vertShaderPath,
                                                             fragShaderPath); });
 }

◆ addRawDataToLoad()

void SLAssetLoader::addRawDataToLoad	(	SLIOBuffer &	buffer,
		SLstring	filename,
		SLIOStreamKind	kind
	)

Definition at line 89 of file SLAssetLoader.cpp.

 {
     _loadTasks.push_back([this, &buffer, filename, kind]
                          { buffer = SLFileStorage::readIntoBuffer(filename, kind); });
 }

◆ addSkyboxToLoad() [1/2]

void SLAssetLoader::addSkyboxToLoad	(	SLSkybox *&	skybox,
		const SLstring &	cubeMapXPos,
		const SLstring &	cubeMapXNeg,
		const SLstring &	cubeMapYPos,
		const SLstring &	cubeMapYNeg,
		const SLstring &	cubeMapZPos,
		const SLstring &	cubeMapZNeg
	)

Add skybox with 6 textures for a cubemap to load.

Definition at line 309 of file SLAssetLoader.cpp.

 {
     _loadTasks.push_back([this,
                           &skybox,
                           cubeMapXPos,
                           cubeMapXNeg,
                           cubeMapYPos,
                           cubeMapYNeg,
                           cubeMapZPos,
                           cubeMapZNeg]
                          { skybox = new SLSkybox(_scene->assetManager(),
                                                  _shaderPath,
                                                  _texturePath + cubeMapXPos,
                                                  _texturePath + cubeMapXNeg,
                                                  _texturePath + cubeMapYPos,
                                                  _texturePath + cubeMapYNeg,
                                                  _texturePath + cubeMapZPos,
                                                  _texturePath + cubeMapZNeg); });
 }

◆ addSkyboxToLoad() [2/2]

void SLAssetLoader::addSkyboxToLoad	(	SLSkybox *&	skybox,
		const SLstring &	path,
		SLVec2i	resolution,
		SLstring	name
	)

Add skybox with HDR texture to load.

Definition at line 287 of file SLAssetLoader.cpp.

 {
     _loadTasks.push_back([this,
                           &skybox,
                           hdrImageWithFullPath,
                           resolution,
                           name]
                          { skybox = new SLSkybox(_scene->assetManager(),
                                                  _shaderPath,
                                                  hdrImageWithFullPath,
                                                  resolution,
                                                  name); });
 }

◆ addTextureToLoad() [1/4]

void SLAssetLoader::addTextureToLoad	(	SLGLTexture *&	texture,
		const SLstring &	imageFilenameXPos,
		const SLstring &	imageFilenameXNeg,
		const SLstring &	imageFilenameYPos,
		const SLstring &	imageFilenameYNeg,
		const SLstring &	imageFilenameZPos,
		const SLstring &	imageFilenameZNeg,
		SLint	min_filter = `GL_LINEAR`,
		SLint	mag_filter = `GL_LINEAR`,
		SLTextureType	type = `TT_unknown`
	)

Add cube map texture with internal image allocation.

Definition at line 122 of file SLAssetLoader.cpp.

 {
     _loadTasks.push_back([this,
                           &texture,
                           filenameXPos,
                           filenameXNeg,
                           filenameYPos,
                           filenameYNeg,
                           filenameZPos,
                           filenameZNeg,
                           min_filter,
                           mag_filter,
                           type]
                          { texture = new SLGLTexture(_scene->assetManager(),
                                                      filenameXPos,
                                                      filenameXNeg,
                                                      filenameYPos,
                                                      filenameYNeg,
                                                      filenameZPos,
                                                      filenameZNeg,
                                                      min_filter,
                                                      mag_filter,
                                                      type); });
 }

◆ addTextureToLoad() [2/4]

void SLAssetLoader::addTextureToLoad	(	SLGLTexture *&	texture,
		const SLstring &	path,
		SLint	min_filter = `GL_LINEAR_MIPMAP_LINEAR`,
		SLint	mag_filter = `GL_LINEAR`,
		SLTextureType	type = `TT_unknown`,
		SLint	wrapS = `GL_REPEAT`,
		SLint	wrapT = `GL_REPEAT`
	)

Add 2D textures with internal image allocation.

Definition at line 97 of file SLAssetLoader.cpp.

 {
     _loadTasks.push_back([this,
                           &texture,
                           path,
                           min_filter,
                           mag_filter,
                           type,
                           wrapS,
                           wrapT]
                          { texture = new SLGLTexture(_scene->assetManager(),
                                                      path,
                                                      min_filter,
                                                      mag_filter,
                                                      type,
                                                      wrapS,
                                                      wrapT); });
 }

◆ addTextureToLoad() [3/4]

void SLAssetLoader::addTextureToLoad	(	SLGLTexture *&	texture,
		const SLVstring &	imagePaths,
		SLint	min_filter,
		SLint	mag_filter,
		SLint	wrapS,
		SLint	wrapT,
		const SLstring &	name,
		SLbool	loadGrayscaleIntoAlpha
	)

Add 3D texture from a vector of files.

Method for adding a 3D texture from a vector of images to load in parallel thread.

Parameters

texture	Pointer to SLGLTexture to return
imageFilenames	Vector of texture image files. If only filenames are passed they will be searched on the SLGLTexture::defaultPath.
min_filter	Minification filter constant from OpenGL
mag_filter	Magnification filter constant from OpenGL
wrapS	Texture wrapping in S direction (OpenGL constant)
wrapT	Texture wrapping in T direction (OpenGL constant)
name	Name of the 3D texture
loadGrayscaleIntoAlpha	Flag if grayscale image should be loaded into alpha channel.

Definition at line 201 of file SLAssetLoader.cpp.

 {
     _loadTasks.push_back([this,
                           &texture,
                           imagePaths,
                           min_filter,
                           mag_filter,
                           wrapS,
                           wrapT,
                           name,
                           loadGrayscaleIntoAlpha]
                          { texture = new SLGLTexture(_scene->assetManager(),
                                                      imagePaths,
                                                      min_filter,
                                                      mag_filter,
                                                      wrapS,
                                                      wrapT,
                                                      name,
                                                      loadGrayscaleIntoAlpha); });
 }

◆ addTextureToLoad() [4/4]

void SLAssetLoader::addTextureToLoad	(	SLGLTexture *&	texture,
		SLint	depth,
		const SLstring &	path,
		SLint	min_filter = `GL_LINEAR`,
		SLint	mag_filter = `GL_LINEAR`,
		SLint	wrapS = `GL_REPEAT`,
		SLint	wrapT = `GL_REPEAT`,
		const SLstring &	name = `"3D-Texture"`,
		SLbool	loadGrayscaleIntoAlpha = `false`
	)

Add 3D texture from a single file with depth as 3rd dimension.

Definition at line 156 of file SLAssetLoader.cpp.

 {
     _loadTasks.push_back([this,
                           &texture,
                           depth,
                           imagePath,
                           min_filter,
                           mag_filter,
                           wrapS,
                           wrapT,
                           name,
                           loadGrayscaleIntoAlpha]
                          { texture = new SLGLTexture(_scene->assetManager(),
                                                      depth,
                                                      imagePath,
                                                      min_filter,
                                                      mag_filter,
                                                      wrapS,
                                                      wrapT,
                                                      name,
                                                      loadGrayscaleIntoAlpha); });
 }

◆ checkIfAsyncLoadingIsDone()

void SLAssetLoader::checkIfAsyncLoadingIsDone ( )

This method is called from the main thread to check if the async loading is is finished. If so, the assembly can be done in _onDoneLoading.

Definition at line 357 of file SLAssetLoader.cpp.

 {
     if (_state == State::DONE)
     {
         _state = State::IDLE;
         _loadTasks.clear();
  
         _onDoneLoading();
     }
 }

◆ isLoading()

bool SLAssetLoader::isLoading ( ) const

inline

Definition at line 68 of file SLAssetLoader.h.

68 { return _state != State::IDLE; }

◆ loadAssetsAsync()

void SLAssetLoader::loadAssetsAsync ( function< void()> onDone )

Definition at line 343 of file SLAssetLoader.cpp.

 {
     _onDoneLoading = onDoneLoading;
  
     // Instruct the worker thread to start processing tasks.
     unique_lock lock(_messageMutex);
     _state = State::SUBMITTED;
     lock.unlock();
     _messageCondVar.notify_one();
 }

◆ loadAssetsSync()

void SLAssetLoader::loadAssetsSync ( )

Definition at line 335 of file SLAssetLoader.cpp.

 {
     for (const SLAssetLoadTask& task : _loadTasks)
         task();
  
     _loadTasks.clear();
 }

◆ modelPath()

SLstring SLAssetLoader::modelPath ( ) const

inline

Definition at line 69 of file SLAssetLoader.h.

69 { return _modelPath; }

◆ scene()

void SLAssetLoader::scene ( SLScene * scene )

inline

Definition at line 65 of file SLAssetLoader.h.

65 { _scene = scene; }

SLAssetLoader::scene

void scene(SLScene *scene)

Definition: SLAssetLoader.h:65

◆ shaderPath()

SLstring SLAssetLoader::shaderPath ( ) const

inline

Definition at line 70 of file SLAssetLoader.h.

70 { return _shaderPath; }

◆ texturePath()

SLstring SLAssetLoader::texturePath ( ) const

inline

Definition at line 71 of file SLAssetLoader.h.

71 { return _texturePath; }

Member Data Documentation

◆ _am

SLAssetManager* SLAssetLoader::_am

Definition at line 169 of file SLAssetLoader.h.

◆ _fontPath

SLstring SLAssetLoader::_fontPath

Definition at line 173 of file SLAssetLoader.h.

◆ _loadTasks

SLVAssetLoadTask SLAssetLoader::_loadTasks

Definition at line 174 of file SLAssetLoader.h.

◆ _messageCondVar

condition_variable SLAssetLoader::_messageCondVar

mutex for waiting until state has changed

Definition at line 180 of file SLAssetLoader.h.

◆ _messageMutex

mutex SLAssetLoader::_messageMutex

mutex protecting state between threads

Definition at line 179 of file SLAssetLoader.h.

◆ _modelPath

SLstring SLAssetLoader::_modelPath

Definition at line 170 of file SLAssetLoader.h.

◆ _onDoneLoading

function<void()> SLAssetLoader::_onDoneLoading

Callback after threaded loading.

Definition at line 175 of file SLAssetLoader.h.

◆ _scene

SLScene* SLAssetLoader::_scene

Definition at line 168 of file SLAssetLoader.h.

◆ _shaderPath

SLstring SLAssetLoader::_shaderPath

Definition at line 172 of file SLAssetLoader.h.

◆ _state

atomic<State> SLAssetLoader::_state

current state (used for communication between threads)

Definition at line 178 of file SLAssetLoader.h.

◆ _texturePath

SLstring SLAssetLoader::_texturePath

Definition at line 171 of file SLAssetLoader.h.

◆ _worker

thread SLAssetLoader::_worker

worker thread for parallel loading

Definition at line 177 of file SLAssetLoader.h.

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

Public Member Functions

Public Attributes

Private Types

Detailed Description

Member Enumeration Documentation

◆ State

Constructor & Destructor Documentation

◆ SLAssetLoader()

◆ ~SLAssetLoader()

Member Function Documentation

◆ addGeoTiffToLoad()

◆ addLoadTask()

◆ addNodeToLoad()

◆ addProgramToLoad()

◆ addRawDataToLoad()

◆ addSkyboxToLoad() [1/2]

◆ addSkyboxToLoad() [2/2]

◆ addTextureToLoad() [1/4]

◆ addTextureToLoad() [2/4]

◆ addTextureToLoad() [3/4]

◆ addTextureToLoad() [4/4]

◆ checkIfAsyncLoadingIsDone()

◆ isLoading()

◆ loadAssetsAsync()

◆ loadAssetsSync()

◆ modelPath()

◆ scene()

◆ shaderPath()

◆ texturePath()

Member Data Documentation

◆ _am

◆ _fontPath

◆ _loadTasks

◆ _messageCondVar

◆ _messageMutex

◆ _modelPath

◆ _onDoneLoading

◆ _scene

◆ _shaderPath

◆ _state

◆ _texturePath

◆ _worker