/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2025, 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-2025 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_GEVEC2D_H
#define OD_GEVEC2D_H /*!DOM*/

#include "Ge/GeGbl.h"

#include "TD_PackPush.h"

class OdGeMatrix2d;
class OdGePoint2d;

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

    \remarks
    OdGeVector2d may be viewed as an array[2] of doubles.

    Corresponding C++ library: TD_Ge

    <group OdGe_Classes>

    \sa
    <link ge_BasicTypes, Working with Basic Geometry Types>
*/
class GE_TOOLKIT_EXPORT OdGeVector2d
{
public:

  /** \details 
    Default constructor for the OdGeVector2d class.
    
    \remarks
    Constructs a zero-length 2D vector.
  */
  OdGeVector2d() : x(0.0), y(0.0) {}
  
  /** \details 
    Constructor for the OdGeVector2d class.
    
    \param xx [in]  X-coordinate.
    \param yy [in]  Y-coordinate.
    
    \remarks
    Constructs a 2D vector with specified X and Y coordinates.
  */
  OdGeVector2d(
    double xx, 
    double yy) : x(xx), y(yy) {}

  GE_STATIC_EXPORT static const OdGeVector2d kIdentity; // Additive identity vector.
  GE_STATIC_EXPORT static const OdGeVector2d kXAxis;    // X-Axis vector.
  GE_STATIC_EXPORT static const OdGeVector2d kYAxis;    // Y-Axis vector.

  friend GE_TOOLKIT_EXPORT OdGeVector2d operator*(
    const OdGeMatrix2d& xfm, 
    const OdGeVector2d& vect);

  /** \details
    Sets this vector to the product matrix * vect and returns
    a reference to this vector. 
    
    \param matrix [in]  Any 2D matrix. 
    \param vect [in]  Any 2D vector 
  */
  OdGeVector2d& setToProduct(
    const OdGeMatrix2d& matrix, 
    const OdGeVector2d& vect)
  {
    *this = matrix * vect;
    return *this;
  }

  /** \details
    Sets this vector to the product scale * vect, and returns
    a reference to this vector. 
    
    \param vect [in]  Any 2D vector. 
    \param scale [in]  Scale factor.
  */
  OdGeVector2d& setToProduct(
    const OdGeVector2d& vect, 
    double scale)
  {
    x = scale * vect.x;
    y = scale * vect.y;
    return *this;
  }
      
  /** \details
    Applies the 2D transformation matrix to this vector,
    and returns a reference to this vector.

    \param xfm [in]  2D transformation matrix.
  */
  OdGeVector2d& transformBy(
    const OdGeMatrix2d& xfm)  { return *this = xfm * *this;}
    
  /** \details
    Rotates this vector the specified angle, and returns
    a reference to this vector. 

    \param angle [in]  Rotation angle.
    
    \remarks
    Rotation angle is specified in radians.
    Rotation is performed counterclockwise if specified value is positive.
  */
  OdGeVector2d& rotateBy(
    double angle);
    
  /** \details
    Mirrors this vector about the specified 2D line
    and returns a reference to this vector.

    \param line [in]  Mirror Line.
  */
  OdGeVector2d& mirror(
    const OdGeVector2d& line);

  /** \details
    Multiplication operator for the OdGeVector2d class.

    \param scale [in]  Scale factor.
    
    \remarks
    Returns a vector with multiplied coordinates of this vector by the scale factor.
  */
  OdGeVector2d operator*(
    double scale) const
  {
    return OdGeVector2d(x*scale, y*scale);
  }
  friend inline OdGeVector2d operator*(
    double scale, const OdGeVector2d& vector
  ) {
    return OdGeVector2d(vector.x * scale, vector.y * scale);
  }

  /** \details
    Multiplication operator for the OdGeVector2d class.

    \param scale [in]  Scale factor.
    
    \remarks
    Multiplies coordinates of this vector by the scale factor and returns reference to this vector.
  */
  OdGeVector2d& operator*=(
    double scale)
  {
    x *= scale;
    y *= scale;
    return *this;
  }
  
  /** \details
    Division operator for the OdGeVector2d class.

    \param scale [in]  Scale factor.
    
    \remarks
    Returns a vector with divided coordinates of this vector by the scale factor.
  */
  OdGeVector2d  operator/(
    double scale) const
  {
    return OdGeVector2d(x / scale, y / scale);
  }
  
  /** \details
    Division operator for the OdGeVector2d class.

    \param scale [in]  Scale factor.
    
    \remarks
    Divides coordinates of this vector by the scale factor and returns reference to this vector.
  */
  OdGeVector2d& operator/=(double scale)
  {
    x /= scale;
    y /= scale;
    return *this;
  }

  /** \details
    Addition operator for the OdGeVector2d class.

    \param vect [in]  A 2D vector to be added.
    
    \remarks
    Returns a vector that is created by adding coordinates of this vector to the coordinates of the specified vector.
  */
  OdGeVector2d operator+(
    const OdGeVector2d& vect) const
  {
    return OdGeVector2d(x + vect.x, y + vect.y);
  }
  
  /** \details
    Addition operator for the OdGeVector2d class.

    \param vect [in]   A 2D vector to be added.
    
    \remarks
    Adds coordinates of the specified vector to the coordinates of this vector and returns a reference to this vector.
  */
  OdGeVector2d& operator+=(
    const OdGeVector2d& vect)
  {
    x += vect.x;
    y += vect.y;
    return *this;
  }
  
  /** \details
    Subtraction operator for the OdGeVector2d class.

    \param vect [in]  A 2D vector to be subtracted.
    
    \remarks
    Returns a vector that is created by subtracting coordinates of the passed vector from the coordinates of this vector.
  */
  OdGeVector2d operator-(
    const OdGeVector2d& vect) const
  {
    return OdGeVector2d(x - vect.x, y - vect.y);
  }
  
  /** \details
    Subtraction operator for the OdGeVector2d class.

    \param vect [in]   A 2D vector to be subtracted.
    
    \remarks
    Subtracts coordinates of the passed vector from the coordinates of this vector and returns a reference to this vector.
  */
  OdGeVector2d& operator-=(
    const OdGeVector2d& vect)
  {
    x -= vect.x;
    y -= vect.y;
    return *this;
  }

  /** \details
  Returns this vector as a point.
  */
  const OdGePoint2d& asPoint() const;

  /** \details
  Returns this vector as a point.
  */
  OdGePoint2d& asPoint();
    
  /** \details
    Sets this vector to vector1 + vector1, and returns a reference to this vector.
    
    \param vector1 [in]  Any 2D vector.
    \param vector2 [in]  Any 2D vector.
  */
  OdGeVector2d& setToSum(
    const OdGeVector2d& vector1, 
    const OdGeVector2d& vector2)
  {
    x = vector1.x + vector2.x;
    y = vector1.y + vector2.y;
    return *this;
  }

  /** \details
    Returns a vector with inverted X and Y coordinates.

    \returns
    Vector opposite to this vector.
  */
  OdGeVector2d operator-() const {
    return OdGeVector2d(-x, -y);
  }
  
  /** \details
    Negates this vector (-x, -y), and returns a reference to this vector.
  */
  OdGeVector2d& negate ()
  {
    x = -x;
    y = -y;
    return *this;
  }

  /** \details
    Returns the vector perpendicular to this one (-y, x).
  */
  OdGeVector2d perpVector () const
  {
    return OdGeVector2d(-y, x);
  }

  /** \details
    Returns the angle between this vector and the X-axis
    
    \remarks
    Returns a value in the range [0.0 .. Oda2PI].
  */
  double angle () const;

  /** \details
    Returns the angle between this vector and the specified vector.
    
    \param vect [in]  A 2D vector, angle to which is measured.
    
    \remarks
    Returns a value in the range [0.0 .. OdaPI].
    
    This function is commutative:
    
        a.angleTo (b) == b.angleTo (a)
  */
  double angleTo (
    const OdGeVector2d& vect) const;

  /** \details
    Returns the angle from this vector to the specified vector in the counterclockwise direction.
    
    \param vect [in]  Any 2D vector.
    
    \remarks
    Returns a value in the range [-OdaPI .. OdaPI].
  */
  double angleToCCW (
    const OdGeVector2d& vect) const
  {
    return OD_ATAN2(crossProduct(vect), dotProduct(vect));
  }
    
  /** \details
    Returns the unit vector codirectional with this vector.
    
    \param tol [in]  Geometric tolerance.
        
    \remarks
    If the length() <= tol, this vector is returned.
  */
  OdGeVector2d normal (
    const OdGeTol& tol = OdGeContext::gTol) const;
    
  /** \details
    Sets this vector to the unit vector codirectional with this vector,
    and returns a reference to this vector
    
    \param tol [in]  Geometric tolerance.

    \returns
    Vector length prior to normalization. If this.length() <= tol, this vector is unchanged and 0.0 is returned.
  */
  OdGeVector2d& normalize (
    const OdGeTol& tol = OdGeContext::gTol);
  
  /** \details
    Sets this vector to the unit vector codirectional with this vector,
    and returns a reference to this vector
    
    \param tol [in]  Geometric tolerance.
    \param status [out]  Receives the status of normalization.

    \remarks
    If this.length() <= tol, this vector is unchanged, and kThis is returned in status.

    Possible values for status are as follows:

    @untitled table
    kOk 
    k0This
  */
  OdGeVector2d& normalize (
    const OdGeTol& tol, 
    OdGeError& status);
    
  /** \details
    Sets this vector to the unit vector codirectional with this vector,
    and returns the length prior to normalization.

    \param tol [in]  Geometric tolerance.

    \remarks
    If this.length() <= tol, this vector is unchanged and zero length is returned.
  */
   double normalizeGetLength (double tol = 1.e-300);

  /** \details
    Returns the length of this vector.
  */
   double length () const;
  
  /** \details
    Returns the square of the length of this vector.
  */
   double lengthSqrd () const
   {
     return x*x + y*y;
   }
  
  /** \details
    Returns true if and only if the length of this vector is 1.0 within the specified tolerance.

    \param tol [in]  Geometric tolerance.
  */
   bool isUnitLength (
     const OdGeTol& tol = OdGeContext::gTol) const;

  /** \details
    Returns true if and only if the length of this vector is 0.0 within the specified tolerance.

    \param tol [in]  Geometric tolerance.
  */
   bool isZeroLength (
     const OdGeTol& tol = OdGeContext::gTol) const;

  /** \details
    Returns true if and only if the specified vector is parallel to this vector within the specified tolerance.

    \param vect [in]  Any 2D vector that is checked to be parallel to this vector.
    \param tol [in]  Geometric tolerance.
  */
   bool isParallelTo (
     const OdGeVector2d& vect,
     const OdGeTol& tol = OdGeContext::gTol) const;

  /** \details
    Returns true if and only if the specified vector is parallel to this vector within the specified tolerance.

    \param vect [in]  Any 2D vector that is checked to be parallel to this vector.
    \param tol [in]  Geometric tolerance.
    \param status [out]  Receives the status of test.

    \remarks
    If the length of either vector is < tol, kThis is returned in status.

    Possible values for status are as follows:

    @untitled table
    kOk
    k0This
    k0Arg1
  */    
  bool isParallelTo (
    const OdGeVector2d& vect, 
    const OdGeTol& tol,
    OdGeError& status) const;
    
  /** \details
    Returns true if and only if the specified vector is codirectional to this vector within the specified tolerance.

    \param vect [in]  Any 2D vector that is checked to be codirectional with this vector.
    \param tol [in]  Geometric tolerance.   
  */
  bool isCodirectionalTo (
    const OdGeVector2d& vect,
    const OdGeTol& tol=OdGeContext::gTol) const;

  /** \details
    Returns true if and only if the specified vector is codirectional to this vector within the specified tolerance.

    \param vect [in]  Any 2D vector that is checked to be codirectional with this vector.
    \param tol [in]  Geometric tolerance.
    \param status [out]  Receives the status of test.

    \remarks
    If the length of either vector is < tol, kThis is returned in status.

    Possible values for status are as follows:

    @untitled table
    kOk       
    k0This    
    k0Arg1    
  */
  bool isCodirectionalTo (
    const OdGeVector2d& vect, 
    const OdGeTol& tol,
    OdGeError& status) const;
    
  /** \details
    Returns true if and only if the specified vector is perpendicular to this vector within the specified tolerance.

    \param vect [in]  Any 2D vector that is checked to be perpendicular to this vector.
    \param tol [in]  Geometric tolerance.
  */
  bool isPerpendicularTo (
    const OdGeVector2d& vect,
    const OdGeTol& tol = OdGeContext::gTol) const;

  /** \details
    Returns true if and only if the specified vector is perpendicular to this vector within the specified tolerance.

    \param vect [in]  Any 2D vector that is checked to be perpendicular to this vector.
    \param tol [in]  Geometric tolerance.
    \param status [out]  Receives the status of test.

    \remarks
    If the length of either vector is > tol, kOk is returned in status.

    Possible values for status are as follows:

    @untitled table
    kOk       
    k0This    
    k0Arg1    
  */
  bool isPerpendicularTo (
    const OdGeVector2d& vect, 
    const OdGeTol& tol,
    OdGeError& status) const;
    
  /** \details
    Returns the dot product of this vector and the specified vector.
    
    \param vect [in]  Any 2D vector.
  */
  double dotProduct (
    const OdGeVector2d& vect) const
  {
    return x * vect.x + y * vect.y;
  }

  /** \details
    Returns the z value of the cross product of this vector with
    the specified vector.
    
    \param vect [in]  Any 2D vector.
  */
  double crossProduct (
    const OdGeVector2d& vect) const
  {
    return x * vect.y - y * vect.x;
  }

  /** \details
    Equality operator for the OdGeVector2d class.

    \param vect [in]   A 2D vector to be compared.
    
    \remarks
    Returns true if passed vector is equal to this vector.
  */
  bool operator== (
    const OdGeVector2d& vect) const;
  
  /** \details
    Inequality operator for the OdGeVector2d class.

    \param vect [in]   A 2D vector to be compared.
    
    \remarks
    Returns true if passed vector is not equal to this vector.
  */
  bool operator!= (
    const OdGeVector2d& vect) const;
    
  /** \details
    Returns true if and only if vector is identical to this vector,
    within the specified tolerance.

    \param vect [in]  Any 2D vector.
    \param tol [in]  Geometric tolerance.
  */
  bool isEqualTo (
    const OdGeVector2d& vect,
    const OdGeTol& tol = OdGeContext::gTol) const;

  /** \details 
    Returns the ith coordinate of this vector.
    
    \param i [in]  Index of coordinate.
    
    \remarks
    * 0 returns the X-coordinate.
    * 1 returns the Y-coordinate.
  */
  double operator[] (
    unsigned int i) const
  {
    return *(&x + i);
  }
  
  /** \details 
    References the ith coordinate of this vector.
    
    \param i [in]  Index of coordinate.
    
    \remarks
    * 0 references the X-coordinate.
    * 1 references the Y-coordinate.
  */
  double& operator[] (
    unsigned int i)
  {
    return *(&x + i);
  }

  /** \details
    Returns the index of the largest absolute coordinate of this vector.
    \returns
    Index of the largest element in the vector.
  */

  unsigned int largestElement() const;
  
  /** \details
    Sets this vector to the specified X and Y coordinates, 
    and returns a reference to this vector.

    \param xx [in]  X-coordinate.
    \param yy [in]  Y-coordinate.
  */
  OdGeVector2d& set (
    double xx, 
    double yy)
  {
    x = xx;
    y = yy;
    return *this;
  }    

  /** \details
    Returns the equivalent 2D tranformation matrix.
  */
  operator OdGeMatrix2d () const;

  double x; // X-coordinate.
  double y; // Y-coordinate.
};


#include "TD_PackPop.h"


#include "GePoint2d.h"
//DOM-IGNORE-BEGIN
inline const OdGePoint2d& OdGeVector2d::asPoint() const
{
  ODA_ASSUME(sizeof(OdGePoint2d) == 2 * sizeof(double));
  ODA_ASSUME(sizeof(OdGeVector2d) == 2 * sizeof(double));
  return *reinterpret_cast<const OdGePoint2d*>(this);
}

inline OdGePoint2d& OdGeVector2d::asPoint()
{
  ODA_ASSUME(sizeof(OdGePoint2d) == 2 * sizeof(double));
  ODA_ASSUME(sizeof(OdGeVector2d) == 2 * sizeof(double));
  return *reinterpret_cast<OdGePoint2d*>(this);
}
//DOM-IGNORE-END
#endif