/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2016, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2016 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////


#ifndef OD_GETOL_H
#define OD_GETOL_H /*!DOM*/

#include "Ge/GeExport.h"

#include "TD_PackPush.h"

/** \details
  This class represents tolerances for vectors or points coincidence.  
  For evaluating points and vectors OdGeTol stores the equalPoint and equalVector values which are used as follows:
  1. Two points, p1 and p2, are equal if (p1 - p2).length() <= equalPoint.
  2. Two vectors, v1 and v2, are equal if (v1 - v2).length() <= equalVector.
  3. Two vectors, v1 and v2, are parallel if v1/v1.length() - v2/v2.length()).length() < equalVector OR (v1/v1.length() + v2/v2.length()).length() < equalVector.
  4. Two vectors, v1 and v2, are perpendicular if abs((v1.dotProduct(v2))/(v1.length()*v2.length())) <= equalVector.
  5. Two lines or rays are parallel (or perpendicular) if their directional vectors are parallel (or perpendicular).
    
    Library: TD_Ge

    <group OdGe_Classes>

    \sa
    <link ge_OdGeTol.html, Working with Tolerances>
*/
class GE_TOOLKIT_EXPORT OdGeTol
{
public:

  /** \param t [in]  The tolerance for vectors and points evaluation.
    \param t1 [in]  The tolerance for points evaluation.
    \param t2 [in]  The tolerance for vectors evaluation.
  */
  OdGeTol(double t = 1.e-10) 
    : m_vectorTol(t), m_pointTol(t)
  {
  }
  OdGeTol(double t1, double t2) 
    : m_vectorTol(t2), m_pointTol(t1)
  {
  }

  /** \details
    Returns the equalPoint tolerance.
  */
  double equalPoint() const 
  { 
    return m_pointTol; 
  }

  /** \details
    Returns the equalVector tolerance.
  */
  double equalVector() const 
  { 
    return m_vectorTol;
  }

  /** \details
    Sets the equalPoint tolerance to a specified value.
    
    \param val [in]  equalPoint value to be set.
  */
  void setEqualPoint(double val)
  { 
    m_pointTol = val; 
  }

  /** \details
    Sets the equalVector tolerance to a specified value.
    
    \param val [in]  equalVector tolerance to be set.
  */
  void setEqualVector(double val) 
  {
    m_vectorTol = val; 
  }

private:
  double m_vectorTol;
  double m_pointTol;
};

#include "TD_PackPop.h"

#endif