BroadPhaseLayer Class Reference

#include <BroadPhaseLayer.h>

Public Types
using	Type = uint8

Public Member Functions
JPH_INLINE	BroadPhaseLayer ()=default
JPH_INLINE constexpr	BroadPhaseLayer (Type inValue)
JPH_INLINE constexpr	BroadPhaseLayer (const BroadPhaseLayer &)=default
JPH_INLINE BroadPhaseLayer &	operator= (const BroadPhaseLayer &)=default
JPH_INLINE constexpr bool	operator== (const BroadPhaseLayer &inRHS) const
JPH_INLINE constexpr bool	operator!= (const BroadPhaseLayer &inRHS) const
JPH_INLINE constexpr bool	operator< (const BroadPhaseLayer &inRHS) const
JPH_INLINE constexpr	operator Type () const
JPH_INLINE Type	GetValue () const

Detailed Description

An object layer can be mapped to a broadphase layer. Objects with the same broadphase layer will end up in the same sub structure (usually a tree) of the broadphase. When there are many layers, this reduces the total amount of sub structures the broad phase needs to manage. Usually you want objects that don't collide with each other in different broad phase layers, but there could be exceptions if objects layers only contain a minor amount of objects so it is not beneficial to give each layer its own sub structure in the broadphase. Note: This class requires explicit casting from and to Type to avoid confusion with ObjectLayer

Member Typedef Documentation

Type

using BroadPhaseLayer::Type = uint8

Constructor & Destructor Documentation

BroadPhaseLayer() [1/3]

JPH_INLINE BroadPhaseLayer::BroadPhaseLayer ( )

default

BroadPhaseLayer() [2/3]

JPH_INLINE constexpr BroadPhaseLayer::BroadPhaseLayer ( Type  inValue )

inlineexplicitconstexpr

BroadPhaseLayer() [3/3]

JPH_INLINE constexpr BroadPhaseLayer::BroadPhaseLayer ( const BroadPhaseLayer &  )

constexprdefault

Member Function Documentation

GetValue()

JPH_INLINE Type BroadPhaseLayer::GetValue ( ) const

inline

operator Type()

JPH_INLINE constexpr BroadPhaseLayer::operator Type ( ) const

inlineexplicitconstexpr

operator!=()

JPH_INLINE constexpr bool BroadPhaseLayer::operator!= ( const BroadPhaseLayer &  inRHS ) const

inlineconstexpr

operator<()

JPH_INLINE constexpr bool BroadPhaseLayer::operator< ( const BroadPhaseLayer &  inRHS ) const

inlineconstexpr

operator=()

JPH_INLINE BroadPhaseLayer & BroadPhaseLayer::operator= ( const BroadPhaseLayer &  )

default

operator==()

JPH_INLINE constexpr bool BroadPhaseLayer::operator== ( const BroadPhaseLayer &  inRHS ) const

inlineconstexpr

---

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

• Jolt/Physics/Collision/BroadPhase/BroadPhaseLayer.h