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 (const std::string &_name) |
| Get a world that is being managed by this engine. | |
| ConstWorldPtrType | GetWorld (const std::string &_name) const |
| WorldPtrType | GetWorld (std::size_t _index) |
| Get a world that is being managed by this engine. | |
| ConstWorldPtrType | GetWorld (std::size_t _index) const |
| std::size_t | GetWorldCount () const |
| Get the number of worlds inside this engine. | |
| Public Member Functions inherited from Feature::Engine< PolicyT, FeaturesT > | |
| virtual | ~Engine ()=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 | |
| 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. | |
Member Typedef Documentation
◆ ConstWorldPtrType
template<typename PolicyT , typename FeaturesT >
| using ConstWorldPtrType = ConstWorldPtr<PolicyT, FeaturesT> |
◆ WorldPtrType
template<typename PolicyT , typename FeaturesT >
| using WorldPtrType = WorldPtr<PolicyT, FeaturesT> |
Member Function Documentation
◆ GetWorld() [1/4]
template<typename PolicyT , typename FeaturesT >
| WorldPtrType GetWorld | ( | const std::string & | _name | ) |
Get a world that is being managed by this engine.
- Parameters
-
[in] _name Name of the world
- Returns
- A world reference. If a world named _name does not exist in this engine, this will be a nullptr.
◆ GetWorld() [2/4]
template<typename PolicyT , typename FeaturesT >
| ConstWorldPtrType GetWorld | ( | const std::string & | _name | ) | const |
- See also
- GetWorld(const std::string &)
◆ GetWorld() [3/4]
template<typename PolicyT , typename FeaturesT >
| WorldPtrType GetWorld | ( | std::size_t | _index | ) |
Get a world that is being managed by this engine.
- Parameters
-
[in] _index Index of the world within this engine
- Returns
- A world reference. If _index is GetWorldCount() or higher, this will be a nullptr.
◆ GetWorld() [4/4]
template<typename PolicyT , typename FeaturesT >
| ConstWorldPtrType GetWorld | ( | std::size_t | _index | ) | const |
- See also
- GetWorld(std::size_t)
◆ GetWorldCount()
template<typename PolicyT , typename FeaturesT >
| std::size_t GetWorldCount | ( | ) | const |
Get the number of worlds inside this engine.
The documentation for this class was generated from the following file: