Loading [MathJax]/extensions/tex2jax.js
Jolt Physics
A multi core friendly Game Physics Engine
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
BroadPhaseLayerInterface Class Referenceabstract

Interface that the application should implement to allow mapping object layers to broadphase layers. More...

#include <BroadPhaseLayer.h>

Inheritance diagram for BroadPhaseLayerInterface:
NonCopyable BroadPhaseLayerInterfaceMask BroadPhaseLayerInterfaceTable

Public Member Functions

virtual ~BroadPhaseLayerInterface ()=default
 Destructor. More...
 
virtual uint GetNumBroadPhaseLayers () const =0
 Return the number of broadphase layers there are. More...
 
virtual BroadPhaseLayer GetBroadPhaseLayer (ObjectLayer inLayer) const =0
 Convert an object layer to the corresponding broadphase layer. More...
 
virtual const char * GetBroadPhaseLayerName (BroadPhaseLayer inLayer) const =0
 Get the user readable name of a broadphase layer (debugging purposes) More...
 
- Public Member Functions inherited from NonCopyable
 NonCopyable ()=default
 
 NonCopyable (const NonCopyable &)=delete
 
void operator= (const NonCopyable &)=delete
 

Detailed Description

Interface that the application should implement to allow mapping object layers to broadphase layers.

Constructor & Destructor Documentation

◆ ~BroadPhaseLayerInterface()

virtual BroadPhaseLayerInterface::~BroadPhaseLayerInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ GetBroadPhaseLayer()

virtual BroadPhaseLayer BroadPhaseLayerInterface::GetBroadPhaseLayer ( ObjectLayer  inLayer) const
pure virtual

Convert an object layer to the corresponding broadphase layer.

Implemented in BroadPhaseLayerInterfaceMask, and BroadPhaseLayerInterfaceTable.

◆ GetBroadPhaseLayerName()

virtual const char * BroadPhaseLayerInterface::GetBroadPhaseLayerName ( BroadPhaseLayer  inLayer) const
pure virtual

Get the user readable name of a broadphase layer (debugging purposes)

Implemented in BroadPhaseLayerInterfaceMask, and BroadPhaseLayerInterfaceTable.

◆ GetNumBroadPhaseLayers()

virtual uint BroadPhaseLayerInterface::GetNumBroadPhaseLayers ( ) const
pure virtual

Return the number of broadphase layers there are.

Implemented in BroadPhaseLayerInterfaceMask, and BroadPhaseLayerInterfaceTable.

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