playrho::ContactFeature Struct Reference

Contact Feature. More...

#include <ContactFeature.hpp>

Collaboration diagram for playrho::ContactFeature:

Public Types
enum	Type : std::uint8_t { e_vertex = 0, e_face = 1 }
	Type of the associated index value.
using	Index = std::uint8_t
	Index type.

Public Attributes
Type	typeA
	The feature type on shape A.
Index	indexA
	Feature index on shape A.
Type	typeB
	The feature type on shape B.
Index	indexB
	Feature index on shape B.

Related Functions
(Note that these are not member functions.)
constexpr ContactFeature	GetVertexVertexContactFeature (ContactFeature::Index a, ContactFeature::Index b) noexcept
	Gets the vertex vertex contact feature for the given indices.
constexpr ContactFeature	GetVertexFaceContactFeature (ContactFeature::Index a, ContactFeature::Index b) noexcept
	Gets the vertex face contact feature for the given indices.
constexpr ContactFeature	GetFaceVertexContactFeature (ContactFeature::Index a, ContactFeature::Index b) noexcept
	Gets the face vertex contact feature for the given indices.
constexpr ContactFeature	GetFaceFaceContactFeature (ContactFeature::Index a, ContactFeature::Index b) noexcept
	Gets the face face contact feature for the given indices.
constexpr ContactFeature	Flip (ContactFeature val) noexcept
	Flips contact features information.
constexpr bool	operator== (ContactFeature lhs, ContactFeature rhs) noexcept
	Determines if the given two contact features are equal.
constexpr bool	operator!= (ContactFeature lhs, ContactFeature rhs) noexcept
	Determines if the given two contact features are not equal.

Detailed Description

Contact Feature.

The features that intersect to form the contact point.

Note

This structure is designed to be compact and passed-by-value.

This data structure is 4-bytes large.

Possible type combinations are: vertex-vertex, vertex-face, face-vertex, or face-face.

---

The documentation for this struct was generated from the following file:

• ContactFeature.hpp