#include <tdme/utilities/FlowMap.h>

Inheritance diagram for FlowMap:

Collaboration diagram for FlowMap:

Public Member Functions
string	toId (float x, float z) const
	Return string representation of given x,z for flow map cell id. More...

float	alignPositionComponent (float value) const
	Align position component. More...

int	getIntegerPositionComponent (float value) const
	Returns integer position component. More...

	FlowMap (const vector< Vector3 > &path, const vector< Vector3 > &endPositions, float stepSize, bool complete=true)
	Constructor. More...

bool	isComplete () const

float	getStepSize () const

const vector< Vector3 > &	getEndPositions () const
	Returns end positions. More...

const vector< Vector3 > &	getPath () const
	Returns path flow map is generated on. More...

const FlowMapCell *	getCell (const string &id) const
	Get cell by id. More...

FlowMapCell *	getCell (const string &id)
	Get cell by id. More...

const FlowMapCell *	getCell (float x, float z) const
	Get cell by position. More...

FlowMapCell *	getCell (float x, float z)
	Get cell by position. More...

const Vector3	computeDirection (float x, float z) const
	Compute direction also taking neighbour cells into account. More...

const unordered_map< string, FlowMapCell > &	getCellMap () const
	Cell map getter. More...

void	removeCell (const string &id)
	Remove cell by id. More...

void	merge (const FlowMap *flowMap)
	Merge given flow map into this flow map, please note that given flow map step size needs to match this flow maps step size This only applies to a series of flow maps created sequentially and in correct order along a path. More...

FlowMapCell *	findNearestCell (float x, float z, int steps=8)
	Find nearest cell, which can be used if outside of flow map to find back in. More...

Public Member Functions inherited from Reference
	Reference ()
	Public constructor. More...

virtual	~Reference ()
	destructor More...

void	acquireReference ()
	acquires a reference, incrementing the counter More...

void	releaseReference ()
	releases a reference, thus decrementing the counter and delete it if reference counter is zero More...

virtual void	onDelete ()
	Callback method to be overridden, will be called if object will be deleted. More...

Static Public Member Functions
static string	toId (float x, float z, float stepSize)
	Return string representation of given x,z for flow map cell id. More...

static float	alignPositionComponent (float value, float stepSize)
	Align position component. More...

static int	getIntegerPositionComponent (float value, float stepSize)
	Returns integer position component. More...

static string	toIdInt (int x, int z)
	Return string representation of given x,z integer flow map position representation for flow map cell id. More...

Private Member Functions
	~FlowMap ()
	Private destructor. More...

void	setComplete (bool complete)
	Set flow map complete flag. More...

void	addCell (const string &id, const Vector3 &position, bool walkable, const Vector3 &direction, int pathIdx)
	Adds a cell to flow map. More...

bool	hasCell (const string &id) const
	Checks if a cell exists in flow map. More...

Private Attributes
bool	complete

float	stepSize

unordered_map< string, FlowMapCell >	cells

vector< Vector3 >	endPositions

vector< Vector3 >	path

Friends
class	PathFinding

Detailed Description

Flow map.

Author: Andreas Drewke

Version: $Id$

Definition at line 31 of file FlowMap.h.

Constructor & Destructor Documentation

◆ ~FlowMap()

~FlowMap ( )

inlineprivate

Private destructor.

Definition at line 43 of file FlowMap.h.

◆ FlowMap()

FlowMap	(	const vector< Vector3 > &	path,
		const vector< Vector3 > &	endPositions,
		float	stepSize,
		bool	complete = `true`
	)

inline

Constructor.

Parameters

path	path
endPositions	end positions
stepSize	step size

Definition at line 161 of file FlowMap.h.

Member Function Documentation

◆ addCell()

void addCell	(	const string &	id,
		const Vector3 &	position,
		bool	walkable,
		const Vector3 &	direction,
		int	pathIdx
	)

inlineprivate

Adds a cell to flow map.

Parameters

id	id
position	position
walkable	walkable
direction	direction
pathIdx	path index

Definition at line 62 of file FlowMap.h.

◆ alignPositionComponent() [1/2]

float alignPositionComponent ( float value ) const

inline

Align position component.

Parameters

value value which is usually a position vector 3 position component

Definition at line 117 of file FlowMap.h.

◆ alignPositionComponent() [2/2]

static float alignPositionComponent	(	float	value,
		float	stepSize
	)

inlinestatic

Align position component.

Parameters

value	value which is usually a position vector 3 position component
stepSize	step size

Definition at line 109 of file FlowMap.h.

◆ computeDirection()

const Vector3 computeDirection	(	float	x,
		float	z
	)		const

inline

Compute direction also taking neighbour cells into account.

Parameters

x	x
y	y
direction	direction

Definition at line 254 of file FlowMap.h.

◆ findNearestCell()

FlowMapCell * findNearestCell	(	float	x,
		float	z,
		int	steps = `8`
	)

inline

Find nearest cell, which can be used if outside of flow map to find back in.

Parameters

x	x
z	z
steps	steps

Definition at line 343 of file FlowMap.h.

◆ getCell() [1/4]

FlowMapCell * getCell ( const string & id )

inline

Get cell by id.

Parameters

id id

Returns: cell

Definition at line 210 of file FlowMap.h.

◆ getCell() [2/4]

const FlowMapCell * getCell ( const string & id ) const

inline

Get cell by id.

Parameters

id id

Returns: cell

Definition at line 199 of file FlowMap.h.

◆ getCell() [3/4]

FlowMapCell * getCell	(	float	x,
		float	z
	)

inline

Get cell by position.

Parameters

x	x
z	z

Returns: cell

Definition at line 238 of file FlowMap.h.

◆ getCell() [4/4]

const FlowMapCell * getCell	(	float	x,
		float	z
	)		const

inline

Get cell by position.

Parameters

x	x
z	z

Returns: cell

Definition at line 222 of file FlowMap.h.

◆ getCellMap()

const unordered_map< string, FlowMapCell > & getCellMap ( ) const

inline

Cell map getter.

Returns: cell map

Definition at line 276 of file FlowMap.h.

◆ getEndPositions()

const vector< Vector3 > & getEndPositions ( ) const

inline

Returns end positions.

Returns: end positions

Definition at line 182 of file FlowMap.h.

◆ getIntegerPositionComponent() [1/2]

int getIntegerPositionComponent ( float value ) const

inline

Returns integer position component.

Parameters

value value

Returns: integer position component

Definition at line 126 of file FlowMap.h.

◆ getIntegerPositionComponent() [2/2]

static int getIntegerPositionComponent	(	float	value,
		float	stepSize
	)

inlinestatic

Returns integer position component.

Parameters

value	value
stepSize	step size

Returns: integer position component

Definition at line 136 of file FlowMap.h.

◆ getPath()

const vector< Vector3 > & getPath ( ) const

inline

Returns path flow map is generated on.

Returns: path

Definition at line 190 of file FlowMap.h.

◆ getStepSize()

float getStepSize ( ) const

inline

Returns: step size

Definition at line 174 of file FlowMap.h.

◆ hasCell()

bool hasCell ( const string & id ) const

inlineprivate

Checks if a cell exists in flow map.

Parameters

id id

Definition at line 70 of file FlowMap.h.

◆ isComplete()

bool isComplete ( ) const

inline

Returns: if flow map is complete

Definition at line 167 of file FlowMap.h.

◆ merge()

void merge ( const FlowMap * flowMap )

inline

Merge given flow map into this flow map, please note that given flow map step size needs to match this flow maps step size This only applies to a series of flow maps created sequentially and in correct order along a path.

Parameters

flowMap flow map

Definition at line 295 of file FlowMap.h.

◆ removeCell()

void removeCell ( const string & id )

inline

Remove cell by id.

Parameters

id id

Definition at line 284 of file FlowMap.h.

◆ setComplete()

void setComplete ( bool complete )

inlineprivate

Set flow map complete flag.

Parameters

complete complete

Definition at line 50 of file FlowMap.h.

◆ toId() [1/2]

string toId	(	float	x,
		float	z
	)		const

inline

Return string representation of given x,z for flow map cell id.

Parameters

x	x
z	z

Returns: string representation

Definition at line 82 of file FlowMap.h.

◆ toId() [2/2]

static string toId	(	float	x,
		float	z,
		float	stepSize
	)

inlinestatic

Return string representation of given x,z for flow map cell id.

Parameters

x	x
z	z
stepSize	step size

Returns: string representation

Definition at line 93 of file FlowMap.h.

◆ toIdInt()

static string toIdInt	(	int	x,
		int	z
	)

inlinestatic

Return string representation of given x,z integer flow map position representation for flow map cell id.

Parameters

x	x
z	z

Returns: string representation

Definition at line 146 of file FlowMap.h.

Friends And Related Function Documentation

◆ PathFinding

friend class PathFinding

friend

Definition at line 32 of file FlowMap.h.

Member Data Documentation

◆ cells

unordered_map<string, FlowMapCell> cells

private

Definition at line 36 of file FlowMap.h.

◆ complete

bool complete

private

Definition at line 34 of file FlowMap.h.

◆ endPositions

vector<Vector3> endPositions

private

Definition at line 37 of file FlowMap.h.

◆ path

vector<Vector3> path

private

Definition at line 38 of file FlowMap.h.

◆ stepSize

float stepSize

private

Definition at line 35 of file FlowMap.h.

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

/home/andreas/Development/drewke.net/tdme2/src/tdme/utilities/FlowMap.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~FlowMap()

◆ FlowMap()

Member Function Documentation

◆ addCell()

◆ alignPositionComponent() [1/2]

◆ alignPositionComponent() [2/2]

◆ computeDirection()

◆ findNearestCell()

◆ getCell() [1/4]

◆ getCell() [2/4]

◆ getCell() [3/4]

◆ getCell() [4/4]

◆ getCellMap()

◆ getEndPositions()

◆ getIntegerPositionComponent() [1/2]

◆ getIntegerPositionComponent() [2/2]

◆ getPath()

◆ getStepSize()

◆ hasCell()

◆ isComplete()

◆ merge()

◆ removeCell()

◆ setComplete()

◆ toId() [1/2]

◆ toId() [2/2]

◆ toIdInt()

Friends And Related Function Documentation

◆ PathFinding

Member Data Documentation

◆ cells

◆ complete

◆ endPositions

◆ path

◆ stepSize