com.ardor3d.math.Line3Base Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ardor3d-math
The newest version!
/**
 * Copyright (c) 2008-2012 Ardor Labs, Inc.
 *
 * This file is part of Ardor3D.
 *
 * Ardor3D is free software: you can redistribute it and/or modify it 
 * under the terms of its license which may be found in the accompanying
 * LICENSE file or at .
 */

package com.ardor3d.math;

import java.io.Externalizable;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;

import com.ardor3d.math.type.ReadOnlyVector3;
import com.ardor3d.util.export.InputCapsule;
import com.ardor3d.util.export.OutputCapsule;
import com.ardor3d.util.export.Savable;

public abstract class Line3Base implements Savable, Externalizable {

    protected final Vector3 _origin = new Vector3();
    protected final Vector3 _direction = new Vector3();

    public Line3Base(final ReadOnlyVector3 origin, final ReadOnlyVector3 direction) {
        _origin.set(origin);
        _direction.set(direction);
    }

    /**
     * @return this line's origin point as a readable vector
     */
    public ReadOnlyVector3 getOrigin() {
        return _origin;
    }

    /**
     * @return this line's direction as a readable vector
     */
    public ReadOnlyVector3 getDirection() {
        return _direction;
    }

    /**
     * Sets the line's origin point to the values of the given vector.
     * 
     * @param origin
     * @throws NullPointerException
     *             if normal is null.
     */
    public void setOrigin(final ReadOnlyVector3 origin) {
        _origin.set(origin);
    }

    /**
     * Sets the line's direction to the values of the given vector.
     * 
     * @param direction
     * @throws NullPointerException
     *             if direction is null.
     */
    public void setDirection(final ReadOnlyVector3 direction) {
        _direction.set(direction);
    }

    /**
     * @return returns a unique code for this line3base object based on its values. If two line3base objects are
     *         numerically equal, they will return the same hash code value.
     */
    @Override
    public int hashCode() {
        int result = 17;

        result += 31 * result + _origin.hashCode();
        result += 31 * result + _direction.hashCode();

        return result;
    }

    // /////////////////
    // Methods for Savable
    // /////////////////

    public Class getClassTag() {
        return this.getClass();
    }

    public void write(final OutputCapsule capsule) throws IOException {
        capsule.write(_origin, "origin", new Vector3(Vector3.ZERO));
        capsule.write(_direction, "direction", new Vector3(Vector3.UNIT_Z));
    }

    public void read(final InputCapsule capsule) throws IOException {
        _origin.set((Vector3) capsule.readSavable("origin", new Vector3(Vector3.ZERO)));
        _direction.set((Vector3) capsule.readSavable("direction", new Vector3(Vector3.UNIT_Z)));
    }

    // /////////////////
    // Methods for Externalizable
    // /////////////////

    /**
     * Used with serialization. Not to be called manually.
     * 
     * @param in
     *            ObjectInput
     * @throws IOException
     * @throws ClassNotFoundException
     */
    public void readExternal(final ObjectInput in) throws IOException, ClassNotFoundException {
        setOrigin((Vector3) in.readObject());
        setDirection((Vector3) in.readObject());
    }

    /**
     * Used with serialization. Not to be called manually.
     * 
     * @param out
     *            ObjectOutput
     * @throws IOException
     */
    public void writeExternal(final ObjectOutput out) throws IOException {
        out.writeObject(_origin);
        out.writeObject(_direction);
    }

}