/*
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2011-2014, Willow Garage, Inc.
 *  Copyright (c) 2014-2015, Open Source Robotics Foundation
 *  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 Open Source Robotics Foundation 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.
 */

/** \author Jia Pan */

#ifndef COAL_BVH_INTERNAL_H
#define COAL_BVH_INTERNAL_H

#include "coal/data_types.h"

namespace coal {

/// @brief States for BVH construction
/// empty->begun->processed ->replace_begun->processed -> ......
///                        |
///                        |-> update_begun -> updated -> .....
enum BVHBuildState {
  BVH_BUILD_STATE_EMPTY,      /// empty state, immediately after constructor
  BVH_BUILD_STATE_BEGUN,      /// after beginModel(), state for adding geometry
                              /// primitives
  BVH_BUILD_STATE_PROCESSED,  /// after tree has been build, ready for cd use
  BVH_BUILD_STATE_UPDATE_BEGUN,  /// after beginUpdateModel(), state for
                                 /// updating geometry primitives
  BVH_BUILD_STATE_UPDATED,  /// after tree has been build for updated geometry,
                            /// ready for ccd use
  BVH_BUILD_STATE_REPLACE_BEGUN  /// after beginReplaceModel(), state for
                                 /// replacing geometry primitives
};

/// @brief Error code for BVH
enum BVHReturnCode {
  BVH_OK = 0,  /// BVH is valid
  BVH_ERR_MODEL_OUT_OF_MEMORY =
      -1,  /// Cannot allocate memory for vertices and triangles
  BVH_ERR_BUILD_OUT_OF_SEQUENCE =
      -2,  /// BVH construction does not follow correct sequence
  BVH_ERR_BUILD_EMPTY_MODEL = -3,  /// BVH geometry is not prepared
  BVH_ERR_BUILD_EMPTY_PREVIOUS_FRAME =
      -4,  /// BVH geometry in previous frame is not prepared
  BVH_ERR_UNSUPPORTED_FUNCTION = -5,  /// BVH funtion is not supported
  BVH_ERR_UNUPDATED_MODEL = -6,       /// BVH model update failed
  BVH_ERR_INCORRECT_DATA = -7,        /// BVH data is not valid
  BVH_ERR_UNKNOWN = -8                /// Unknown failure
};

/// @brief BVH model type
enum BVHModelType {
  BVH_MODEL_UNKNOWN,    /// @brief unknown model type
  BVH_MODEL_TRIANGLES,  /// @brief triangle model
  BVH_MODEL_POINTCLOUD  /// @brief point cloud model
};

}  // namespace coal

#endif
