Ignition Physics

API Reference

2.0.0
RemoveModelFromWorld::World< PolicyT, FeaturesT > Class Template Reference

#include <RemoveEntities.hh>

Public Member Functions

bool RemoveModel (std::size_t _index)
 Remove a Model that exists within this World. More...
 
bool RemoveModel (const std::string &_name)
 Remove a Model that exists within this World. More...
 
- Public Member Functions inherited from Feature::World< PolicyT, FeaturesT >
virtual ~World ()=default
 Virtual destructor. More...
 
- Public Member Functions inherited from Entity< PolicyT, FeaturesT >
virtual ~Entity ()=default
 Virtual destructor. More...
 
std::size_t EntityID () const
 Get the unique ID value of this Entity. More...
 
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. More...
 
const Identity & FullIdentity () const
 Get the Identity object of this Entity. More...
 

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. More...
 
 Entity (std::shared_ptr< Pimpl > &&_pimpl, const Identity &_identity)
 Constructor that allows the pimpl to be moved instead of copied. More...
 
template<typename FeatureT >
FeatureT::template Implementation< Policy > * Interface ()
 Get a pointer to the implementation of FeatureT. More...
 
template<typename F >
const F::template Implementation< Policy > * Interface () const
 Same as Interface(), but const-qualified so that const entities can request const-qualified interfaces from the implementation. More...
 
- Protected Attributes inherited from Entity< PolicyT, FeaturesT >
Identity identity
 This field contains information to identify the entity. More...
 
std::shared_ptr< Pimplpimpl
 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. More...
 

Member Function Documentation

◆ RemoveModel() [1/2]

bool RemoveModel ( std::size_t  _index)

Remove a Model that exists within this World.

Parameters
[in]_indexIndex of the model within this world.
Returns
True if the model was found and removed.

◆ RemoveModel() [2/2]

bool RemoveModel ( const std::string _name)

Remove a Model that exists within this World.

Parameters
[in]_nameName of the model within this world.
Returns
True if the model was found and removed.

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