A container for Drawable objects. More...

#include <DrawableContainer.h>

Inheritance diagram for ime::DrawableContainer< T >:

Public Types
template<typename... Args>
using	Callback = std::function< void(Args...)>
	For each callback. More...

using	Predicate = std::function< bool(const T *)>
	Predicate callback. More...

using	ObjectPtr = std::unique_ptr< T >
	Unique Object pointer. More...

Public Member Functions
	DrawableContainer (RenderLayerContainer &renderLayers)
	Constructor. More...

T *	add (std::unique_ptr< T > drawable, int renderOrder=0u, const std::string &renderLayer="default")
	Add a drawable object to the container. More...

T *	addObject (ObjectPtr object, const std::string &group="none")
	Add an object to the container. More...

T *	findByTag (const std::string &tag)
	Get an object with a given tag. More...

const T *	findByTag (const std::string &tag) const

template<typename U >
U *	findByTag (const std::string &tag)
	Get an object with a given tag. More...

template<typename U >
const U *	findByTag (const std::string &tag) const

T *	findById (unsigned int id)
	Get an object with the given id. More...

const T *	findById (unsigned int id) const

template<typename U >
U *	findById (unsigned int id)
	Get an object with the given id. More...

template<typename U >
const U *	findById (unsigned int id) const

T *	findIf (const Predicate &predicate)
	Conditionally find an object in the container. More...

const T *	findIf (const Predicate &predicate) const

void	removeByTag (const std::string &tag)
	Remove all objects with the given tag. More...

void	removeById (unsigned int id)
	Remove an object with the given id. More...

bool	remove (T *object)
	Remove an object from the container. More...

void	removeIf (const Predicate &predicate)
	Conditionally remove objects from the container. More...

void	removeAll ()
	Remove all objects from the container. More...

std::size_t	getCount () const
	Get the number of objects in the container. More...

ObjectContainer< T > &	createGroup (const std::string &name)
	Create a group to add objects to. More...

ObjectContainer< T > &	getGroup (const std::string &name) const
	Get a group in the container. More...

bool	hasGroup (const std::string &name) const
	Check whether or not the container has a given group. More...

bool	removeGroup (const std::string &name)
	Remove a group from the container. More...

void	removeAllGroups ()
	Remove all groups from the container. More...

void	forEach (const Callback< T * > &callback) const
	Apply a callback function to each object in the container. More...

void	forEachInGroup (const std::string &name, const Callback< T * > &callback) const
	Apply a callback to each object in a specific group. More...

void	forEachInGroups (const std::initializer_list< std::string > &groups, const Callback< T * > &callback) const
	Apply a callback to each object in specific groups. More...

void	forEachNotInGroup (const Callback< T * > &callback) const
	Apply a callback to all objects that do not belong to a group. More...

Detailed Description

template<typename T>
class ime::DrawableContainer< T >

A container for Drawable objects.

Definition at line 37 of file DrawableContainer.h.

Member Typedef Documentation

◆ Callback

template<typename T >

template<typename... Args>

using ime::ObjectContainer< T >::Callback = std::function<void(Args...)>

inherited

For each callback.

Definition at line 44 of file ObjectContainer.h.

◆ ObjectPtr

template<typename T >

using ime::ObjectContainer< T >::ObjectPtr = std::unique_ptr<T>

inherited

Unique Object pointer.

Definition at line 47 of file ObjectContainer.h.

◆ Predicate

template<typename T >

using ime::ObjectContainer< T >::Predicate = std::function<bool(const T*)>

inherited

Predicate callback.

Definition at line 46 of file ObjectContainer.h.

Constructor & Destructor Documentation

◆ DrawableContainer()

template<typename T >

ime::DrawableContainer< T >::DrawableContainer ( RenderLayerContainer & renderLayers )

explicit

Constructor.

Parameters

renderLayers The render layer container for

Member Function Documentation

◆ add()

template<typename T >

T * ime::DrawableContainer< T >::add	(	std::unique_ptr< T >	drawable,
		int	renderOrder = `0u`,
		const std::string &	renderLayer = `"default"`
	)

Add a drawable object to the container.

Parameters

drawable	The drawable object to be added
renderOrder	The render order of the object in the render layer
renderLayer	The RenderLayer the object belongs to

Returns: A pointer to the drawable in the container

If the render layer is unspecified or the specified layer cannot be found then the drawable will be added to the 'default' layer. The 'default' render layer is created by the Scene when you instantiate it. Note that the 'default' layer may be deleted from the scenes render layers, however you must make sure that the layer you specify during a call to this function already exists otherwise undefined behavior

◆ addObject()

template<typename T >

T * ime::ObjectContainer< T >::addObject	(	ObjectPtr	object,
		const std::string &	group = `"none"`
	)

inherited

Add an object to the container.

Parameters

object	The object to be added
group	The name of the group to add the object to

Returns: A pointer to the object after its added to the container

If the group is not found, it will be created and the object will be the first member of it. Groups are useful if you want to refer to objects that are the same or similar as a whole

By default the object does not belong to any group

See also: createGroup

◆ createGroup()

template<typename T >

ObjectContainer< T > & ime::ObjectContainer< T >::createGroup ( const std::string & name )

inherited

Create a group to add objects to.

Parameters

name	The name of the group

Returns: The created group

This function is useful if you want to relate some objects and refer to them as a whole using a common group name instead of using a common tag name and looping though the container to find which objects have a given tag. Note that the name of the group must be unique

auto weapons = objectContainer.createGroup("weapons");
weapons.addObject(knife);
weapons.addObject(machete);
weapons.addObject(bat);

See also: addObject

◆ findById() [1/2]

template<typename T >

T * ime::ObjectContainer< T >::findById ( unsigned int id )

inherited

Get an object with the given id.

Parameters

id	The id of the object to be retrieved

Returns: The object with the given id or a nullptr if the object could not be found in the container

◆ findById() [2/2]

template<typename T >

template<typename U >

U * ime::ObjectContainer< T >::findById ( unsigned int id )

inherited

Get an object with the given id.

Parameters

id	The id of the object to be retrieved

Returns: The object with the given id or a nullptr if the object could not be found in the container or the the object is found but it is not convertible to type U

You can use this function to get the derived class type U if T is a base class

// The type of rectangle is ime::Shape*
auto rectangle = shapeContainer.findById(4);
 
// The type of rectangle2 is ime::RectangleShape*
auto rectangle2 = shapeContainer.findById<ime::RectangleShape>(4);

◆ findByTag() [1/2]

template<typename T >

T * ime::ObjectContainer< T >::findByTag ( const std::string & tag )

inherited

Get an object with a given tag.

Parameters

tag	The tag of the object to be searched

Returns: The object with the given tag or a nullptr if the object could not be found in the container

Note that this function will return the first object it finds with the the given tag if the container has multiple objects with the same tag

◆ findByTag() [2/2]

template<typename T >

template<typename U >

U * ime::ObjectContainer< T >::findByTag ( const std::string & tag )

inherited

Get an object with a given tag.

Parameters

tag	The tag of the object to be searched

Returns: The object with the given tag or a nullptr if the object could not be found in the container or the the object is found but it is not convertible to type U

Note that this function will return the first object it finds with the the given tag if the container has multiple objects with the same tag. You can use this function to get the derived class type U if T is a base class:

// The type of rectangle is ime::Shape*
auto* rectangle = shapeContainer.findByTag("myRect");
 
// The type of rectangle2 is ime::RectangleShape*
auto* rectangle2 = shapeContainer.findByTag<ime::RectangleShape>("myRect");

◆ findIf()

template<typename T >

T * ime::ObjectContainer< T >::findIf ( const Predicate & predicate )

inherited

Conditionally find an object in the container.

Parameters

predicate A function which returns true if the object should be returned or false if the search should continue

Returns: The object that matches the found condition or a nullptr if an object that matches the success condition could not be found in the container

◆ forEach()

template<typename T >

void ime::ObjectContainer< T >::forEach ( const Callback< T * > & callback ) const

inherited

Apply a callback function to each object in the container.

Parameters

callback The function to be applied to each object

Note that the callback is applied to all objects, this includes those that are assigned to groups

See also: forEachInGroup and forEachNotInGroup

◆ forEachInGroup()

template<typename T >

void ime::ObjectContainer< T >::forEachInGroup	(	const std::string &	name,
		const Callback< T * > &	callback
	)		const

inherited

Apply a callback to each object in a specific group.

Parameters

name	The name of the group to apply callback on
callback	The function to be applied to each object in the group

This function is a shortcut for:

// It's undefined behaviour to call getGroup if the group does not exist
if (container.hasGroup(name)) {
    container.getGroup(name)->forEach(...);
}

See also: forEach and forEachNotInGroup

◆ forEachInGroups()

template<typename T >

void ime::ObjectContainer< T >::forEachInGroups	(	const std::initializer_list< std::string > &	groups,
		const Callback< T * > &	callback
	)		const

inherited

Apply a callback to each object in specific groups.

Parameters

groups	The name of the groups to apply the callback on
callback	The function to be applied to each object in the groups

For example, the following code deactivates all the game objects in the groups "bombs" and "guns":

gameObjects.forEachInGroups({"bombs", "guns"}, [](ime::GameObject* object) {
     object->setActive(false);
});

See also: forEach, forEachInGroup, ForEachNotInGroup

◆ forEachNotInGroup()

template<typename T >

void ime::ObjectContainer< T >::forEachNotInGroup ( const Callback< T * > & callback ) const

inherited

Apply a callback to all objects that do not belong to a group.

Parameters

callback The function to be applied to each object in the container that does not belong to any group

See also: forEach and forEachInGroup

◆ getCount()

template<typename T >

std::size_t ime::ObjectContainer< T >::getCount ( ) const

inherited

Get the number of objects in the container.

Returns: The number of objects in the container

◆ getGroup()

template<typename T >

ObjectContainer< T > & ime::ObjectContainer< T >::getGroup ( const std::string & name ) const

inherited

Get a group in the container.

Parameters

name	The name of the group

Returns: The requested group

Warning: The specified group must exist in the container before this function is called otherwise undefined behavior

See also: createGroup and hasGroup

◆ hasGroup()

template<typename T >

bool ime::ObjectContainer< T >::hasGroup ( const std::string & name ) const

inherited

Check whether or not the container has a given group.

Parameters

name	The name of the group to be checked

Returns: True if the container has the specified group, otherwise false

See also: createGroup

◆ remove()

template<typename T >

bool ime::ObjectContainer< T >::remove ( T * object )

inherited

Remove an object from the container.

Parameters

object The object to be removed

Returns: True if the object was removed or false if the object does not exist in the container

Warning: The argument must not be a nullptr

◆ removeAll()

template<typename T >

void ime::ObjectContainer< T >::removeAll ( )

inherited

Remove all objects from the container.

Warning: This function will invalidate any pointer(s) to the objects once they are removed from the container

◆ removeAllGroups()

template<typename T >

void ime::ObjectContainer< T >::removeAllGroups ( )

inherited

Remove all groups from the container.

This function will remove all objects that belong to a group from the container, leaving only objects that do not belong to a group if any. Note that pointers to the removed objects will be invalidated

See also: removeGroup

◆ removeById()

template<typename T >

void ime::ObjectContainer< T >::removeById ( unsigned int id )

inherited

Remove an object with the given id.

Parameters

id	The id of the object to be removed

Warning: This function will invalidate any pointer(s) to the object once it is removed from the container

◆ removeByTag()

template<typename T >

void ime::ObjectContainer< T >::removeByTag ( const std::string & tag )

inherited

Remove all objects with the given tag.

Parameters

tag	The tag of the objects to be removed

Warning: This function will invalidate any pointer(s) to the object once it is removed from the container

◆ removeGroup()

template<typename T >

bool ime::ObjectContainer< T >::removeGroup ( const std::string & name )

inherited

Remove a group from the container.

Parameters

name	The name of the group to be removed

Returns: True if the group was removed or false if the specified group does not exist in the container

Warning: This function will remove all objects in the given group from the container, therefore any pointers to the objects will be invalidated

See also: createGroup and removeAllGroups

◆ removeIf()

template<typename T >

void ime::ObjectContainer< T >::removeIf ( const Predicate & predicate )

inherited

Conditionally remove objects from the container.

Parameters

predicate A function which returns true if the object should be removed or false if it should not be removed from the container

Note that this function will remove all objects for which the predicate return true

Warning: This function will invalidate any pointer(s) to the object once it is removed from the container

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

DrawableContainer.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ Callback

◆ ObjectPtr

◆ Predicate

Constructor & Destructor Documentation

◆ DrawableContainer()

Member Function Documentation

◆ add()

◆ addObject()

◆ createGroup()

◆ findById() [1/2]

◆ findById() [2/2]

◆ findByTag() [1/2]

◆ findByTag() [2/2]

◆ findIf()

◆ forEach()

◆ forEachInGroup()

◆ forEachInGroups()

◆ forEachNotInGroup()

◆ getCount()

◆ getGroup()

◆ hasGroup()

◆ remove()

◆ removeAll()

◆ removeAllGroups()

◆ removeById()

◆ removeByTag()

◆ removeGroup()

◆ removeIf()