be.yildizgames.module.physics.PhysicMesh Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of module-physics Show documentation

Module handling the physics engine.

The newest version!

/*
 * This file is part of the Yildiz-Engine project, licenced under the MIT License  (MIT)
 *
 *  Copyright (c) 2019 Grégory Van den Borre
 *
 *  More infos available: https://engine.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;

import java.util.Objects;

/**
 * Contains the data for a physic mesh file.
 *
 * @author Grégory Van den Borre
 */
public final class PhysicMesh {

    /**
     * Mesh file path.
     */
    public final String file;

    /**
     * Build a PhysicMesh object from a file path.
     *
     * @param path Path and name of the mesh to use.
     * @throws NullPointerException If path is null.
     */
    //@Ensures this.file == path
    public PhysicMesh(final String path) {
        super();
        this.file = Objects.requireNonNull(path);
    }

    /**
     * @return The file name and the material.
     */
    @Override
    public String toString() {
        return "Physic mesh:" + this.file;
    }

}