SetContactPropertiesCallbackFeature::World< PolicyT, FeaturesT > Class Template Reference
#include <ContactProperties.hh>
Public Types | |
using | ShapePtrType = typename GetContactsFromLastStepFeature ::World< PolicyT, FeaturesT >::ShapePtrType |
typedef std::function< void(const typename GetContactsFromLastStepFeature::World< PolicyT, FeaturesT >::Contact &, size_t, ContactSurfaceParams< PolicyT > &) > | SurfaceParamsCallback |
This callback is called for every detected contact point and allows customizing properties of the contact surface. | |
Public Types inherited from Entity< PolicyT, FeaturesT > | |
using | Features = FeaturesT |
using | Pimpl = typename detail::DeterminePlugin< Policy, Features >::type |
using | Policy = PolicyT |
Public Member Functions | |
void | AddContactPropertiesCallback (const std::string &_callbackID, SurfaceParamsCallback _callback) |
Add the callback. | |
bool | RemoveContactPropertiesCallback (const std::string &_callbackID) |
Remove the callback. | |
Public Member Functions inherited from Feature::World< PolicyT, FeaturesT > | |
virtual | ~World ()=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
◆ ShapePtrType
template<typename PolicyT , typename FeaturesT >
using ShapePtrType = typename GetContactsFromLastStepFeature ::World<PolicyT, FeaturesT>::ShapePtrType |
◆ SurfaceParamsCallback
template<typename PolicyT , typename FeaturesT >
typedef std::function< void( const typename GetContactsFromLastStepFeature:: World<PolicyT, FeaturesT>::Contact& , size_t , ContactSurfaceParams<PolicyT>& ) > SurfaceParamsCallback |
This callback is called for every detected contact point and allows customizing properties of the contact surface.
- Parameters
-
_contact[in] The contact object containing contact point, normal, force etc. Please note that the force will be always zero because the forward step has not yet been run to compute the force. _numContactsOnCollision[in] Number of contact points on the same collision object. This can be used e.g. for force normalization. _surfaceParams[in,out] Parameters of the contact surface. They are pre-filled by the physics engine and the callback can alter them.
Member Function Documentation
◆ AddContactPropertiesCallback()
template<typename PolicyT , typename FeaturesT >
void AddContactPropertiesCallback | ( | const std::string & | _callbackID, |
SurfaceParamsCallback | _callback | ||
) |
Add the callback.
◆ RemoveContactPropertiesCallback()
template<typename PolicyT , typename FeaturesT >
bool RemoveContactPropertiesCallback | ( | const std::string & | _callbackID | ) |
Remove the callback.
The documentation for this class was generated from the following file: