physx::PxBroadcast< Listener, Base > Class Template Reference

Broadcast class implementation, registering listeners. More...

#include <PxBroadcast.h>

Inheritance diagram for physx::PxBroadcast< Listener, Base >:

Collaboration diagram for physx::PxBroadcast< Listener, Base >:

Public Member Functions
	PxBroadcast ()
	The default constructor.
void	registerListener (Listener &listener)
	Register new listener.
void	deregisterListener (Listener &listener)
	Deregister an existing listener.
uint32_t	getNbListeners () const
	Get number of registered listeners.
Listener &	getListener (uint32_t index)
	Get an existing listener from given index.

Static Public Attributes
static const uint32_t	MAX_NB_LISTENERS = 16

Protected Attributes
physx::PxInlineArray< Listener *, MAX_NB_LISTENERS, physx::PxAllocator >	mListeners

Detailed Description

template<class Listener, class Base>
class physx::PxBroadcast< Listener, Base >

Broadcast class implementation, registering listeners.

Threading: All methods of this class should be thread safe as it can be called from the user thread or the physics processing thread(s). There is not internal locking

Member Function Documentation

deregisterListener()

template<class Listener , class Base >

void physx::PxBroadcast< Listener, Base >::deregisterListener ( Listener &  listener )

inline

Deregister an existing listener.

Note

It is NOT SAFE to register and deregister listeners while allocations may be taking place. moreover, there is no thread safety to registration/deregistration.

Parameters

listener

Listener to deregister.

getListener()

template<class Listener , class Base >

Listener & physx::PxBroadcast< Listener, Base >::getListener ( uint32_t  index )

inline

Get an existing listener from given index.

Parameters

index

Index of the listener.

Returns

Listener on given index.

getNbListeners()

template<class Listener , class Base >

uint32_t physx::PxBroadcast< Listener, Base >::getNbListeners ( ) const

inline

Get number of registered listeners.

Returns

Number of listeners.

registerListener()

template<class Listener , class Base >

void physx::PxBroadcast< Listener, Base >::registerListener ( Listener &  listener )

inline

Register new listener.

Note

It is NOT SAFE to register and deregister listeners while allocations may be taking place. moreover, there is no thread safety to registration/deregistration.

Parameters

listener

Listener to register.

---

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

• RavEngine/deps/physx/physx/include/foundation/PxBroadcast.h