Sites class. More...

#include <sites.h>

Public Member Functions
	sites (entity_system::entity_system &system)
	Constructor. More...

std::string	name (entity_system::entity site) const
	Name getter. More...

point	dimensions (entity_system::entity site) const
	Dimensions getter. More...

std::pair< std::vector < std::string > ::const_iterator, std::vector < std::string > ::const_iterator >	names () const
	Name iterator getter. More...

std::pair< std::vector< point > ::const_iterator, std::vector < point >::const_iterator >	dimensions () const
	Dimensions iterator getter. More...

void	name (entity_system::entity site, std::string name)
	Name setter. More...

void	dimensions (entity_system::entity site, point dimensions)
	Dimensions setter. More...

Detailed Description

This class describes the properties of sites initialized by the floorplan module.

Constructor & Destructor Documentation

ophidian::floorplan::sites::sites ( entity_system::entity_system & system )

Sites object constructor. Register the sites properties to the sites system.

Parameters

system Sites entity system.

point ophidian::floorplan::sites::dimensions ( entity_system::entity site ) const

inline

Returns the dimensions of a site.

Parameters

site	Site entity to get the dimensions.

std::pair< std::vector<point>::const_iterator, std::vector<point>::const_iterator > ophidian::floorplan::sites::dimensions ( ) const

inline

Returns the begin and end iterator of the site dimensions property.

Returns: Pair with constant iterators pointing the the beginning and end of the dimensions property.

void ophidian::floorplan::sites::dimensions	(	entity_system::entity	site,
		sites::point	dimensions
	)

Sets the dimensions of a site.

Parameters

site	Site entity to set the dimensions.
name	Desired dimensions to set.

std::string ophidian::floorplan::sites::name ( entity_system::entity site ) const

inline

Returns the name of a site.

Parameters

site	Site entity to get the name.

void ophidian::floorplan::sites::name	(	entity_system::entity	site,
		std::string	name
	)

Sets the name of a site.

Parameters

site	Site entity to set the name.
name	Desired name to set.

std::pair< std::vector<std::string>::const_iterator, std::vector<std::string>::const_iterator > ophidian::floorplan::sites::names ( ) const

inline

Returns the begin and end iterator of the site names property.

Returns: Pair with constant iterators pointing the the beginning and end of the names property.

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