AtmosphereFactory Class Reference

The atmosphere factory instantiates different atmosphere models. More...

#include <physics/physics.hh>

Static Public Member Functions
static bool	IsRegistered (const std::string &_name)
	Check if an atmosphere model is registered. More...
static std::unique_ptr< Atmosphere >	NewAtmosphere (const std::string &_className, World &_world)
	Create a new instance of an atmosphere model. More...
static void	RegisterAll ()
	Register everything. More...
static void	RegisterAtmosphere (const std::string &_className, AtmosphereFactoryFn _factoryfn)
	Register an atmosphere class. More...

Detailed Description

The atmosphere factory instantiates different atmosphere models.

Member Function Documentation

IsRegistered()

static bool IsRegistered ( const std::string &  _name )

static

Check if an atmosphere model is registered.

Parameters

[in]

_name

Name of the atmosphere model.

Returns

True if atmosphere model is registered, false otherwise.

NewAtmosphere()

static std::unique_ptr<Atmosphere> NewAtmosphere ( const std::string &  _className, World &  _world  )

static

Create a new instance of an atmosphere model.

Parameters

[in]	_className	Name of the atmosphere class.
[in]	_world	World to pass to the created atmosphere model.

Returns

Unique pointer to the atmosphere model.

RegisterAll()

static void RegisterAll ( )

static

Register everything.

RegisterAtmosphere()

static void RegisterAtmosphere ( const std::string &  _className, AtmosphereFactoryFn  _factoryfn  )

static

Register an atmosphere class.

Parameters

[in]	_className	Name of the atmosphere class.
[in]	_factoryfn	Function pointer used to create an atmosphere model.

---

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

• AtmosphereFactory.hh