Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni

Class BroadPhaseLayerInterfaceMask

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

com.github.stephengold.joltjni.NonCopyable

com.github.stephengold.joltjni.BroadPhaseLayerInterface

com.github.stephengold.joltjni.BroadPhaseLayerInterfaceMask

All Implemented Interfaces:

ConstBroadPhaseLayerInterface, ConstJoltPhysicsObject, AutoCloseable, Comparable<JoltPhysicsObject>

public class BroadPhaseLayerInterfaceMask
extends BroadPhaseLayerInterface

Map object layers to broad-phase layers using bitmasks.

Constructor Summary

Constructors

Constructor	Description
BroadPhaseLayerInterfaceMask(int numBpLayers)	Instantiate a default map with the specified capacity.

Method Summary

Modifier and Type	Method	Description
BroadPhaseLayerInterfaceMask	configureLayer(int bpLayer, int groupsToInclude, int groupsToExclude)	Configure the specified broad-phase layer.
BroadPhaseLayerInterfaceMask	setBroadPhaseLayerName(int bpLayer, String name)	If profiling is enabled, alter the name of the specified layer.

Methods inherited from class com.github.stephengold.joltjni.BroadPhaseLayerInterface

getBroadPhaseLayer, getBroadPhaseLayerName, getNumBroadPhaseLayers

Methods inherited from class com.github.stephengold.joltjni.JoltPhysicsObject

close, compareTo, equals, getContainingObject, hasAssignedNativeObject, hashCode, isCleanerStarted, ownsNativeObject, setVirtualAddress, setVirtualAddress, startCleaner, targetVa, targetVaOrZero, toString, va

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.github.stephengold.joltjni.readonly.ConstJoltPhysicsObject

close, hasAssignedNativeObject, ownsNativeObject, targetVa, targetVaOrZero

Constructor Details

BroadPhaseLayerInterfaceMask

public BroadPhaseLayerInterfaceMask(int numBpLayers)

Instantiate a default map with the specified capacity.

Parameters:

numBpLayers - the desired number of broad-phase layers (≥1)

Method Details

configureLayer

public BroadPhaseLayerInterfaceMask configureLayer(int bpLayer,
 int groupsToInclude,
 int groupsToExclude)

Configure the specified broad-phase layer.

Parameters:

bpLayer - the index of the broad-phase layer to configure (≥0, < numBpLayers)

groupsToInclude - a bitmask of groups to include

groupsToExclude - a bitmask of groups to exclude

Returns:

the modified map, for chaining

setBroadPhaseLayerName

public BroadPhaseLayerInterfaceMask setBroadPhaseLayerName(int bpLayer,
 String name)

If profiling is enabled, alter the name of the specified layer. Otherwise this has no effect.

Parameters:

bpLayer - the index of the broad-phase layer to modify (≥0, < numBpLayers)

name - the desired name (not null)

Returns:

the modified map, for chaining