Population Class Reference

Class that automatically populates an environment with multiple objects based on several parameters to define the number of objects, shape of the object distribution or type of distribution. More...

#include <physics/physics.hh>

Public Member Functions

 Population (sdf::ElementPtr _sdf, boost::shared_ptr< World > _world)
 Constructor. More...
 
virtual ~Population ()
 Destructor. More...
 
bool PopulateAll ()
 Generate and spawn multiple populations into the world. More...
 

Detailed Description

Class that automatically populates an environment with multiple objects based on several parameters to define the number of objects, shape of the object distribution or type of distribution.

Constructor & Destructor Documentation

Population ( sdf::ElementPtr  _sdf,
boost::shared_ptr< World _world 
)

Constructor.

Load an sdf file containing a population element.

Parameters
[in]_sdfSDF parameters.
[in]_worldPointer to the world.
virtual ~Population ( )
virtual

Destructor.

Member Function Documentation

bool PopulateAll ( )

Generate and spawn multiple populations into the world.

Returns
True when the populations were successfully spawned or false otherwise.

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