castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits > Class Reference

Overlay collection, with additional add and remove functions to manage Z-Index. More...

#include <OverlayCache.hpp>

Inheritance diagram for castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >:

Collaboration diagram for castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >:

Public Types
using	ElementT = castor3d::Overlay
using	ElementKeyT = String
using	ElementCacheTraitsT = castor3d::OverlayCacheTraits
using	ElementCacheT = ResourceCacheBaseT< ElementT, ElementKeyT, ElementCacheTraitsT >
using	ElementPtrT = typename ElementCacheT::ElementPtrT
using	ElementObsT = typename ElementCacheT::ElementObsT
using	ElementContT = typename ElementCacheT::ElementContT
using	ElementInitialiserT = typename ElementCacheT::ElementInitialiserT
using	ElementCleanerT = typename ElementCacheT::ElementCleanerT
using	ElementMergerT = typename ElementCacheT::ElementMergerT
using	iterator = std::map< ElementT, ElementKeyT >::iterator
using	const_iterator = std::map< ElementT, ElementKeyT >::const_iterator

Public Member Functions
	CU_DeclareMap (ElementKeyT, castor3d::FontTextureSPtr, FontTextureStr)
C3D_API	ResourceCacheT (castor3d::Engine &engine)
	Constructor. More...
C3D_API	~ResourceCacheT ()=default
	Destructor. More...
C3D_API void	clear ()
	Clears all overlays lists. More...
C3D_API void	cleanup ()
	Cleans all overlays up. More...
C3D_API void	initialise (castor3d::Overlay &overlay)
C3D_API void	cleanup (castor3d::Overlay &overlay)
C3D_API castor3d::FontTextureSPtr	getFontTexture (String const &name)
	Retrieves a FontTexture given a font name. More...
C3D_API castor3d::FontTextureSPtr	createFontTexture (castor::FontResPtr font)
	Creates a FontTexture from a font. More...
Iteration.
auto	begin ()
auto	begin () const
auto	end ()
auto	end () const
Getters.
castor3d::OverlayFactory const &	getOverlayFactory () const
castor3d::OverlayFactory &	getFactory ()
castor3d::Engine &	getEngine () const

Detailed Description

Overlay collection, with additional add and remove functions to manage Z-Index.

Member Typedef Documentation

const_iterator

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::const_iterator = std::map< ElementT, ElementKeyT >::const_iterator

ElementCacheT

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ElementCacheT = ResourceCacheBaseT< ElementT, ElementKeyT, ElementCacheTraitsT >

ElementCacheTraitsT

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ElementCacheTraitsT = castor3d::OverlayCacheTraits

ElementCleanerT

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ElementCleanerT = typename ElementCacheT::ElementCleanerT

ElementContT

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ElementContT = typename ElementCacheT::ElementContT

ElementInitialiserT

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ElementInitialiserT = typename ElementCacheT::ElementInitialiserT

ElementKeyT

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ElementKeyT = String

ElementMergerT

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ElementMergerT = typename ElementCacheT::ElementMergerT

ElementObsT

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ElementObsT = typename ElementCacheT::ElementObsT

ElementPtrT

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ElementPtrT = typename ElementCacheT::ElementPtrT

ElementT

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ElementT = castor3d::Overlay

iterator

using castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::iterator = std::map< ElementT, ElementKeyT >::iterator

Constructor & Destructor Documentation

ResourceCacheT()

C3D_API castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::ResourceCacheT

(

castor3d::Engine &

engine

)

Constructor.

Parameters

[in]

engine

The engine.

~ResourceCacheT()

C3D_API castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::~ResourceCacheT ( )

default

Destructor.

Member Function Documentation

begin() [1/2]

auto castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::begin ( )

inline

begin() [2/2]

auto castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::begin ( ) const

inline

cleanup() [1/2]

C3D_API void castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::cleanup

(

)

Cleans all overlays up.

cleanup() [2/2]

C3D_API void castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::cleanup

(

castor3d::Overlay &

overlay

)

clear()

C3D_API void castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::clear

(

)

Clears all overlays lists.

createFontTexture()

C3D_API castor3d::FontTextureSPtr castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::createFontTexture

(

castor::FontResPtr

font

)

Creates a FontTexture from a font.

Parameters

[in]

font

The font.

Returns

The created FontTexture.

CU_DeclareMap()

castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::CU_DeclareMap	(	ElementKeyT	,
		castor3d::FontTextureSPtr	,
		FontTextureStr
	)

end() [1/2]

auto castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::end ( )

inline

end() [2/2]

auto castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::end ( ) const

inline

getEngine()

castor3d::Engine & castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::getEngine ( ) const

inline

getFactory()

castor3d::OverlayFactory & castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::getFactory ( )

inline

getFontTexture()

C3D_API castor3d::FontTextureSPtr castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::getFontTexture

(

String const &

name

)

Retrieves a FontTexture given a font name.

Parameters

[in]

name

The font name.

Returns

The FontTexture if it exist, nullptr if not.

getOverlayFactory()

castor3d::OverlayFactory const & castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::getOverlayFactory ( ) const

inline

initialise()

C3D_API void castor::ResourceCacheT< castor3d::Overlay, String, castor3d::OverlayCacheTraits >::initialise

(

castor3d::Overlay &

overlay

)

---

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

• Cache/OverlayCache.hpp