com.redtoorange.game.components.physics.PhysicsComponent.java Source code

Introduction

Here is the source code for com.redtoorange.game.components.physics.PhysicsComponent.java

Source

/*
 * Copyright 2017  Andrew James McGuiness
 *
 * 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 com.redtoorange.game.components.physics;

import com.badlogic.gdx.math.Vector2;
import com.badlogic.gdx.physics.box2d.Body;
import com.redtoorange.game.components.Component;
import com.redtoorange.game.systems.Global;
import com.redtoorange.game.systems.PhysicsSystem;

/**
 * PhysicsComponent.java - Generic Physics component that is used by all GameObjects that require physical interaction
 * with the world or each-other.
 *
 * @author Andrew McGuiness
 * @version 20/Apr/2017
 */
public abstract class PhysicsComponent extends Component {
    /** The body of this gameObject. */
    protected Body body;
    /** The state's physicsSystem. */
    protected PhysicsSystem physicsSystem;
    /** How fast will this body move. */
    protected float speed;

    /** @param physicsSystem The current state's physicsSystem. */
    public PhysicsComponent(PhysicsSystem physicsSystem) {
        this.physicsSystem = physicsSystem;
    }

    /** @return The center position of the Box2D Body attached to this Component. */
    public Vector2 getBodyPosition() {
        Vector2 position = new Vector2();

        if (body != null)
            position.set(body.getPosition());

        return position;
    }

    /** Destroys this body from from the physicsSystem. */
    public void destroy() {
        if (body != null && physicsSystem != null) {
            physicsSystem.destroyBody(body);
            body = null;
        }
    }

    /** Destroy this body. */
    @Override
    public void dispose() {
        destroy();

        if (Global.DEBUG)
            System.out.println(this.getClass().getSimpleName() + " disposed");
    }
}