SetPlaneShapeProperties::PlaneShape< PolicyT, FeaturesT > Class Template Reference
#include <PlaneShape.hh>
Public Types | |
| using | Normal = typename FromPolicy< PolicyT >::template Use< LinearVector > | 
| using | Point = typename FromPolicy< PolicyT >::template Use< LinearVector > | 
  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 | SetNormal (const Normal &_normal) | 
| Set the normal vector of this plane.   | |
| void | SetPoint (const Point &_point) | 
| Specify a point on this plane. The normal vector will remain fixed.   | |
  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
◆ Normal
template<typename PolicyT , typename FeaturesT > 
      | using Normal = typename FromPolicy<PolicyT>::template Use<LinearVector> | 
◆ Point
template<typename PolicyT , typename FeaturesT > 
      | using Point = typename FromPolicy<PolicyT>::template Use<LinearVector> | 
Member Function Documentation
◆ SetNormal()
template<typename PolicyT , typename FeaturesT > 
      | void SetNormal | ( | const Normal & | _normal | ) | 
Set the normal vector of this plane.
- Parameters
 - 
  
[in] _normal The new normal vector for this plane  
◆ SetPoint()
template<typename PolicyT , typename FeaturesT > 
      | void SetPoint | ( | const Point & | _point | ) | 
Specify a point on this plane. The normal vector will remain fixed.
- Parameters
 - 
  
[in] _point A point which needs to be on the plane.  
The documentation for this class was generated from the following file:
 Public Types inherited from