Atoms::HeightFields Class Reference

Container for all agent types. More...

#include <HeightFields.h>

Public Member Functions
	HeightFields ()
	Private constructor.
	HeightFields (const HeightFields &)
	Private copy constructor.
	~HeightFields ()
	Private destructor.
HeightFields &	operator= (const HeightFields &)
	Private assign operator.
AtomsPtr< HeightField >	heightField (const std::string &name)
	Gets an hf. More...
AtomsWPtr< HeightField >	heightFieldWPtr (const std::string &name)
HeightField *	heightFieldPtr (const std::string &name)
bool	hasHeightField (const std::string &name)
	Checks if an height field with the given name exists.
void	addHeightField (const std::string &name, AtomsPtr< HeightField > &field, bool replace=false, bool animated=false, short gridMode=0)
	Adds an hf to the map. More...
void	insertHeightField (const std::string &name, AtomsPtr< HeightField > &field, bool replace=false, bool animated=false)
	Adds an hf to the map.
void	removeHeightField (const std::string &name)
	Removes an hf from the map. More...
std::vector< std::string >	heightFieldNames ()
	Gets all hf names. More...
bool	heightFieldExists (const std::string &name)
	Checks if a hf exists. More...
void	setAnimated (const std::string &name, bool value)
	Sets the hf animated flag. More...
bool	isAnimated (const std::string &name)
	Checks if an hf is animated. More...
unsigned int	numHeightFields ()
	Gets the number of hf.
void	clear ()
	Removes all hf.

Static Public Member Functions
static HeightFields &	instance ()
	Singleton access.

Detailed Description

Container for all agent types.

Member Function Documentation

addHeightField()

void Atoms::HeightFields::addHeightField	(	const std::string &	name,
		AtomsPtr< HeightField > &	field,
		bool	replace = false,
		bool	animated = false,
		short	gridMode = 0
	)

Adds an hf to the map.

Parameters

name	hf name
heightField	mesh

heightField()

AtomsPtr<HeightField> Atoms::HeightFields::heightField

(

const std::string &

name

)

Gets an hf.

Parameters

name

hf name

Returns

Pointer to the hf

heightFieldExists()

bool Atoms::HeightFields::heightFieldExists

(

const std::string &

name

)

Checks if a hf exists.

Parameters

name

Hf name

Returns

Return true if the hf exists

heightFieldNames()

std::vector<std::string> Atoms::HeightFields::heightFieldNames

(

)

Gets all hf names.

Returns

List of all hf

isAnimated()

bool Atoms::HeightFields::isAnimated

(

const std::string &

name

)

Checks if an hf is animated.

Parameters

name

Hf name

Returns

Return true if the hf exists

removeHeightField()

void Atoms::HeightFields::removeHeightField

(

const std::string &

name

)

Removes an hf from the map.

Parameters

name

hf name

setAnimated()

void Atoms::HeightFields::setAnimated	(	const std::string &	name,
		bool	value
	)

Sets the hf animated flag.

Parameters

name	Hf name
value	Hf animated flag

---

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

• C:/projects/AtomsVFX/Atoms/Public/Atoms/HeightFields.h