Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/riccardobl/jme3-bullet-vhacd
This is a library that uses java bindings for Khaled Mamou's V-HACD to decompose concave meshes into hull-shapes in jmonkey engine.
https://github.com/riccardobl/jme3-bullet-vhacd
bullet java jmonkeyengine3 vhacd
Last synced: 2 days ago
JSON representation
This is a library that uses java bindings for Khaled Mamou's V-HACD to decompose concave meshes into hull-shapes in jmonkey engine.
- Host: GitHub
- URL: https://github.com/riccardobl/jme3-bullet-vhacd
- Owner: riccardobl
- License: other
- Created: 2016-05-04T12:50:55.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-09-04T06:54:20.000Z (4 months ago)
- Last Synced: 2024-10-06T05:21:43.572Z (3 months ago)
- Topics: bullet, java, jmonkeyengine3, vhacd
- Language: Java
- Homepage: https://jmonkeystore.com/b23bd74f-e315-4c3b-b66c-b090d9232356
- Size: 28.3 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JME3 V-HACD Collision Shape Factory
This is a library that uses [java bindings](https://github.com/riccardobl/v-hacd-java-bindings) for [Khaled Mamou's V-HACD](https://github.com/kmammou/v-hacd) to decompose concave meshes into hull-shapes in jmonkey engine.
# Requirements
java 1.7+
# Installation
## Gradle
```gradle
plugins {
id "io.github.0ffz.github-packages" version "1.2.1"
}
repositories {
mavenCentral()
maven githubPackage.invoke("riccardobl")
}
dependencies {
compile 'wf.frk:jme3-bullet-vhacd:1.0.5'
}
```
____
This library relies on vhacd native bindings whose build is currently available for 64 and 32 bit versions of Linux and Windows and for osx.
# Usage
```java
VHACDParameters p=new VHACDParameters();
// p.set.....
VHACDCollisionShapeFactory factory=new VHACDCollisionShapeFactory(p);
CompoundCollisionShape cs=factory.create(Spatial);
```
The resulting CollisionShape can be used and serialized as a usual. See `TestSimple.java` and `TestFunny.java` for the full example.
___________
The process of building collision shapes could be quite slow, to overcome this you can use one of the following approaches
## Pregeneration and serialization
The generated shape is a common `CompoundCollisionShape` made of `HullCollisionShape`s this means it can be [saved and loaded with jmonkeyengine](https://wiki.jmonkeyengine.org/doku.php/jme3:advanced:save_and_load).
This method has a further benefit: the shape can be generated by the developer and then loaded withing a project that doesn't need to include this library.
This comes quite handy when you are targeting platforms that are not supported by this library.
## Caching
The library can also do transparent caching.
To do this, you just need to add an implementation of `Caching` to the `VHACDCollisionShapeFactory` with
```java
((VHACDCollisionShapeFactory)factory).cachingQueue().add(Caching)
```
Multiple Caching systems can be added to the queue, when one fails to provide the cache, the next one is used.
There are few built-in Caching implementations:
## VolatileByMeshCaching
This provides a minimal in-memory caching based on mesh objects.
With this, when you call `VHACDCollisionShapeFactory.create` on a mesh or spatial for which the collision shape has already been generated with the same parameters, a cached version may be returned.
The shapes leave the cache when their original mesh has been GCed or when the application is restarted.
```java
((VHACDCollisionShapeFactory)factory).cachingQueue().add(new VolatileByMeshCaching());
```
## PersistentByBuffersCaching
This is a more advanced system that provides persistent caching on memory and disk, based on the content of the the original mesh.
It must be create by passing the path of the cache folder to the constructor
```java
PersistentByBuffersCaching caching=new PersistentByBuffersCaching("app/cache/");
((VHACDCollisionShapeFactory)factory).cachingQueue().add(caching);
```
(The `/` will be automatically replaced with the `File.separator`)
You can optionally set an indicative maximum ammount of memory that can be used for the in-memory caching with:
```java
caching.setMaxMemoryInMB(10);
```
By default the limit is 32MB. A negative number means *unlimited* and *0* means "no in-memory cache (= cache provided always from the disk)".
The cache will be swapped from disk to memory automatically and will be kept across executions, installations and can also be shipped with the software.
# License
Everything in this repo, as well as V-HACD and V-HACD-bindings, is released under BSD 3-clause license.