be.yildizgames.module.physics.bullet.shape.BulletShapeProvider Maven / Gradle / Ivy

Go to download
/*
 * This file is part of the Yildiz-Engine project, licenced under the MIT License  (MIT)
 *
 *  Copyright (c) 2018 Grégory Van den Borre
 *
 *  More infos available: https://www.yildiz-games.be
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 *  documentation files (the "Software"), to deal in the Software without restriction, including without
 *  limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 *  of the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all copies or substantial
 *  portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 *  WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
 *  OR COPYRIGHT  HOLDERS BE LIABLE FOR ANY CLAIM,
 *  DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE  SOFTWARE.
 *
 */

package be.yildizgames.module.physics.bullet.shape;

import be.yildizgames.common.jni.NativePointer;
import be.yildizgames.common.shape.Box;
import be.yildizgames.common.shape.Plane;
import be.yildizgames.common.shape.Sphere;
import be.yildizgames.module.physics.PhysicMesh;

/**
 * @author Grégory Van den Borre
 */
public interface BulletShapeProvider {

    /**
     * Get the pointer to the btshape associated with this box.
     *
     * @param box Shape representation.
     * @return The pointer to the physique shape matching the Box.
     */
    NativePointer getShape(Box box);

    /**
     * Get the pointer to the btshape associated with this sphere.
     *
     * @param sphere Shape representation.
     * @return The pointer to the physique shape matching the Sphere.
     */
    NativePointer getShape(Sphere sphere);

    /**
     * Get the pointer to the btshape associated with this plane.
     *
     * @param plane Shape representation.
     * @return The pointer to the physique shape matching the Plane.
     */
    NativePointer getShape(Plane plane);

    /**
     * Get the pointer to the btshape associated with this mesh.
     *
     * @param mesh Shape representation.
     * @return The pointer to the physique shape matching the PhysicMesh.
     */
    NativePointer getShape(PhysicMesh mesh);

}