SubShapeIDPair Class Reference

A pair of bodies and their sub shape ID's. Can be used as a key in a map to find a contact point. More...

#include <SubShapeIDPair.h>

Public Member Functions
JPH_OVERRIDE_NEW_DELETE	SubShapeIDPair ()=default
	Constructor.
	SubShapeIDPair (const BodyID &inBody1ID, const SubShapeID &inSubShapeID1, const BodyID &inBody2ID, const SubShapeID &inSubShapeID2)
SubShapeIDPair &	operator= (const SubShapeIDPair &)=default
	SubShapeIDPair (const SubShapeIDPair &)=default
bool	operator== (const SubShapeIDPair &inRHS) const
	Equality operator.
bool	operator< (const SubShapeIDPair &inRHS) const
	Less than operator, used to consistently order contact points for a deterministic simulation.
const BodyID &	GetBody1ID () const
const SubShapeID &	GetSubShapeID1 () const
const BodyID &	GetBody2ID () const
const SubShapeID &	GetSubShapeID2 () const
uint64	GetHash () const

Detailed Description

A pair of bodies and their sub shape ID's. Can be used as a key in a map to find a contact point.

Constructor & Destructor Documentation

SubShapeIDPair() [1/3]

JPH_OVERRIDE_NEW_DELETE SubShapeIDPair::SubShapeIDPair ( )

default

Constructor.

SubShapeIDPair() [2/3]

SubShapeIDPair::SubShapeIDPair ( const BodyID &  inBody1ID, const SubShapeID &  inSubShapeID1, const BodyID &  inBody2ID, const SubShapeID &  inSubShapeID2  )

inline

SubShapeIDPair() [3/3]

SubShapeIDPair::SubShapeIDPair ( const SubShapeIDPair &  )

default

Member Function Documentation

GetBody1ID()

const BodyID & SubShapeIDPair::GetBody1ID ( ) const

inline

GetBody2ID()

const BodyID & SubShapeIDPair::GetBody2ID ( ) const

inline

GetHash()

uint64 SubShapeIDPair::GetHash ( ) const

inline

GetSubShapeID1()

const SubShapeID & SubShapeIDPair::GetSubShapeID1 ( ) const

inline

GetSubShapeID2()

const SubShapeID & SubShapeIDPair::GetSubShapeID2 ( ) const

inline

operator<()

bool SubShapeIDPair::operator< ( const SubShapeIDPair &  inRHS ) const

inline

Less than operator, used to consistently order contact points for a deterministic simulation.

operator=()

SubShapeIDPair & SubShapeIDPair::operator= ( const SubShapeIDPair &  )

default

operator==()

bool SubShapeIDPair::operator== ( const SubShapeIDPair &  inRHS ) const

inline

Equality operator.

---

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

• Jolt/Physics/Collision/Shape/SubShapeIDPair.h