PhysicsCollisionObject (jMonkeyEngine3)

java.lang.Object
- com.jme3.bullet.collision.PhysicsCollisionObject

All Implemented Interfaces:

Savable

Direct Known Subclasses:

PhysicsCharacter, PhysicsGhostObject, PhysicsRigidBody
```
public abstract class PhysicsCollisionObject
extends java.lang.Object
implements Savable
```
The abstract base class for collision objects based on Bullet's btCollisionObject.
Collision objects include PhysicsCharacter, PhysicsRigidBody, and PhysicsGhostObject.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`COLLISION_GROUP_01` collisionGroup/collideWithGroups bitmask that represents group #1
`static int`	`COLLISION_GROUP_02` collisionGroup/collideWithGroups bitmask that represents group #2
`static int`	`COLLISION_GROUP_03` collisionGroup/collideWithGroups bitmask that represents group #3
`static int`	`COLLISION_GROUP_04` collisionGroup/collideWithGroups bitmask that represents group #4
`static int`	`COLLISION_GROUP_05` collisionGroup/collideWithGroups bitmask that represents group #5
`static int`	`COLLISION_GROUP_06` collisionGroup/collideWithGroups bitmask that represents group #6
`static int`	`COLLISION_GROUP_07` collisionGroup/collideWithGroups bitmask that represents group #7
`static int`	`COLLISION_GROUP_08` collisionGroup/collideWithGroups bitmask that represents group #8
`static int`	`COLLISION_GROUP_09` collisionGroup/collideWithGroups bitmask that represents group #9
`static int`	`COLLISION_GROUP_10` collisionGroup/collideWithGroups bitmask that represents group #10
`static int`	`COLLISION_GROUP_11` collisionGroup/collideWithGroups bitmask that represents group #11
`static int`	`COLLISION_GROUP_12` collisionGroup/collideWithGroups bitmask that represents group #12
`static int`	`COLLISION_GROUP_13` collisionGroup/collideWithGroups bitmask that represents group #13
`static int`	`COLLISION_GROUP_14` collisionGroup/collideWithGroups bitmask that represents group #14
`static int`	`COLLISION_GROUP_15` collisionGroup/collideWithGroups bitmask that represents group #15
`static int`	`COLLISION_GROUP_16` collisionGroup/collideWithGroups bitmask that represents group #16
`static int`	`COLLISION_GROUP_NONE` collideWithGroups bitmask that represents "no groups"
`protected int`	`collisionGroup` collision group to which this physics object belongs (default=group #1)
`protected int`	`collisionGroupsMask` collision groups with which this object can collide (default=only group #1)
`protected CollisionShape`	`collisionShape` shape associated with this object (not null)
`protected long`	`objectId` Unique identifier of the btCollisionObject.

Constructor Summary

Constructors
Constructor and Description

PhysicsCollisionObject()

Constructors
Constructor and Description
`PhysicsCollisionObject()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCollideWithGroup(int collisionGroup)` Add collision groups to the set with which this object can collide.
`protected void`	`attachCollisionShape(long objectId, long collisionShapeId)` Attach the identified btCollisionShape to the identified btCollisionObject.
`protected void`	`finalize()` Finalize this collision object just before it is destroyed.
`protected void`	`finalizeNative(long objectId)` Finalize the identified btCollisionObject.
`int`	`getCollideWithGroups()` Read the set of collision groups with which this object can collide.
`protected int`	`getCollisionFlags(long objectId)` Read the collision flags of this object.
`int`	`getCollisionGroup()` Read the collision group for this physics object.
`CollisionShape`	`getCollisionShape()` Access the shape of this physics object.
`float`	`getDeactivationTime()` Read the deactivation time.
`long`	`getObjectId()` Read the id of the btCollisionObject.
`java.lang.Object`	`getUserObject()` Access the user object associated with this collision object.
`protected void`	`initUserPointer()` Initialize the user pointer and collision-group information of this object.
`boolean`	`isContactResponse()` Test whether this object responds to contact with other objects.
`void`	`read(JmeImporter e)` De-serialize this object, for example when loading from a J3O file.
`void`	`removeCollideWithGroup(int collisionGroup)` Remove collision groups from the set with which this object can collide.
`void`	`setCollideWithGroups(int collisionGroups)` Directly alter the collision groups with which this object can collide.
`protected void`	`setCollisionFlags(long objectId, int desiredFlags)` Alter the collision flags of this object.
`void`	`setCollisionGroup(int collisionGroup)` Alter the collision group for this physics object.
`void`	`setCollisionShape(CollisionShape collisionShape)` Apply the specified CollisionShape to this object.
`void`	`setUserObject(java.lang.Object userObject)` Associate a user object (such as a Spatial) with this collision object.
`void`	`write(JmeExporter e)` Serialize this object, for example when saving to a J3O file.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - objectId
```
protected long objectId
```
    Unique identifier of the btCollisionObject. Constructors are responsible for setting this to a non-zero value. The id might change if the object gets rebuilt.
  - collisionShape
```
protected CollisionShape collisionShape
```
    shape associated with this object (not null)
  - COLLISION_GROUP_NONE
```
public static final int COLLISION_GROUP_NONE
```
    collideWithGroups bitmask that represents "no groups"
    
    See Also:
    
    Constant Field Values
  - COLLISION_GROUP_01
```
public static final int COLLISION_GROUP_01
```
    collisionGroup/collideWithGroups bitmask that represents group #1
    
    See Also:
    
    Constant Field Values
  - COLLISION_GROUP_02
```
public static final int COLLISION_GROUP_02
```
    collisionGroup/collideWithGroups bitmask that represents group #2
    
    See Also:
    
    Constant Field Values
  - COLLISION_GROUP_03
```
public static final int COLLISION_GROUP_03
```
    collisionGroup/collideWithGroups bitmask that represents group #3
    
    See Also:
    
    Constant Field Values
  - COLLISION_GROUP_04
```
public static final int COLLISION_GROUP_04
```
    collisionGroup/collideWithGroups bitmask that represents group #4
    
    See Also:
    
    Constant Field Values
  - COLLISION_GROUP_05
```
public static final int COLLISION_GROUP_05
```
    collisionGroup/collideWithGroups bitmask that represents group #5
    
    See Also:
    
    Constant Field Values
  - COLLISION_GROUP_06
```
public static final int COLLISION_GROUP_06
```
    collisionGroup/collideWithGroups bitmask that represents group #6
    
    See Also:
    
    Constant Field Values
  - COLLISION_GROUP_07
```
public static final int COLLISION_GROUP_07
```
    collisionGroup/collideWithGroups bitmask that represents group #7
    
    See Also:
    
    Constant Field Values
  - COLLISION_GROUP_08
```
public static final int COLLISION_GROUP_08
```
    collisionGroup/collideWithGroups bitmask that represents group #8
    
    See Also:
    
    Constant Field Values
  - COLLISION_GROUP_09
```
public static final int COLLISION_GROUP_09
```
    collisionGroup/collideWithGroups bitmask that represents group #9
    
    See Also:
    
    Constant Field Values
  - COLLISION_GROUP_10
```
public static final int COLLISION_GROUP_10
```
    collisionGroup/collideWithGroups bitmask that represents group #10
    
    See Also:
    
    Constant Field Values
  - COLLISION_GROUP_11
```
public static final int COLLISION_GROUP_11
```
    collisionGroup/collideWithGroups bitmask that represents group #11
    
    See Also:
    
    Constant Field Values
  - COLLISION_GROUP_12
```
public static final int COLLISION_GROUP_12
```
    collisionGroup/collideWithGroups bitmask that represents group #12
    
    See Also:
    
    Constant Field Values
  - COLLISION_GROUP_13
```
public static final int COLLISION_GROUP_13
```
    collisionGroup/collideWithGroups bitmask that represents group #13
    
    See Also:
    
    Constant Field Values
  - COLLISION_GROUP_14
```
public static final int COLLISION_GROUP_14
```
    collisionGroup/collideWithGroups bitmask that represents group #14
    
    See Also:
    
    Constant Field Values
  - COLLISION_GROUP_15
```
public static final int COLLISION_GROUP_15
```
    collisionGroup/collideWithGroups bitmask that represents group #15
    
    See Also:
    
    Constant Field Values
  - COLLISION_GROUP_16
```
public static final int COLLISION_GROUP_16
```
    collisionGroup/collideWithGroups bitmask that represents group #16
    
    See Also:
    
    Constant Field Values
  - collisionGroup
```
protected int collisionGroup
```
    collision group to which this physics object belongs (default=group #1)
  - collisionGroupsMask
```
protected int collisionGroupsMask
```
    collision groups with which this object can collide (default=only group #1)
- Constructor Detail
  - PhysicsCollisionObject
```
public PhysicsCollisionObject()
```
- Method Detail
  - setCollisionShape
```
public void setCollisionShape(CollisionShape collisionShape)
```
    Apply the specified CollisionShape to this object. Note that the object should not be in any physics space while changing shape; the object gets rebuilt on the physics side.
    
    Parameters:
    
    collisionShape - the shape to apply (not null, alias created)
  - getCollisionShape
```
public CollisionShape getCollisionShape()
```
    Access the shape of this physics object.
    
    Returns:
    
    the pre-existing instance, which can then be applied to other physics objects (increases performance)
  - getDeactivationTime
```
public float getDeactivationTime()
```
    Read the deactivation time.
    
    Returns:
    
    the time (in seconds)
  - getCollisionGroup
```
public int getCollisionGroup()
```
    Read the collision group for this physics object.
    
    Returns:
    
    the collision group (bit mask with exactly one bit set)
  - setCollisionGroup
```
public void setCollisionGroup(int collisionGroup)
```
    Alter the collision group for this physics object.
    Groups are represented by integer bit masks with exactly 1 bit set. Pre-made variables are available in PhysicsCollisionObject. By default, physics objects are in COLLISION_GROUP_01.
    Two objects can collide only if one of them has the collisionGroup of the other in its collideWithGroups set.
    
    Parameters:
    
    collisionGroup - the collisionGroup to apply (bit mask with exactly 1 bit set)
  - addCollideWithGroup
```
public void addCollideWithGroup(int collisionGroup)
```
    Add collision groups to the set with which this object can collide. Two objects can collide only if one of them has the collisionGroup of the other in its collideWithGroups set.
    
    Parameters:
    
    collisionGroup - groups to add (bit mask)
  - removeCollideWithGroup
```
public void removeCollideWithGroup(int collisionGroup)
```
    Remove collision groups from the set with which this object can collide.
    
    Parameters:
    
    collisionGroup - groups to remove, ORed together (bit mask)
  - setCollideWithGroups
```
public void setCollideWithGroups(int collisionGroups)
```
    Directly alter the collision groups with which this object can collide.
    
    Parameters:
    
    collisionGroups - desired groups, ORed together (bit mask)
  - getCollideWithGroups
```
public int getCollideWithGroups()
```
    Read the set of collision groups with which this object can collide.
    
    Returns:
    
    bit mask
  - initUserPointer
```
protected void initUserPointer()
```
    Initialize the user pointer and collision-group information of this object.
  - getUserObject
```
public java.lang.Object getUserObject()
```
    Access the user object associated with this collision object.
    
    Returns:
    
    the pre-existing instance, or null if none
  - isContactResponse
```
public boolean isContactResponse()
```
    Test whether this object responds to contact with other objects.
    
    Returns:
    
    true if responsive, otherwise false
  - setUserObject
```
public void setUserObject(java.lang.Object userObject)
```
    Associate a user object (such as a Spatial) with this collision object.
    
    Parameters:
    
    userObject - the object to associate with this collision object (alias created, may be null)
  - getObjectId
```
public long getObjectId()
```
    Read the id of the btCollisionObject.
    
    Returns:
    
    the unique identifier (not zero)
  - attachCollisionShape
```
protected void attachCollisionShape(long objectId,
                                    long collisionShapeId)
```
    Attach the identified btCollisionShape to the identified btCollisionObject. Native method.
    
    Parameters:
    
    objectId - the unique identifier of the btCollisionObject (not zero)
    
    collisionShapeId - the unique identifier of the btCollisionShape (not zero)
  - write
```
public void write(JmeExporter e)
           throws java.io.IOException
```
    Serialize this object, for example when saving to a J3O file.
    
    Specified by:
    
    write in interface Savable
    
    Parameters:
    
    e - exporter (not null)
    
    Throws:
    
    java.io.IOException - from exporter
  - read
```
public void read(JmeImporter e)
          throws java.io.IOException
```
    De-serialize this object, for example when loading from a J3O file.
    
    Specified by:
    
    read in interface Savable
    
    Parameters:
    
    e - importer (not null)
    
    Throws:
    
    java.io.IOException - from importer
  - getCollisionFlags
```
protected int getCollisionFlags(long objectId)
```
    Read the collision flags of this object. Subclasses are responsible for cloning/reading/writing these flags.
    
    Parameters:
    
    objectId - the ID of the btCollisionObject (not zero)
    
    Returns:
    
    the collision flags (bit mask)
  - setCollisionFlags
```
protected void setCollisionFlags(long objectId,
                                 int desiredFlags)
```
    Alter the collision flags of this object. Subclasses are responsible for cloning/reading/writing these flags.
    
    Parameters:
    
    objectId - the ID of the btCollisionObject (not zero)
    
    desiredFlags - the desired collision flags (bit mask)
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Finalize this collision object just before it is destroyed. Should be invoked only by a subclass or by the garbage collector.
    
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.lang.Throwable - ignored by the garbage collector
  - finalizeNative
```
protected void finalizeNative(long objectId)
```
    Finalize the identified btCollisionObject. Native method.
    
    Parameters:
    
    objectId - the unique identifier of the btCollisionObject (not zero)

Class PhysicsCollisionObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

objectId

collisionShape

COLLISION_GROUP_NONE

COLLISION_GROUP_01

COLLISION_GROUP_02

COLLISION_GROUP_03

COLLISION_GROUP_04

COLLISION_GROUP_05

COLLISION_GROUP_06

COLLISION_GROUP_07

COLLISION_GROUP_08

COLLISION_GROUP_09

COLLISION_GROUP_10

COLLISION_GROUP_11

COLLISION_GROUP_12

COLLISION_GROUP_13

COLLISION_GROUP_14

COLLISION_GROUP_15

COLLISION_GROUP_16

collisionGroup

collisionGroupsMask

Constructor Detail

PhysicsCollisionObject

Method Detail

setCollisionShape

getCollisionShape

getDeactivationTime

getCollisionGroup

setCollisionGroup

addCollideWithGroup

removeCollideWithGroup

setCollideWithGroups

getCollideWithGroups

initUserPointer

getUserObject

isContactResponse

setUserObject

getObjectId

attachCollisionShape

write

read

getCollisionFlags

setCollisionFlags

finalize

finalizeNative