Ignition Physics

API Reference

2.3.0
GetWorldFromEngine::Engine< PolicyT, FeaturesT > Class Template Reference

#include <GetEntities.hh>

Public Types

using ConstWorldPtrType = ConstWorldPtr< PolicyT, FeaturesT >
 
using WorldPtrType = WorldPtr< PolicyT, FeaturesT >
 
- Public Types inherited from Entity< PolicyT, FeaturesT >
using Features = FeaturesT
 
using Pimpl = typename detail::DeterminePlugin< Policy, Features >::type
 
using Policy = PolicyT
 

Public Member Functions

WorldPtrType GetWorld (std::size_t _index)
 Get a world that is being managed by this engine. More...
 
ConstWorldPtrType GetWorld (std::size_t _index) const
 
WorldPtrType GetWorld (const std::string &_name)
 Get a world that is being managed by this engine. More...
 
ConstWorldPtrType GetWorld (const std::string &_name) const
 
std::size_t GetWorldCount () const
 Get the number of worlds inside this engine. More...
 
- Public Member Functions inherited from Feature::Engine< PolicyT, FeaturesT >
virtual ~Engine ()=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

- 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< PolicyT > * Interface ()
 Get a pointer to the implementation of FeatureT. More...
 
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. 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 Typedef Documentation

◆ ConstWorldPtrType

using ConstWorldPtrType = ConstWorldPtr<PolicyT, FeaturesT>

◆ WorldPtrType

using WorldPtrType = WorldPtr<PolicyT, FeaturesT>

Member Function Documentation

◆ GetWorld() [1/4]

WorldPtrType GetWorld ( std::size_t  _index)

Get a world that is being managed by this engine.

Parameters
[in]_indexIndex of the world within this engine
Returns
A world reference. If _index is GetWorldCount() or higher, this will be a nullptr.

◆ GetWorld() [2/4]

ConstWorldPtrType GetWorld ( std::size_t  _index) const

◆ GetWorld() [3/4]

WorldPtrType GetWorld ( const std::string _name)

Get a world that is being managed by this engine.

Parameters
[in]_nameName of the world
Returns
A world reference. If a world named _name does not exist in this engine, this will be a nullptr.

◆ GetWorld() [4/4]

ConstWorldPtrType GetWorld ( const std::string _name) const

◆ GetWorldCount()

std::size_t GetWorldCount ( ) const

Get the number of worlds inside this engine.


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