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< AtmosphereNewAtmosphere (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

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

Check if an atmosphere model is registered.

Parameters
[in]_nameName of the atmosphere model.
Returns
True if atmosphere model is registered, false otherwise.
static std::unique_ptr<Atmosphere> NewAtmosphere ( const std::string &  _className,
World _world 
)
static

Create a new instance of an atmosphere model.

Parameters
[in]_classNameName of the atmosphere class.
[in]_worldWorld to pass to the created atmosphere model.
Returns
Unique pointer to the atmosphere model.
static void RegisterAll ( )
static

Register everything.

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

Register an atmosphere class.

Parameters
[in]_classNameName of the atmosphere class.
[in]_factoryfnFunction pointer used to create an atmosphere model.

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