GetNestedModelFromModel::Model< PolicyT, FeaturesT > Class Template Reference
#include <GetEntities.hh>
Public Types | |
| using | ConstModelPtrType = ConstModelPtr< PolicyT, FeaturesT > |
| using | ModelPtrType = ModelPtr< 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 | |
| ModelPtrType | GetNestedModel (const std::string &_name) |
| Get a nested Model that exists within this Model. | |
| ConstModelPtrType | GetNestedModel (const std::string &_name) const |
| ModelPtrType | GetNestedModel (std::size_t _index) |
| Get a nested Model that exists within this Model. | |
| ConstModelPtrType | GetNestedModel (std::size_t _index) const |
| std::size_t | GetNestedModelCount () const |
| Get the number of nested Models inside this Model. | |
| Public Member Functions inherited from Feature::Model< PolicyT, FeaturesT > | |
| virtual | ~Model ()=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
◆ ConstModelPtrType
template<typename PolicyT , typename FeaturesT >
| using ConstModelPtrType = ConstModelPtr<PolicyT, FeaturesT> |
◆ ModelPtrType
template<typename PolicyT , typename FeaturesT >
| using ModelPtrType = ModelPtr<PolicyT, FeaturesT> |
Member Function Documentation
◆ GetNestedModel() [1/4]
template<typename PolicyT , typename FeaturesT >
| ModelPtrType GetNestedModel | ( | const std::string & | _name | ) |
◆ GetNestedModel() [2/4]
template<typename PolicyT , typename FeaturesT >
| ConstModelPtrType GetNestedModel | ( | const std::string & | _name | ) | const |
◆ GetNestedModel() [3/4]
template<typename PolicyT , typename FeaturesT >
| ModelPtrType GetNestedModel | ( | std::size_t | _index | ) |
Get a nested Model that exists within this Model.
- Parameters
-
[in] _index Index of the model within this model.
- Returns
- A model reference. If _index is GetNestedModelCount() or higher, this will be a nullptr.
◆ GetNestedModel() [4/4]
template<typename PolicyT , typename FeaturesT >
| ConstModelPtrType GetNestedModel | ( | std::size_t | _index | ) | const |
- See also
- GetNestedModel(std::size_t)
◆ GetNestedModelCount()
template<typename PolicyT , typename FeaturesT >
| std::size_t GetNestedModelCount | ( | ) | const |
Get the number of nested Models inside this Model.
The documentation for this class was generated from the following file: