Selection.h File Reference

#include "ps/Profiler2.h"
#include "simulation2/helpers/Player.h"
#include "simulation2/Simulation2.h"
#include "simulation2/system/Entity.h"
#include "simulation2/system/IComponent.h"
#include <vector>

Include dependency graph for Selection.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	EntitySelection::DefaultComponentFilter
	Finds all entities with a given component belonging to any given player. More...

Namespaces
namespace	EntitySelection

Functions
bool	CheckEntityInRect (CEntityHandle handle, const CCamera &camera, int sx0, int sy0, int sx1, int sy1, bool allowEditorSelectables)
	Returns true if the given entity is visible in the given screen area. More...
entity_id_t	EntitySelection::PickEntityAtPoint (CSimulation2 &simulation, const CCamera &camera, int screenX, int screenY, player_id_t player, bool allowEditorSelectables)
	Finds all selectable entities under the given screen coordinates. More...
std::vector< entity_id_t >	EntitySelection::PickEntitiesInRect (CSimulation2 &simulation, const CCamera &camera, int sx0, int sy0, int sx1, int sy1, player_id_t owner, bool allowEditorSelectables)
	Finds all selectable entities within the given screen coordinate rectangle, belonging to the given player. More...
std::vector< entity_id_t >	EntitySelection::PickNonGaiaEntitiesInRect (CSimulation2 &simulation, const CCamera &camera, int sx0, int sy0, int sx1, int sy1, bool allowEditorSelectables)
	Finds all selectable entities within the given screen coordinate rectangle, belonging to any given player (excluding Gaia). More...
template<typename Filter = DefaultComponentFilter>
std::vector< entity_id_t >	EntitySelection::GetEntitiesWithComponentInRect (CSimulation2 &simulation, int cid, const CCamera &camera, int sx0, int sy0, int sx1, int sy1)
std::vector< entity_id_t >	EntitySelection::PickSimilarEntities (CSimulation2 &simulation, const CCamera &camera, const std::string &templateName, player_id_t owner, bool includeOffScreen, bool matchRank, bool allowEditorSelectables, bool allowFoundations)
	Finds all entities with the given entity template name, belonging to the given player. More...

Function Documentation

CheckEntityInRect()

bool CheckEntityInRect	(	CEntityHandle	handle,
		const CCamera &	camera,
		int	sx0,
		int	sy0,
		int	sx1,
		int	sy1,
		bool	allowEditorSelectables
	)

Returns true if the given entity is visible in the given screen area.

If the entity is a decorative, the function will only return true if allowEditorSelectables.