PhysicsCollisionObject (jMonkeyEngine 3.1 jme3-bullet Javadoc)

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

All Implemented Interfaces:

com.jme3.export.Savable

Direct Known Subclasses:

PhysicsCharacter, PhysicsGhostObject, PhysicsRigidBody
```
public abstract class PhysicsCollisionObject
extends java.lang.Object
implements com.jme3.export.Savable
```
Base class for collision objects (PhysicsRigidBody, PhysicsGhostObject)

Author:

normenhansen

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`COLLISION_GROUP_01`
`static int`	`COLLISION_GROUP_02`
`static int`	`COLLISION_GROUP_03`
`static int`	`COLLISION_GROUP_04`
`static int`	`COLLISION_GROUP_05`
`static int`	`COLLISION_GROUP_06`
`static int`	`COLLISION_GROUP_07`
`static int`	`COLLISION_GROUP_08`
`static int`	`COLLISION_GROUP_09`
`static int`	`COLLISION_GROUP_10`
`static int`	`COLLISION_GROUP_11`
`static int`	`COLLISION_GROUP_12`
`static int`	`COLLISION_GROUP_13`
`static int`	`COLLISION_GROUP_14`
`static int`	`COLLISION_GROUP_15`
`static int`	`COLLISION_GROUP_16`
`static int`	`COLLISION_GROUP_NONE`
`protected int`	`collisionGroup`
`protected int`	`collisionGroupsMask`
`protected CollisionShape`	`collisionShape`
`protected long`	`objectId`

Constructor Summary

Constructors
Constructor and Description

PhysicsCollisionObject()

Constructors
Constructor and Description
`PhysicsCollisionObject()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCollideWithGroup(int collisionGroup)` Add a group that this object will collide with. Two object will collide when one of the partys has the collisionGroup of the other in its collideWithGroups set.
`protected void`	`attachCollisionShape(long objectId, long collisionShapeId)`
`protected void`	`finalize()`
`protected void`	`finalizeNative(long objectId)`
`int`	`getCollideWithGroups()` Gets the bitmask of collision groups that this object collides with.
`int`	`getCollisionGroup()` Returns the collision group for this collision shape
`CollisionShape`	`getCollisionShape()`
`long`	`getObjectId()`
`java.lang.Object`	`getUserObject()`
`protected void`	`initUserPointer()`
`void`	`read(com.jme3.export.JmeImporter e)`
`void`	`removeCollideWithGroup(int collisionGroup)` Remove a group from the list this object collides with.
`void`	`setCollideWithGroups(int collisionGroups)` Directly set the bitmask for collision groups that this object collides with.
`void`	`setCollisionGroup(int collisionGroup)` Sets the collision group number for this physics object.
`void`	`setCollisionShape(CollisionShape collisionShape)` Sets a CollisionShape to this physics object, note that the object should not be in the physics space when adding a new collision shape as it is rebuilt on the physics side.
`void`	`setUserObject(java.lang.Object userObject)`
`void`	`write(com.jme3.export.JmeExporter e)`

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

- Field Detail
  - objectId
```
protected long objectId
```
  - collisionShape
```
protected CollisionShape collisionShape
```
  - COLLISION_GROUP_NONE
```
public static final int COLLISION_GROUP_NONE
```
    See Also:
    Constant Field Values
  - COLLISION_GROUP_01
```
public static final int COLLISION_GROUP_01
```
    See Also:
    Constant Field Values
  - COLLISION_GROUP_02
```
public static final int COLLISION_GROUP_02
```
    See Also:
    Constant Field Values
  - COLLISION_GROUP_03
```
public static final int COLLISION_GROUP_03
```
    See Also:
    Constant Field Values
  - COLLISION_GROUP_04
```
public static final int COLLISION_GROUP_04
```
    See Also:
    Constant Field Values
  - COLLISION_GROUP_05
```
public static final int COLLISION_GROUP_05
```
    See Also:
    Constant Field Values
  - COLLISION_GROUP_06
```
public static final int COLLISION_GROUP_06
```
    See Also:
    Constant Field Values
  - COLLISION_GROUP_07
```
public static final int COLLISION_GROUP_07
```
    See Also:
    Constant Field Values
  - COLLISION_GROUP_08
```
public static final int COLLISION_GROUP_08
```
    See Also:
    Constant Field Values
  - COLLISION_GROUP_09
```
public static final int COLLISION_GROUP_09
```
    See Also:
    Constant Field Values
  - COLLISION_GROUP_10
```
public static final int COLLISION_GROUP_10
```
    See Also:
    Constant Field Values
  - COLLISION_GROUP_11
```
public static final int COLLISION_GROUP_11
```
    See Also:
    Constant Field Values
  - COLLISION_GROUP_12
```
public static final int COLLISION_GROUP_12
```
    See Also:
    Constant Field Values
  - COLLISION_GROUP_13
```
public static final int COLLISION_GROUP_13
```
    See Also:
    Constant Field Values
  - COLLISION_GROUP_14
```
public static final int COLLISION_GROUP_14
```
    See Also:
    Constant Field Values
  - COLLISION_GROUP_15
```
public static final int COLLISION_GROUP_15
```
    See Also:
    Constant Field Values
  - COLLISION_GROUP_16
```
public static final int COLLISION_GROUP_16
```
    See Also:
    Constant Field Values
  - collisionGroup
```
protected int collisionGroup
```
  - collisionGroupsMask
```
protected int collisionGroupsMask
```
- Constructor Detail
  - PhysicsCollisionObject
```
public PhysicsCollisionObject()
```
- Method Detail
  - setCollisionShape
```
public void setCollisionShape(CollisionShape collisionShape)
```
    Sets a CollisionShape to this physics object, note that the object should not be in the physics space when adding a new collision shape as it is rebuilt on the physics side.
    
    Parameters:
    collisionShape - the CollisionShape to set
  - getCollisionShape
```
public CollisionShape getCollisionShape()
```
    Returns:
    the CollisionShape of this PhysicsNode, to be able to reuse it with other physics nodes (increases performance)
  - getCollisionGroup
```
public int getCollisionGroup()
```
    Returns the collision group for this collision shape
    
    Returns:
    The collision group
  - setCollisionGroup
```
public void setCollisionGroup(int collisionGroup)
```
    Sets the collision group number for this physics object.
    The groups are integer bit masks and some pre-made variables are available in CollisionObject. All physics objects are by default in COLLISION_GROUP_01.
    Two object will collide when one of the partys has the collisionGroup of the other in its collideWithGroups set.
    
    Parameters:
    collisionGroup - the collisionGroup to set
  - addCollideWithGroup
```
public void addCollideWithGroup(int collisionGroup)
```
    Add a group that this object will collide with.
    Two object will collide when one of the partys has the collisionGroup of the other in its collideWithGroups set.
    
    Parameters:
    collisionGroup -
  - removeCollideWithGroup
```
public void removeCollideWithGroup(int collisionGroup)
```
    Remove a group from the list this object collides with.
    
    Parameters:
    collisionGroup -
  - setCollideWithGroups
```
public void setCollideWithGroups(int collisionGroups)
```
    Directly set the bitmask for collision groups that this object collides with.
    
    Parameters:
    collisionGroups -
  - getCollideWithGroups
```
public int getCollideWithGroups()
```
    Gets the bitmask of collision groups that this object collides with.
    
    Returns:
    Collision groups mask
  - initUserPointer
```
protected void initUserPointer()
```
  - getUserObject
```
public java.lang.Object getUserObject()
```
    Returns:
    the userObject
  - setUserObject
```
public void setUserObject(java.lang.Object userObject)
```
    Parameters:
    userObject - the userObject to set
  - getObjectId
```
public long getObjectId()
```
  - attachCollisionShape
```
protected void attachCollisionShape(long objectId,
                        long collisionShapeId)
```
  - write
```
public void write(com.jme3.export.JmeExporter e)
           throws java.io.IOException
```
    Specified by:
    
    write in interface com.jme3.export.Savable
    
    Throws:
    
    java.io.IOException
  - read
```
public void read(com.jme3.export.JmeImporter e)
          throws java.io.IOException
```
    Specified by:
    
    read in interface com.jme3.export.Savable
    
    Throws:
    
    java.io.IOException
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.lang.Throwable
  - finalizeNative
```
protected void finalizeNative(long objectId)
```

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

getCollisionGroup

setCollisionGroup

addCollideWithGroup

removeCollideWithGroup

setCollideWithGroups

getCollideWithGroups

initUserPointer

getUserObject

setUserObject

getObjectId

attachCollisionShape

write

read

finalize

finalizeNative