CSMWorld::CellSelection Class Reference

Selection of cells in a paged worldspace. More...

#include <cellselection.hpp>

Collaboration diagram for CSMWorld::CellSelection:

Public Types
typedef std::set< CellCoordinates >	Container
typedef Container::const_iterator	Iterator

Public Member Functions
Iterator	begin () const
Iterator	end () const
bool	add (const CellCoordinates &coordinates)
void	remove (const CellCoordinates &coordinates)
	ignored if the cell specified by coordinates is not part of the selection. More...
bool	has (const CellCoordinates &coordinates) const
int	getSize () const
	Return number of cells. More...
CellCoordinates	getCentre () const
void	move (int x, int y)

Private Attributes
Container	mCells

Detailed Description

Selection of cells in a paged worldspace.

Note

The CellSelection does not specify the worldspace it applies to.

Member Typedef Documentation

typedef std::set<CellCoordinates> CSMWorld::CellSelection::Container

typedef Container::const_iterator CSMWorld::CellSelection::Iterator

Member Function Documentation

bool CSMWorld::CellSelection::add

(

const CellCoordinates &

coordinates

)

Ignored if the cell specified by coordinates is already part of the selection.

Returns

Was a cell added to the collection?

Here is the caller graph for this function:

CSMWorld::CellSelection::Iterator CSMWorld::CellSelection::begin

(

)

const

Here is the caller graph for this function:

CSMWorld::CellSelection::Iterator CSMWorld::CellSelection::end

(

)

const

Here is the caller graph for this function:

CSMWorld::CellCoordinates CSMWorld::CellSelection::getCentre

(

)

const

Return the selected cell that is closest to the geometric centre of the selection.

Attention

This function must not be called on selections that are empty.

Here is the call graph for this function:

Here is the caller graph for this function:

int CSMWorld::CellSelection::getSize

(

)

const

Return number of cells.

Here is the caller graph for this function:

bool CSMWorld::CellSelection::has

(

const CellCoordinates &

coordinates

)

const

Returns

Is the cell specified by coordinates part of the selection?

Here is the caller graph for this function:

void CSMWorld::CellSelection::move	(	int	x,
		int	y
	)

Here is the caller graph for this function:

void CSMWorld::CellSelection::remove

(

const CellCoordinates &

coordinates

)

ignored if the cell specified by coordinates is not part of the selection.

Member Data Documentation

Container CSMWorld::CellSelection::mCells

private

---

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

• /home/travis/build/elsid/openmw/apps/opencs/model/world/cellselection.hpp
• /home/travis/build/elsid/openmw/apps/opencs/model/world/cellselection.cpp