Solver::World< PolicyT, FeaturesT > Class Template Reference
The World API for setting the solver. More...
#include <World.hh>
Public Member Functions | |
| const std::string & | GetSolver () const |
| Get the name of the solver in use. | |
| std::size_t | GetSolverIterations () const |
| Get the number of solver iterations per step. | |
| void | SetSolver (const std::string &_solver) |
| Set the name of the solver to use. | |
| void | SetSolverIterations (std::size_t _iterations) |
| Set the number of solver iterations per step. | |
 Public Member Functions inherited from Feature::World< PolicyT, FeaturesT > | |
| virtual | ~World ()=default |
| Virtual destructor. | |
| Public Member Functions inherited from Entity< PolicyT, FeaturesT > | |
| virtual | ~Entity ()=default |
| Virtual destructor. | |
| std::size_t | EntityID () const |
| Get the unique ID value of this Entity. | |
| const std::shared_ptr< void > & | EntityReference () const |
| Get a reference-counting std::shared_ptr to the object inside the implementation that this object provides an abstraction for. | |
| const Identity & | FullIdentity () const |
| Get the Identity object of this Entity. | |
Additional Inherited Members | |
| Public Types inherited from Entity< PolicyT, FeaturesT > | |
| using | Features = FeaturesT |
| using | Pimpl = typename detail::DeterminePlugin< Policy, Features >::type |
| using | Policy = PolicyT |
| Protected Member Functions inherited from Entity< PolicyT, FeaturesT > | |
| Entity (const std::shared_ptr< Pimpl > &_pimpl=nullptr, const Identity &_identity=Identity()) | |
| Constructor for the Entity. | |
| Entity (std::shared_ptr< Pimpl > &&_pimpl, const Identity &_identity) | |
| Constructor that allows the pimpl to be moved instead of copied. | |
| template<typename FeatureT > | |
| FeatureT::template Implementation< PolicyT > * | Interface () |
| Get a pointer to the implementation of FeatureT. | |
| template<typename FeatureT > | |
| const FeatureT::template Implementation< PolicyT > * | Interface () const |
| Same as Interface(), but const-qualified so that const entities can request const-qualified interfaces from the implementation. | |
| Protected Attributes inherited from Entity< PolicyT, FeaturesT > | |
| Identity | identity |
| This field contains information to identify the entity. | |
| std::shared_ptr< Pimpl > | pimpl |
| This is a pointer to the physics engine implementation, and it can be used by the object features to find the interfaces that they need in order to function. | |
Detailed Description
template<typename PolicyT, typename FeaturesT>
class gz::physics::Solver::World< PolicyT, FeaturesT >
class gz::physics::Solver::World< PolicyT, FeaturesT >
The World API for setting the solver.
Member Function Documentation
◆ GetSolver()
template<typename PolicyT , typename FeaturesT >
| const std::string & GetSolver | ( | ) | const |
Get the name of the solver in use.
- Returns
- Name of solver.
◆ GetSolverIterations()
template<typename PolicyT , typename FeaturesT >
| std::size_t GetSolverIterations | ( | ) | const |
Get the number of solver iterations per step.
- Returns
- Number of solver iterations per step.
◆ SetSolver()
template<typename PolicyT , typename FeaturesT >
| void SetSolver | ( | const std::string & | _solver | ) |
Set the name of the solver to use.
- Parameters
-
[in] _solver Name of solver.
◆ SetSolverIterations()
template<typename PolicyT , typename FeaturesT >
| void SetSolverIterations | ( | std::size_t | _iterations | ) |
Set the number of solver iterations per step.
- Parameters
-
[in] _iterations Number of solver iterations per step
The documentation for this class was generated from the following file: