/*
 * Copyright (c) 2010 Stephen A. Pratt
 * 
 * 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 org.critterai.nmgen;

/**
 * A class used to hold intermediate and performance data related to building
 * the navigation mesh.
 * <p>
 * The entire build process is represented when this data is combined with the
 * source geometry and final navigation mesh.
 * </p>
 */
public final class IntermediateData {

    /*
     * Recast Reference: None
     */

    /**
     * The data is undefined. (Has not been set.)
     */
    public static final long UNDEFINED = -1;

    /**
     * The time to perform voxelization. (ns)
     */
    public long voxelizationTime;

    /**
     * The time to perform region generation. (ns)
     */
    public long regionGenTime;

    /**
     * The time to perform contour generation. (ns)
     */
    public long contourGenTime;

    /**
     * The time to perform polygon generation. (ns)
     */
    public long polyGenTime;

    /**
     * The time to perform the final triangulation. (ns)
     */
    public long finalMeshGenTime;

    private SolidHeightfield mSolidHeightfield;
    private OpenHeightfield mOpenHeightfield;
    private ContourSet mContours;
    private PolyMeshField mPolyMesh;

    /**
     * The contour set associated with the open heightfield.
     * 
     * @return The contours associated with the open heightfield.
     */
    public ContourSet contours() {
        return this.mContours;
    }

    /**
     * Returns the total time to generate the navigation mesh. (ns)
     * 
     * @return The total time to generate the navigation mesh. (ns)
     */
    public long getTotalGenTime() {
        if (this.finalMeshGenTime == UNDEFINED) {
            return UNDEFINED;
        }
        return this.voxelizationTime +
            this.regionGenTime +
            this.contourGenTime +
            this.polyGenTime +
            this.finalMeshGenTime;
    }

    /**
     * The open heightfield associated with the solid heightfield.
     * 
     * @return The open heightfield associated with the solid heightfield.
     */
    public OpenHeightfield openHeightfield() {
        return this.mOpenHeightfield;
    }

    /**
     * The polygon mesh associated with the contour set.
     * 
     * @return The polygon mesh associated with the contour set.
     */
    public PolyMeshField polyMesh() {
        return this.mPolyMesh;
    }

    /**
     * Resets all data to null.
     */
    public void reset() {
        this.voxelizationTime = UNDEFINED;
        this.regionGenTime = UNDEFINED;
        this.contourGenTime = UNDEFINED;
        this.polyGenTime = UNDEFINED;
        this.finalMeshGenTime = UNDEFINED;
        this.mSolidHeightfield = null;
        this.mOpenHeightfield = null;
        this.mContours = null;
        this.mPolyMesh = null;
    }

    /**
     * Sets the contour set.
     * 
     * @param contours
     *        The contour set.
     */
    public void setContours(final ContourSet contours) {
        this.mContours = contours;
    }

    /**
     * Sets the open heightfield.
     * 
     * @param field
     *        The open heightfield.
     */
    public void setOpenHeightfield(final OpenHeightfield field) {
        this.mOpenHeightfield = field;
    }

    /**
     * Sets the polygon mesh.
     * 
     * @param mesh
     *        The polygon mesh.
     */
    public void setPolyMesh(final PolyMeshField mesh) {
        this.mPolyMesh = mesh;
    }

    /**
     * Sets the solid height field.
     * 
     * @param field
     *        The solid heightfield.
     */
    public void setSolidHeightfield(final SolidHeightfield field) {
        this.mSolidHeightfield = field;
    }

    /**
     * The solid heightfield associated with the source geometry.
     * 
     * @return The solid heightfield derived from the source geometry.
     */
    public SolidHeightfield solidHeightfield() {
        return this.mSolidHeightfield;
    }
}