package mightypork.utils.math.coord;


import mightypork.utils.math.constraints.NumberConstraint;
import mightypork.utils.math.constraints.VecConstraint;


/**
 * The most basic Vec methods
 * 
 * @author MightyPork
 */
public interface Vec extends VecConstraint {
	
	public static final VecView ZERO = new FixedCoord(0, 0, 0);
	public static final VecView ONE = new FixedCoord(1, 1, 1);
	
	
	/**
	 * @return X coordinate
	 */
	double x();
	
	
	/**
	 * @return Y coordinate
	 */
	double y();
	
	
	/**
	 * @return Z coordinate
	 */
	double z();
	
	
	/**
	 * @return X rounded
	 */
	int xi();
	
	
	/**
	 * @return Y rounded
	 */
	int yi();
	
	
	/**
	 * @return Z rounded
	 */
	int zi();
	
	
	/**
	 * @return X as float
	 */
	float xf();
	
	
	/**
	 * @return Y as float
	 */
	float yf();
	
	
	/**
	 * @return Z as float
	 */
	float zf();
	
	
	/**
	 * @return X constraint
	 */
	@Override
	NumberConstraint xc();
	
	
	/**
	 * @return Y constraint
	 */
	@Override
	NumberConstraint yc();
	
	
	/**
	 * @return Z constraint
	 */
	@Override
	NumberConstraint zc();
	
	
	/**
	 * Get a new mutable variable holding the current state
	 * 
	 * @return a mutable copy
	 */
	VecMutable copy();
	
	
	/**
	 * Get immutable view at this vec
	 * 
	 * @return immutable view
	 */
	VecView view();
	
}