Assets Class Reference

#include <assets.h>

Public Member Functions
	LM_COMPONENT_INTERFACE_DEF ("assets")
virtual bool	Load (const ConfigNode &node)=0
virtual Asset *	GetAssetByName (const std::string &name) const =0
virtual boost::signals2::connection	Connect_ReportProgress (const std::function< void(double, bool)> &func)=0
virtual bool	RegisterInterface (const std::string &interfaceName, const std::string &interfaceGroupName, const std::vector< std::string > &dependencies)=0
template<typename AssetInterfaceType >
bool	RegisterInterface ()
LM_PUBLIC_API Asset *	ResolveReferenceToAsset (const ConfigNode &node, const std::string &type) const
template<typename AssetInterfaceType >
AssetInterfaceType *	ResolveReferenceToAsset (const ConfigNode &node) const
template<typename AssetInterfaceType >
LM_NAMESPACE_BEGIN bool	RegisterInterface ()
Public Member Functions inherited from Component
virtual std::string	ComponentInterfaceTypeName () const =0
virtual std::string	ComponentImplTypeName () const =0
Public Member Functions inherited from SIMDAlignedType
void *	operator new (std::size_t size) throw (std::bad_alloc)
void	operator delete (void *p)

Detailed Description

Collection of assets. The asset collection class for the asset management.

Inheritance diagram for Assets:

Member Function Documentation

virtual boost::signals2::connection Assets::Connect_ReportProgress ( const std::function< void(double, bool)> &  func )

pure virtual

Connect to ReportProgress signal. The signal is emitted when the progress of asset loading is changed.

Parameters

func	Slot function.

Implemented in AssetsImpl.

virtual Asset* Assets::GetAssetByName ( const std::string &  name ) const

pure virtual

Get an asset by name. Returns nullptr if not found.

Parameters

name	Name of the asset.

Returns

Asset instance.

Implemented in AssetsImpl, and StubAssets.

virtual bool Assets::Load ( const ConfigNode &  node )

pure virtual

Load assets from XML element. Parse the element #node and register assets.

Parameters

node	A XML element which consists of the assets element.

Return values

true	Succeeded to load assets.
false	Failed to load assets.

Implemented in AssetsImpl, and StubAssets.

virtual bool Assets::RegisterInterface ( const std::string &  interfaceName, const std::string &  interfaceGroupName, const std::vector< std::string > &  dependencies  )

pure virtual

Register an interface for assets. Register an component interface class for assets creation. The class must inherit Assets and specify dependencies to the other asset types with LM_ASSET_DEPENDENCIES macro. Fails if the factory with same name is already registered.

Parameters

interfaceName	Name of component interface class which is inherited from Asset.
interfaceGroupName	Name of interface group. e.g. triangle_meshes for triangle_mesh type.
dependencies	Dependent asset interface names.

Return values

true	Succeeded to register.
false	Failed to register.

See also

LM_ASSET_DEPENDENCIES

Implemented in AssetsImpl, and StubAssets.

template<typename AssetInterfaceType >

bool Assets::RegisterInterface

(

)

Register an interface for assets. Register an component interface class for assets creation. This template version statically checks the requirement for types.

Template Parameters

AssetInterfaceType

Type of component interface class which is inherited from Asset.

Return values

true	Succeeded to register.
false	Failed to register.

See also

LM_ASSET_DEPENDENCIES

Asset * Assets::ResolveReferenceToAsset	(	const ConfigNode &	node,
		const std::string &	type
	)		const

Resolve reference to the asset. Resolve reference to an asset using ref attribute. Returns nullptr if ref attribute is not found.

Parameters

node	A XML element which consists of the ref attribute.
type	Target asset type, e.g. triangle_mesh.

Returns

Resolved asset.

template<typename AssetInterfaceType >

AssetInterfaceType * Assets::ResolveReferenceToAsset

(

const ConfigNode &

node

)

const

Resolve reference to the asset. Template version of ResolveReferenceToAsset.

Template Parameters

AssetInterfaceType

Asset interface type.

Parameters

node	A XML element which consists of the ref attribute.

Returns

Resolved asset.

---

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

• /home/travis/build/hi2p-perim/lightmetrica/include/lightmetrica/assets.h
• /home/travis/build/hi2p-perim/lightmetrica/src/liblightmetrica/assets.cpp
• /home/travis/build/hi2p-perim/lightmetrica/include/lightmetrica/assets.inl