Broadphase regions. More...

#include <PxBroadPhase.h>

Inheritance diagram for physx::PxBroadPhaseRegions:

Public Member Functions
virtual PxU32	getNbRegions () const =0
	Returns number of regions currently registered in the broad-phase.

virtual PxU32	getRegions (PxBroadPhaseRegionInfo *userBuffer, PxU32 bufferSize, PxU32 startIndex=0) const =0
	Gets broad-phase regions.

virtual PxU32	addRegion (const PxBroadPhaseRegion &region, bool populateRegion, const PxBounds3 bounds, const float distances)=0
	Adds a new broad-phase region.

virtual bool	removeRegion (PxU32 handle)=0
	Removes a broad-phase region.

virtual PxU32	getNbOutOfBoundsObjects () const =0

virtual const PxU32 *	getOutOfBoundsObjects () const =0

Detailed Description

Broadphase regions.

An API to manage broadphase regions. Only needed for the MBP broadphase (PxBroadPhaseType::eMBP).

See also: PxBroadPhase::getRegions()

Member Function Documentation

◆ addRegion()

virtual PxU32 physx::PxBroadPhaseRegions::addRegion	(	const PxBroadPhaseRegion &	region,
		bool	populateRegion,
		const PxBounds3 *	bounds,
		const float *	distances
	)

pure virtual

Adds a new broad-phase region.

The total number of regions is limited to PxBroadPhaseCaps::mMaxNbRegions. If that number is exceeded, the call is ignored.

The newly added region will be automatically populated with already existing objects that touch it, if the 'populateRegion' parameter is set to true. Otherwise the newly added region will be empty, and it will only be populated with objects when those objects are added to the simulation, or updated if they already exist.

Using 'populateRegion=true' has a cost, so it is best to avoid it if possible. In particular it is more efficient to create the empty regions first (with populateRegion=false) and then add the objects afterwards (rather than the opposite).

Objects automatically move from one region to another during their lifetime. The system keeps tracks of what regions a given object is in. It is legal for an object to be in an arbitrary number of regions. However if an object leaves all regions, or is created outside of all regions, several things happen:

collisions get disabled for this object
the object appears in the getOutOfBoundsObjects() array

If an out-of-bounds object, whose collisions are disabled, re-enters a valid broadphase region, then collisions are re-enabled for that object.

Parameters

region	[in] User-provided region data
populateRegion	[in] True to automatically populate the newly added region with existing objects touching it
bounds	[in] User-managed array of bounds
distances	[in] User-managed array of distances

Returns: Handle for newly created region, or 0xffffffff in case of failure.

See also: PxBroadPhaseRegion getOutOfBoundsObjects()

Implemented in physx::Bp::BroadPhaseBase, and physx::Bp::BroadPhaseMBP.

◆ getNbRegions()

virtual PxU32 physx::PxBroadPhaseRegions::getNbRegions ( ) const

pure virtual

Returns number of regions currently registered in the broad-phase.

Returns: Number of regions

Implemented in physx::Bp::BroadPhaseMBP, and physx::Bp::BroadPhaseBase.

◆ getRegions()

virtual PxU32 physx::PxBroadPhaseRegions::getRegions	(	PxBroadPhaseRegionInfo *	userBuffer,
		PxU32	bufferSize,
		PxU32	startIndex = `0`
	)		const

pure virtual

Gets broad-phase regions.

Parameters

userBuffer	[out] Returned broad-phase regions
bufferSize	[in] Size of provided userBuffer.
startIndex	[in] Index of first desired region, in [0 ; getNbRegions()[

Returns: Number of written out regions.

See also: PxBroadPhaseRegionInfo

Implemented in physx::Bp::BroadPhaseBase, and physx::Bp::BroadPhaseMBP.

◆ removeRegion()

virtual bool physx::PxBroadPhaseRegions::removeRegion ( PxU32 handle )

pure virtual

Removes a broad-phase region.

If the region still contains objects, and if those objects do not overlap any region any more, they are not automatically removed from the simulation. Instead, the PxBroadPhaseCallback::onObjectOutOfBounds notification is used for each object. Users are responsible for removing the objects from the simulation if this is the desired behavior.

If the handle is invalid, or if a valid handle is removed twice, an error message is sent to the error stream.

Parameters

handle [in] Region's handle, as returned by addRegion

Returns: True if success

Implemented in physx::Bp::BroadPhaseMBP, and physx::Bp::BroadPhaseBase.

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

RavEngine/deps/physx/physx/include/PxBroadPhase.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ addRegion()

◆ getNbRegions()

◆ getRegions()

◆ removeRegion()