Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni

Class CollisionGroup

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

com.github.stephengold.joltjni.CollisionGroup

All Implemented Interfaces:

ConstCollisionGroup, ConstJoltPhysicsObject, AutoCloseable, Comparable<JoltPhysicsObject>

public class CollisionGroup
extends JoltPhysicsObject
implements ConstCollisionGroup

Restrict which bodies can collide.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	cInvalidGroup	invalid main group
static final int	cInvalidSubGroup	invalid sub-group

Constructor Summary

Constructors

Constructor	Description
CollisionGroup()	Instantiate a default group.
CollisionGroup(GroupFilter filter, int groupId, int subGroupId)	Instantiate a group with the specified filter and IDs.
CollisionGroup(GroupFilterTableRef filterRef, int groupId, int subGroupId)	Instantiate a group with the specified filter and IDs.

Method Summary

Modifier and Type	Method	Description
ConstGroupFilter	getGroupFilter()	Access the group filter.
int	getGroupId()	Return the main group ID.
int	getSubGroupId()	Return the sub-group ID.
void	setGroupFilter(GroupFilter filter)	Replace the group filter.
void	setGroupId(int id)	Alter the main group ID.
void	setSubGroupId(int id)	Alter the sub-group ID.

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

close, compareTo, equals, getContainingObject, hasAssignedNativeObject, hashCode, isCleanerStarted, ownsNativeObject, setVirtualAddress, setVirtualAddress, startCleaner, targetVa, 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

Field Details

cInvalidGroup

public static final int cInvalidGroup

invalid main group

See Also:

• Constant Field Values

cInvalidSubGroup

public static final int cInvalidSubGroup

invalid sub-group

See Also:

• Constant Field Values

Constructor Details

CollisionGroup

public CollisionGroup()

Instantiate a default group.

CollisionGroup

public CollisionGroup(GroupFilter filter,
 int groupId,
 int subGroupId)

Instantiate a group with the specified filter and IDs.

Parameters:

filter - the collision-group filter (not null)

groupId - the main group ID

subGroupId - the ID of the subgroup to which the body belongs

CollisionGroup

public CollisionGroup(GroupFilterTableRef filterRef,
 int groupId,
 int subGroupId)

Instantiate a group with the specified filter and IDs.

Parameters:

filterRef - a counted reference to the desired collision-group filter (not null)

groupId - the main group ID

subGroupId - the ID of the subgroup to which the body belongs

Method Details

setGroupFilter

public void setGroupFilter(GroupFilter filter)

Replace the group filter.

Parameters:

filter - the desired filter (not null, alias created)

setGroupId

public void setGroupId(int id)

Alter the main group ID. (native function: SetGroupID)

Parameters:

id - the desired ID (default=cInvalidGroup)

setSubGroupId

public void setSubGroupId(int id)

Alter the sub-group ID. (native function: SetSubGroupID)

Parameters:

id - the desired ID (default=cInvalidSubGroup)

getGroupFilter

public ConstGroupFilter getGroupFilter()

Access the group filter.

Specified by:

getGroupFilter in interface ConstCollisionGroup

Returns:

a new JVM object with the pre-existing native object assigned, or null if none

getGroupId

public int getGroupId()

Return the main group ID. The group is unaffected. (native function: GetGroupID)

Specified by:

getGroupId in interface ConstCollisionGroup

Returns:

the GroupID value

getSubGroupId

public int getSubGroupId()

Return the sub-group ID. The group is unaffected. (native function: GetSubGroupID)

Specified by:

getSubGroupId in interface ConstCollisionGroup

Returns:

the SubGroupID value