SpecializedSpriteGroup< T > Struct Template Reference

Class defining some overloaded accessors so we don't have to cast SpriteGroups that often. More...

#include <newgrf_spritegroup.h>

Inheritance diagram for SpecializedSpriteGroup< T >:

Public Member Functions
	SpecializedSpriteGroup (SpriteGroupID index)
Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_spritegroup_pool >
	PoolItem (Tindex index)
	Construct the item.
void *	operator new (size_t)=delete
	Do not use new PoolItem, but rather PoolItem::Create.
void *	operator new (size_t size, Tindex index)=delete
	Do not use new (index) PoolItem(...), but rather PoolItem::CreateAtIndex(index, ...).
void *	operator new (size_t, void *ptr)=delete
	Do not use new (address) PoolItem(...).
void	operator delete (void *p, size_t size)
	Marks Titem as free.

Static Public Member Functions
template<typename... Targs>
static T *	Create (Targs &&... args)
	Creates a new T-object in the SpriteGroup pool.
Static Public Member Functions inherited from SpriteGroup
static ResolverResult	Resolve (const SpriteGroup *group, ResolverObject &object, bool top_level=true)
	ResolverObject (re)entry point.
Static Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_spritegroup_pool >
static T *	Create (Targs &&... args)
	Creates a new T-object in the associated pool.
static T *	CreateAtIndex (Tindex index, Targs &&... args)
	Creates a new T-object in the associated pool.
static bool	CanAllocateItem (size_t n=1)
	Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
static bool	CleaningPool ()
	Returns current state of pool cleaning - yes or no.
static bool	IsValidID (auto index)
	Tests whether given index can be used to get valid (non-nullptr) Titem.
static Titem *	Get (auto index)
	Returns Titem with given index.
static Titem *	GetIfValid (auto index)
	Returns Titem with given index.
static size_t	GetPoolSize ()
	Returns first unused index.
static size_t	GetNumItems ()
	Returns number of valid items in the pool.
static void	PostDestructor (size_t index)
	Dummy function called after destructor of each member.
static Pool::IterateWrapper< Titem >	Iterate (size_t from=0)
	Returns an iterable ensemble of all valid Titem.

Additional Inherited Members
Public Types inherited from Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_spritegroup_pool >
typedef struct Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >	Pool
	Type of the pool this item is going to be part of.
Data Fields inherited from SpriteGroup
uint32_t	nfo_line = 0
Data Fields inherited from Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_spritegroup_pool >
const Tindex	index
	Index of this pool item.
Protected Member Functions inherited from SpriteGroup
	SpriteGroup (SpriteGroupID index)
virtual ResolverResult	Resolve (ResolverObject &object) const =0
	Base sprite group resolver.

Detailed Description

template<class T>
struct SpecializedSpriteGroup< T >

Class defining some overloaded accessors so we don't have to cast SpriteGroups that often.

Definition at line 66 of file newgrf_spritegroup.h.

Constructor & Destructor Documentation

SpecializedSpriteGroup()

template<class T >

SpecializedSpriteGroup< T >::SpecializedSpriteGroup ( SpriteGroupID  index )

inline

Definition at line 67 of file newgrf_spritegroup.h.

Member Function Documentation

Create()

template<class T >

template<typename... Targs>

static T * SpecializedSpriteGroup< T >::Create ( Targs &&...  args )

inlinestatic

Creates a new T-object in the SpriteGroup pool.

Parameters

args...

The arguments to the constructor.

Returns

The created object.

Definition at line 75 of file newgrf_spritegroup.h.

---

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

• src/newgrf_spritegroup.h