/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2019, 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 Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2019 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_GE_LINE_2D_H
#define OD_GE_LINE_2D_H /*!DOM*/

#include "Ge/GeLinearEnt2d.h"

#include "TD_PackPush.h"

/** \details
    This class represents infinite lines in 2D space.

    Corresponding C++ library: TD_Ge

    <group OdGe_Classes> 

    \sa
    <link ge_OdGeLine.html, Working with Lines>
*/
class GE_TOOLKIT_EXPORT OdGeLine2d : public OdGeLinearEnt2d
{
public:
  

  /** \details
    Default constructor for the OdGeLine2d class.

    \remarks
    Constructs an infinite line coincident with the X-axis.
  */
  OdGeLine2d();
  
  /** \details
    Copy constructor for the OdGeLine2d class.
    
    \param source [in]  A 2D line to be copied.
  */
  OdGeLine2d(
    const OdGeLine2d& source);
  
  /** \details
    Constructor for the OdGeLine2d class.
    
    \param point [in]  A 2D point on a line.
    \param vect [in]  Defines the direction of the line.
    
    \remarks
    Constructs an infinite line coincident with the passed vector direction.
    Vector must have non-zero length.
  */
  OdGeLine2d(
    const OdGePoint2d& point, 
    const OdGeVector2d& vect);
  
  /** \details
    Constructor for the OdGeLine2d class.
    
    \param point1 [in]  First point of the 2D line.
    \param point2 [in]  Second point of the 2D line.
    
    \remarks
    Constructs an infinite line that passes through the first and second points.
    The passed points should not be coincident.
  */
  OdGeLine2d(
    const OdGePoint2d& point1, 
    const OdGePoint2d& point2);

  GE_STATIC_EXPORT static const OdGeLine2d kXAxis; // X-axis *line*.
  GE_STATIC_EXPORT static const OdGeLine2d kYAxis; // Y-axis *line*.

  /** \details
    Sets the parameters for this line according to the arguments, and returns a reference to this line.

    \param point [in]  A 2D point on a line.
    \param vect [in]  Defines the direction of the line.

    \remarks
    point and vect construct an infinite line passing through point with 
    a direction of vect. vect cannot have a zero length.
  */
  OdGeLine2d& set(
    const OdGePoint2d& point, 
    const OdGeVector2d& vect);

  /** \details
    Sets the parameters for this line according to the arguments, and returns a reference to this line.

    \param point1 [in]  First 2D point that is used to construct an infinite line.
    \param point2 [in]  Second 2D point that is used to construct an infinite line.

    \remarks
    point1 and point2 construct an infinite line passing through both points. The 
    points should no be coincident.
  */
  OdGeLine2d& set(
    const OdGePoint2d& point1, 
    const OdGePoint2d& point2);

  /** \details
    Assignment operator for the OdGeLine2d object.
  */
  OdGeLine2d& operator =(const OdGeLine2d& line);
//DOM-IGNORE-BEGIN
private:
  OdGeLine2d(OdGeEntity2dImpl*);
//DOM-IGNORE-END
};

#include "TD_PackPop.h"

#endif // OD_GE_LINE_2D_H