box2d::ContactFeature Struct Reference

Contact Feature. More...

#include <ContactFeature.hpp>

Public Types
enum	Type : std::uint8_t { e_vertex = 0, e_face = 1 }
using	index_t = std::uint8_t
	Index type. More...

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

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.

Member Typedef Documentation

index_t

using box2d::ContactFeature::index_t = std::uint8_t

Index type.

Member Enumeration Documentation

Type

enum box2d::ContactFeature::Type : std::uint8_t

Enumerator
e_vertex
e_face

Member Data Documentation

indexA

index_t box2d::ContactFeature::indexA

Feature index on shape A.

indexB

index_t box2d::ContactFeature::indexB

Feature index on shape B.

typeA

Type box2d::ContactFeature::typeA

The feature type on shape A.

typeB

Type box2d::ContactFeature::typeB

The feature type on shape B.

---

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

• ContactFeature.hpp