conscience_core::core_objects::element_3d::Csc3dElementModelsLibraryService Class Reference

#include <Csc3dElementModelsLibraryService.h>

Public Member Functions
	Csc3dElementModelsLibraryService ()
bool	ping () const
vector< CscLibrary3dElementModel * >	list (Csc3dElementType elementType, optional< CscWorldElementModelFormat > requestedFormat={}) const
vector< string >	listIds (Csc3dElementType elementType) const
CscLibrary3dElementModel *	getById (Csc3dElementType elementType, string id) const
void	downloadLogo (Csc3dElementType elementType, const string &id, const fs::path &outFilePath) const
optional< bool >	hasPhysicsSpecsFileChanged (Csc3dElementType elementType, const string &id, CscWorldElementModelFormat format, const Csc3dElementModelPhysicsFileFootprint &fileFootprint) const
void	downloadPhysicsSpecsFile (Csc3dElementType elementType, const string &id, const fs::path &outFilePath, CscWorldElementModelFormat format, optional< function< void(float progressRatio)>> onProgress={}) const
void	setTimeoutSeconds (optional< unsigned > timeoutSeconds)
void	setPingTimeoutSeconds (optional< unsigned > timeoutSeconds)
void	setDownloadTimeoutSeconds (optional< unsigned > timeoutSeconds)

Constructor & Destructor Documentation

Csc3dElementModelsLibraryService()

conscience_core::core_objects::element_3d::Csc3dElementModelsLibraryService::Csc3dElementModelsLibraryService

(

)

Member Function Documentation

downloadLogo()

void conscience_core::core_objects::element_3d::Csc3dElementModelsLibraryService::downloadLogo	(	Csc3dElementType	elementType,
		const string &	id,
		const fs::path &	outFilePath
	)		const

downloadPhysicsSpecsFile()

void conscience_core::core_objects::element_3d::Csc3dElementModelsLibraryService::downloadPhysicsSpecsFile	(	Csc3dElementType	elementType,
		const string &	id,
		const fs::path &	outFilePath,
		CscWorldElementModelFormat	format,
		optional< function< void(float progressRatio)>>	onProgress = {}
	)		const

getById()

CscLibrary3dElementModel * conscience_core::core_objects::element_3d::Csc3dElementModelsLibraryService::getById	(	Csc3dElementType	elementType,
		string	id
	)		const

hasPhysicsSpecsFileChanged()

optional< bool > conscience_core::core_objects::element_3d::Csc3dElementModelsLibraryService::hasPhysicsSpecsFileChanged	(	Csc3dElementType	elementType,
		const string &	id,
		CscWorldElementModelFormat	format,
		const Csc3dElementModelPhysicsFileFootprint &	fileFootprint
	)		const

Parameters

id	3d model id (place model id, entity model id, object model id..)
fileFootprint	existing file data : file size and hash

Returns

true if file has changed, false otherwise, empty if file not found on library

list()

vector< CscLibrary3dElementModel * > conscience_core::core_objects::element_3d::Csc3dElementModelsLibraryService::list	(	Csc3dElementType	elementType,
		optional< CscWorldElementModelFormat >	requestedFormat = {}
	)		const

Parameters

requestedFormat

if specified, filters available models based on format

listIds()

vector< string > conscience_core::core_objects::element_3d::Csc3dElementModelsLibraryService::listIds

(

Csc3dElementType

elementType

)

const

ping()

bool conscience_core::core_objects::element_3d::Csc3dElementModelsLibraryService::ping

(

)

const

setDownloadTimeoutSeconds()

void conscience_core::core_objects::element_3d::Csc3dElementModelsLibraryService::setDownloadTimeoutSeconds

(

optional< unsigned >

timeoutSeconds

)

setPingTimeoutSeconds()

void conscience_core::core_objects::element_3d::Csc3dElementModelsLibraryService::setPingTimeoutSeconds

(

optional< unsigned >

timeoutSeconds

)

setTimeoutSeconds()

void conscience_core::core_objects::element_3d::Csc3dElementModelsLibraryService::setTimeoutSeconds

(

optional< unsigned >

timeoutSeconds

)

---

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

• CoreObjects/Csc3dElement/Csc3dElementModelsLibraryService.h
• CoreObjects/Csc3dElement/Csc3dElementModelsLibraryService.cpp