/*
 * Copyright (c) 2009-2012 jMonkeyEngine
 * 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 'jMonkeyEngine' 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 OWNER 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 com.jme3.terrain.geomipmap.picking;

import com.jme3.collision.CollisionResult;
import com.jme3.terrain.geomipmap.TerrainPatch;

/**
 * Pick result on a terrain patch with the intersection on the bounding box
 * of that terrain patch.
 *
 * @author Brent Owens
 */
public class TerrainPickData implements Comparable {

    protected TerrainPatch targetPatch;
    protected CollisionResult cr;

    public TerrainPickData() {
    }

    public TerrainPickData(TerrainPatch patch, CollisionResult cr) {
        this.targetPatch = patch;
        this.cr = cr;
    }

    public int compareTo(Object o) {
        if (o instanceof TerrainPickData) {
            TerrainPickData tpd = (TerrainPickData) o;
            if (this.cr.getDistance() < tpd.cr.getDistance())
                return -1;
            else if (this.cr.getDistance() == tpd.cr.getDistance())
                return 0;
            else
                return 1;
        }

        return 0;
    }

    @Override
    public boolean equals(Object obj) {
        if(obj instanceof TerrainPickData){
            return ((TerrainPickData)obj).compareTo(this) == 0;
        }
        return super.equals(obj);
    }
    
}
