com.jme3.bullet.collision.PhysicsCollisionObject Maven / Gradle / Ivy
Show all versions of jme3-bullet Show documentation
/*
* Copyright (c) 2009-2018 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* * Neither the name of 'jMonkeyEngine' nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.jme3.bullet.collision;
import com.jme3.bullet.collision.shapes.CollisionShape;
import com.jme3.export.*;
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* The abstract base class for collision objects based on Bullet's
* btCollisionObject.
*
* Collision objects include PhysicsCharacter, PhysicsRigidBody, and
* PhysicsGhostObject.
*
* @author normenhansen
*/
public abstract class PhysicsCollisionObject implements Savable {
/**
* 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.
*/
protected long objectId = 0;
/**
* shape associated with this object (not null)
*/
protected CollisionShape collisionShape;
/**
* collideWithGroups bitmask that represents "no groups"
*/
public static final int COLLISION_GROUP_NONE = 0x00000000;
/**
* collisionGroup/collideWithGroups bitmask that represents group #1
*/
public static final int COLLISION_GROUP_01 = 0x00000001;
/**
* collisionGroup/collideWithGroups bitmask that represents group #2
*/
public static final int COLLISION_GROUP_02 = 0x00000002;
/**
* collisionGroup/collideWithGroups bitmask that represents group #3
*/
public static final int COLLISION_GROUP_03 = 0x00000004;
/**
* collisionGroup/collideWithGroups bitmask that represents group #4
*/
public static final int COLLISION_GROUP_04 = 0x00000008;
/**
* collisionGroup/collideWithGroups bitmask that represents group #5
*/
public static final int COLLISION_GROUP_05 = 0x00000010;
/**
* collisionGroup/collideWithGroups bitmask that represents group #6
*/
public static final int COLLISION_GROUP_06 = 0x00000020;
/**
* collisionGroup/collideWithGroups bitmask that represents group #7
*/
public static final int COLLISION_GROUP_07 = 0x00000040;
/**
* collisionGroup/collideWithGroups bitmask that represents group #8
*/
public static final int COLLISION_GROUP_08 = 0x00000080;
/**
* collisionGroup/collideWithGroups bitmask that represents group #9
*/
public static final int COLLISION_GROUP_09 = 0x00000100;
/**
* collisionGroup/collideWithGroups bitmask that represents group #10
*/
public static final int COLLISION_GROUP_10 = 0x00000200;
/**
* collisionGroup/collideWithGroups bitmask that represents group #11
*/
public static final int COLLISION_GROUP_11 = 0x00000400;
/**
* collisionGroup/collideWithGroups bitmask that represents group #12
*/
public static final int COLLISION_GROUP_12 = 0x00000800;
/**
* collisionGroup/collideWithGroups bitmask that represents group #13
*/
public static final int COLLISION_GROUP_13 = 0x00001000;
/**
* collisionGroup/collideWithGroups bitmask that represents group #14
*/
public static final int COLLISION_GROUP_14 = 0x00002000;
/**
* collisionGroup/collideWithGroups bitmask that represents group #15
*/
public static final int COLLISION_GROUP_15 = 0x00004000;
/**
* collisionGroup/collideWithGroups bitmask that represents group #16
*/
public static final int COLLISION_GROUP_16 = 0x00008000;
/**
* collision group to which this physics object belongs (default=group #1)
*/
protected int collisionGroup = 0x00000001;
/**
* collision groups with which this object can collide (default=only group
* #1)
*/
protected int collisionGroupsMask = 0x00000001;
private Object userObject;
/**
* 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.
*
* @param collisionShape the shape to apply (not null, alias created)
*/
public void setCollisionShape(CollisionShape collisionShape) {
this.collisionShape = collisionShape;
}
/**
* Access the shape of this physics object.
*
* @return the pre-existing instance, which can then be applied to other
* physics objects (increases performance)
*/
public CollisionShape getCollisionShape() {
return collisionShape;
}
/**
* Read the collision group for this physics object.
*
* @return the collision group (bit mask with exactly one bit set)
*/
public int getCollisionGroup() {
return 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.
*
* @param collisionGroup the collisionGroup to apply (bit mask with exactly
* 1 bit set)
*/
public void setCollisionGroup(int collisionGroup) {
this.collisionGroup = collisionGroup;
if (objectId != 0) {
setCollisionGroup(objectId, 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.
*
* @param collisionGroup groups to add (bit mask)
*/
public void addCollideWithGroup(int collisionGroup) {
this.collisionGroupsMask = this.collisionGroupsMask | collisionGroup;
if (objectId != 0) {
setCollideWithGroups(objectId, this.collisionGroupsMask);
}
}
/**
* Remove collision groups from the set with which this object can collide.
*
* @param collisionGroup groups to remove, ORed together (bit mask)
*/
public void removeCollideWithGroup(int collisionGroup) {
this.collisionGroupsMask = this.collisionGroupsMask & ~collisionGroup;
if (objectId != 0) {
setCollideWithGroups(this.collisionGroupsMask);
}
}
/**
* Directly alter the collision groups with which this object can collide.
*
* @param collisionGroups desired groups, ORed together (bit mask)
*/
public void setCollideWithGroups(int collisionGroups) {
this.collisionGroupsMask = collisionGroups;
if (objectId != 0) {
setCollideWithGroups(objectId, this.collisionGroupsMask);
}
}
/**
* Read the set of collision groups with which this object can collide.
*
* @return bit mask
*/
public int getCollideWithGroups() {
return collisionGroupsMask;
}
/**
* Initialize the user pointer and collision-group information of this
* object.
*/
protected void initUserPointer() {
Logger.getLogger(this.getClass().getName()).log(Level.FINE, "initUserPointer() objectId = {0}", Long.toHexString(objectId));
initUserPointer(objectId, collisionGroup, collisionGroupsMask);
}
native void initUserPointer(long objectId, int group, int groups);
/**
* Access the user object associated with this collision object.
*
* @return the pre-existing instance, or null if none
*/
public Object getUserObject() {
return userObject;
}
/**
* Associate a user object (such as a Spatial) with this collision object.
*
* @param userObject the object to associate with this collision object
* (alias created, may be null)
*/
public void setUserObject(Object userObject) {
this.userObject = userObject;
}
/**
* Read the id of the btCollisionObject.
*
* @return the unique identifier (not zero)
*/
public long getObjectId(){
return objectId;
}
/**
* Attach the identified btCollisionShape to the identified
* btCollisionObject. Native method.
*
* @param objectId the unique identifier of the btCollisionObject (not zero)
* @param collisionShapeId the unique identifier of the btCollisionShape
* (not zero)
*/
protected native void attachCollisionShape(long objectId, long collisionShapeId);
native void setCollisionGroup(long objectId, int collisionGroup);
native void setCollideWithGroups(long objectId, int collisionGroups);
/**
* Serialize this object, for example when saving to a J3O file.
*
* @param e exporter (not null)
* @throws IOException from exporter
*/
@Override
public void write(JmeExporter e) throws IOException {
OutputCapsule capsule = e.getCapsule(this);
capsule.write(collisionGroup, "collisionGroup", 0x00000001);
capsule.write(collisionGroupsMask, "collisionGroupsMask", 0x00000001);
capsule.write(collisionShape, "collisionShape", null);
}
/**
* De-serialize this object, for example when loading from a J3O file.
*
* @param e importer (not null)
* @throws IOException from importer
*/
@Override
public void read(JmeImporter e) throws IOException {
InputCapsule capsule = e.getCapsule(this);
collisionGroup = capsule.readInt("collisionGroup", 0x00000001);
collisionGroupsMask = capsule.readInt("collisionGroupsMask", 0x00000001);
CollisionShape shape = (CollisionShape) capsule.readSavable("collisionShape", null);
collisionShape = shape;
}
/**
* Finalize this collision object just before it is destroyed. Should be
* invoked only by a subclass or by the garbage collector.
*
* @throws Throwable ignored by the garbage collector
*/
@Override
protected void finalize() throws Throwable {
super.finalize();
Logger.getLogger(this.getClass().getName()).log(Level.FINE, "Finalizing CollisionObject {0}", Long.toHexString(objectId));
finalizeNative(objectId);
}
/**
* Finalize the identified btCollisionObject. Native method.
*
* @param objectId the unique identifier of the btCollisionObject (not zero)
*/
protected native void finalizeNative(long objectId);
}