org.dyn4j.dynamics.Torque Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dyn4j Show documentation
Java Collision Detection and Physics Engine
There is a newer version: 5.0.2
/*
 * Copyright (c) 2010-2022 William Bittle  http://www.dyn4j.org/
 * 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 the copyright holder 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 HOLDER 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 org.dyn4j.dynamics;

import org.dyn4j.exception.ArgumentNullException;

/**
 * Represents a torque about the z-axis.
 * @author William Bittle
 * @version 5.0.0
 * @since 1.0.0
 */
public class Torque {
	/** The point where the {@link Force} is applied in world coordinates */
	protected double torque;
	
	/**
	 * Default constructor.
	 * @since 1.0.2
	 */
	public Torque() {
		this.torque = 0.0;
	}
	
	/**
	 * Creates a {@link Torque} using specified torque value.
	 * @param torque the torque
	 */
	public Torque(double torque) {
		this.torque = torque;
	}
	
	/**
	 * Copy constructor.
	 * @param torque the {@link Torque} to copy
	 * @throws NullPointerException if torque is null
	 */
	public Torque(Torque torque) {
		if (torque == null) 
			throw new ArgumentNullException("torque");
		
		this.torque = torque.torque;
	}
	
	/**
	 * Sets this {@link Torque} to the given torque value.
	 * @param torque the torque
	 */
	public void set(double torque) {
		this.torque = torque;
	}
	
	/**
	 * Sets this {@link Torque} to the given {@link Torque}.
	 * @param torque the {@link Torque} to copy
	 * @throws NullPointerException if torque is null
	 */
	public void set(Torque torque) {
		if (torque == null) 
			throw new ArgumentNullException("torque");
		
		this.torque = torque.torque;
	}
	
	/**
	 * Returns true if this torque should be removed.
	 * 
	 * Implement this method to create {@link Torque} objects
	 * that are not cleared during the accumulation step.
	 * 
	 * The default implementation always returns true.
	 * @param elapsedTime the elapsed time since the last call to this method
	 * @return boolean true if this torque should be removed
	 * @since 3.1.0
	 */
	public boolean isComplete(double elapsedTime) {
		return true;
	}
	
	/* (non-Javadoc)
	 * @see org.dyn4j.dynamics.Force#toString()
	 */
	@Override
	public String toString() {
		return String.valueOf(this.torque);
	}
	
	/**
	 * Returns the torque value.
	 * @return double
	 */
	public double getTorque() {
		return this.torque;
	}
}