SetShapeFrictionPyramidSlipCompliance::Shape< PolicyT, FeaturesT > Class Template Reference
#include <Shape.hh>
Public Types | |
| using | Scalar = typename PolicyT::Scalar |
 Public Types inherited from Entity< PolicyT, FeaturesT > | |
| using | Features = FeaturesT |
| using | Pimpl = typename detail::DeterminePlugin< Policy, Features >::type |
| using | Policy = PolicyT |
Public Member Functions | |
| bool | SetPrimarySlipCompliance (Scalar _value) |
| Set the slip compliance for the first friction direction of a friction pyramid model. | |
| bool | SetSecondarySlipCompliance (Scalar _value) |
| Set the slip compliance for the second friction direction of a friction pyramid model. | |
| Public Member Functions inherited from Feature::Shape< PolicyT, FeaturesT > | |
| virtual | ~Shape ()=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
◆ Scalar
template<typename PolicyT , typename FeaturesT >
| using Scalar = typename PolicyT::Scalar |
Member Function Documentation
◆ SetPrimarySlipCompliance()
template<typename PolicyT , typename FeaturesT >
| bool SetPrimarySlipCompliance | ( | Scalar | _value | ) |
Set the slip compliance for the first friction direction of a friction pyramid model.
- Parameters
-
[in] _value The value to set the slip compliance to.
- Returns
- True if the parameter was set successfully, false otherwise.
◆ SetSecondarySlipCompliance()
template<typename PolicyT , typename FeaturesT >
| bool SetSecondarySlipCompliance | ( | Scalar | _value | ) |
Set the slip compliance for the second friction direction of a friction pyramid model.
- Parameters
-
[in] _value The value to set the slip compliance to.
- Returns
- True if the parameter was set successfully, false otherwise.
The documentation for this class was generated from the following file: