PhysicsCollisionEvent (jMonkeyEngine3)

java.lang.Object
- java.util.EventObject
- - com.jme3.bullet.collision.PhysicsCollisionEvent

All Implemented Interfaces:

java.io.Serializable
```
public class PhysicsCollisionEvent
extends java.util.EventObject
```
Describe a collision in the physics world.
Do not retain this object, as it will be reused after the collision() method returns. Copy any data you need during the collide() method.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`TYPE_ADDED` type value to indicate a new event
`static int`	`TYPE_DESTROYED` type value to indicate a cleaned/destroyed event
`static int`	`TYPE_PROCESSED` type value to indicate an event that has been added to a PhysicsSpace queue

Fields inherited from class java.util.EventObject
source

Constructor Summary

Constructors
Constructor and Description
`PhysicsCollisionEvent(int type, PhysicsCollisionObject nodeA, PhysicsCollisionObject nodeB, long manifoldPointObjectId)` Instantiate a collision event.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clean()` Destroy this event.
`float`	`getAppliedImpulse()` Read the collision's applied impulse.
`float`	`getAppliedImpulseLateral1()` Read the collision's applied lateral impulse #1.
`float`	`getAppliedImpulseLateral2()` Read the collision's applied lateral impulse #2.
`float`	`getCombinedFriction()` Read the collision's combined friction.
`float`	`getCombinedRestitution()` Read the collision's combined restitution.
`float`	`getDistance1()` Read the collision's distance #1.
`int`	`getIndex0()` Read the collision's index 0.
`int`	`getIndex1()` Read the collision's index 1.
`Vector3f`	`getLateralFrictionDir1()` Copy the collision's lateral friction direction #1.
`Vector3f`	`getLateralFrictionDir1(Vector3f lateralFrictionDir1)` Copy the collision's lateral friction direction #1.
`Vector3f`	`getLateralFrictionDir2()` Copy the collision's lateral friction direction #2.
`Vector3f`	`getLateralFrictionDir2(Vector3f lateralFrictionDir2)` Copy the collision's lateral friction direction #2.
`int`	`getLifeTime()` Read the collision's lifetime.
`Vector3f`	`getLocalPointA()` Copy the collision's location in the local coordinates of object A.
`Vector3f`	`getLocalPointA(Vector3f localPointA)` Copy the collision's location in the local coordinates of object A.
`Vector3f`	`getLocalPointB()` Copy the collision's location in the local coordinates of object B.
`Vector3f`	`getLocalPointB(Vector3f localPointB)` Copy the collision's location in the local coordinates of object B.
`Spatial`	`getNodeA()` Access the user object of collision object A, provided it's a Spatial.
`Spatial`	`getNodeB()` Access the user object of collision object B, provided it's a Spatial.
`Vector3f`	`getNormalWorldOnB()` Copy the collision's normal on object B.
`Vector3f`	`getNormalWorldOnB(Vector3f normalWorldOnB)` Copy the collision's normal on object B.
`PhysicsCollisionObject`	`getObjectA()` Access collision object A.
`PhysicsCollisionObject`	`getObjectB()` Access collision object B.
`int`	`getPartId0()` Read part identifier 0.
`int`	`getPartId1()` Read part identifier 1.
`Vector3f`	`getPositionWorldOnA()` Copy the collision's location.
`Vector3f`	`getPositionWorldOnA(Vector3f positionWorldOnA)` Copy the collision's location.
`Vector3f`	`getPositionWorldOnB()` Copy the collision's location.
`Vector3f`	`getPositionWorldOnB(Vector3f positionWorldOnB)` Copy the collision's location.
`int`	`getType()` Read the type of event.
`boolean`	`isLateralFrictionInitialized()` Test whether the collision's lateral friction is initialized.
`void`	`refactor(int type, PhysicsCollisionObject source, PhysicsCollisionObject nodeB, long manifoldPointObjectId)` Reuse this event.

Methods inherited from class java.util.EventObject
getSource, toString

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

- Field Detail
  - TYPE_ADDED
```
public static final int TYPE_ADDED
```
    type value to indicate a new event
    
    See Also:
    
    Constant Field Values
  - TYPE_PROCESSED
```
public static final int TYPE_PROCESSED
```
    type value to indicate an event that has been added to a PhysicsSpace queue
    
    See Also:
    
    Constant Field Values
  - TYPE_DESTROYED
```
public static final int TYPE_DESTROYED
```
    type value to indicate a cleaned/destroyed event
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PhysicsCollisionEvent
```
public PhysicsCollisionEvent(int type,
                             PhysicsCollisionObject nodeA,
                             PhysicsCollisionObject nodeB,
                             long manifoldPointObjectId)
```
    Instantiate a collision event.
    
    Parameters:
    
    type - event type (0=added/1=processed/2=destroyed)
    
    nodeA - 1st involved object (alias created)
    
    nodeB - 2nd involved object (alias created)
    
    manifoldPointObjectId - Bullet identifier of the btManifoldPoint
- Method Detail
  - clean
```
public void clean()
```
    Destroy this event.
  - refactor
```
public void refactor(int type,
                     PhysicsCollisionObject source,
                     PhysicsCollisionObject nodeB,
                     long manifoldPointObjectId)
```
    Reuse this event.
    
    Parameters:
    
    type - event type (added/processed/destroyed)
    
    source - 1st involved object (alias created)
    
    nodeB - 2nd involved object (alias created)
    
    manifoldPointObjectId - Bullet identifier
  - getType
```
public int getType()
```
    Read the type of event.
    
    Returns:
    
    added/processed/destroyed
  - getNodeA
```
public Spatial getNodeA()
```
    Access the user object of collision object A, provided it's a Spatial.
    
    Returns:
    
    the pre-existing Spatial, or null if none
  - getNodeB
```
public Spatial getNodeB()
```
    Access the user object of collision object B, provided it's a Spatial.
    
    Returns:
    
    the pre-existing Spatial, or null if none
  - getObjectA
```
public PhysicsCollisionObject getObjectA()
```
    Access collision object A.
    
    Returns:
    
    the pre-existing object (not null)
  - getObjectB
```
public PhysicsCollisionObject getObjectB()
```
    Access collision object B.
    
    Returns:
    
    the pre-existing object (not null)
  - getAppliedImpulse
```
public float getAppliedImpulse()
```
    Read the collision's applied impulse.
    
    Returns:
    
    impulse
  - getAppliedImpulseLateral1
```
public float getAppliedImpulseLateral1()
```
    Read the collision's applied lateral impulse #1.
    
    Returns:
    
    impulse
  - getAppliedImpulseLateral2
```
public float getAppliedImpulseLateral2()
```
    Read the collision's applied lateral impulse #2.
    
    Returns:
    
    impulse
  - getCombinedFriction
```
public float getCombinedFriction()
```
    Read the collision's combined friction.
    
    Returns:
    
    friction
  - getCombinedRestitution
```
public float getCombinedRestitution()
```
    Read the collision's combined restitution.
    
    Returns:
    
    restitution
  - getDistance1
```
public float getDistance1()
```
    Read the collision's distance #1.
    
    Returns:
    
    distance
  - getIndex0
```
public int getIndex0()
```
    Read the collision's index 0.
    
    Returns:
    
    index
  - getIndex1
```
public int getIndex1()
```
    Read the collision's index 1.
    
    Returns:
    
    index
  - getLateralFrictionDir1
```
public Vector3f getLateralFrictionDir1()
```
    Copy the collision's lateral friction direction #1.
    
    Returns:
    
    a new vector (not null)
  - getLateralFrictionDir1
```
public Vector3f getLateralFrictionDir1(Vector3f lateralFrictionDir1)
```
    Copy the collision's lateral friction direction #1.
    
    Parameters:
    
    lateralFrictionDir1 - storage for the result (not null, modified)
    
    Returns:
    
    direction vector (not null)
  - getLateralFrictionDir2
```
public Vector3f getLateralFrictionDir2()
```
    Copy the collision's lateral friction direction #2.
    
    Returns:
    
    a new vector
  - getLateralFrictionDir2
```
public Vector3f getLateralFrictionDir2(Vector3f lateralFrictionDir2)
```
    Copy the collision's lateral friction direction #2.
    
    Parameters:
    
    lateralFrictionDir2 - storage for the result (not null, modified)
    
    Returns:
    
    direction vector (not null)
  - isLateralFrictionInitialized
```
public boolean isLateralFrictionInitialized()
```
    Test whether the collision's lateral friction is initialized.
    
    Returns:
    
    true if initialized, otherwise false
  - getLifeTime
```
public int getLifeTime()
```
    Read the collision's lifetime.
    
    Returns:
    
    lifetime
  - getLocalPointA
```
public Vector3f getLocalPointA()
```
    Copy the collision's location in the local coordinates of object A.
    
    Returns:
    
    a new location vector (in local coordinates, not null)
  - getLocalPointA
```
public Vector3f getLocalPointA(Vector3f localPointA)
```
    Copy the collision's location in the local coordinates of object A.
    
    Parameters:
    
    localPointA - storage for the result (not null, modified)
    
    Returns:
    
    a location vector (in local coordinates, not null)
  - getLocalPointB
```
public Vector3f getLocalPointB()
```
    Copy the collision's location in the local coordinates of object B.
    
    Returns:
    
    a new location vector (in local coordinates, not null)
  - getLocalPointB
```
public Vector3f getLocalPointB(Vector3f localPointB)
```
    Copy the collision's location in the local coordinates of object B.
    
    Parameters:
    
    localPointB - storage for the result (not null, modified)
    
    Returns:
    
    a location vector (in local coordinates, not null)
  - getNormalWorldOnB
```
public Vector3f getNormalWorldOnB()
```
    Copy the collision's normal on object B.
    
    Returns:
    
    a new normal vector (in physics-space coordinates, not null)
  - getNormalWorldOnB
```
public Vector3f getNormalWorldOnB(Vector3f normalWorldOnB)
```
    Copy the collision's normal on object B.
    
    Parameters:
    
    normalWorldOnB - storage for the result (not null, modified)
    
    Returns:
    
    a normal vector (in physics-space coordinates, not null)
  - getPartId0
```
public int getPartId0()
```
    Read part identifier 0.
    
    Returns:
    
    identifier
  - getPartId1
```
public int getPartId1()
```
    Read part identifier 1.
    
    Returns:
    
    identifier
  - getPositionWorldOnA
```
public Vector3f getPositionWorldOnA()
```
    Copy the collision's location.
    
    Returns:
    
    a new vector (in physics-space coordinates, not null)
  - getPositionWorldOnA
```
public Vector3f getPositionWorldOnA(Vector3f positionWorldOnA)
```
    Copy the collision's location.
    
    Parameters:
    
    positionWorldOnA - storage for the result (not null, modified)
    
    Returns:
    
    a location vector (in physics-space coordinates, not null)
  - getPositionWorldOnB
```
public Vector3f getPositionWorldOnB()
```
    Copy the collision's location.
    
    Returns:
    
    a new location vector (in physics-space coordinates, not null)
  - getPositionWorldOnB
```
public Vector3f getPositionWorldOnB(Vector3f positionWorldOnB)
```
    Copy the collision's location.
    
    Parameters:
    
    positionWorldOnB - storage for the result (not null, modified)
    
    Returns:
    
    a location vector (in physics-space coordinates, not null)

Class PhysicsCollisionEvent

Field Summary

Fields inherited from class java.util.EventObject

Constructor Summary

Method Summary

Methods inherited from class java.util.EventObject

Methods inherited from class java.lang.Object

Field Detail

TYPE_ADDED

TYPE_PROCESSED

TYPE_DESTROYED

Constructor Detail

PhysicsCollisionEvent

Method Detail

clean

refactor

getType

getNodeA

getNodeB

getObjectA

getObjectB

getAppliedImpulse

getAppliedImpulseLateral1

getAppliedImpulseLateral2

getCombinedFriction

getCombinedRestitution

getDistance1

getIndex0

getIndex1

getLateralFrictionDir1

getLateralFrictionDir1

getLateralFrictionDir2

getLateralFrictionDir2

isLateralFrictionInitialized

getLifeTime

getLocalPointA

getLocalPointA

getLocalPointB

getLocalPointB

getNormalWorldOnB

getNormalWorldOnB

getPartId0

getPartId1

getPositionWorldOnA

getPositionWorldOnA

getPositionWorldOnB

getPositionWorldOnB