GeVector2d.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, 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-2022 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 
#include "Ge/GeGbl.h"
 
#include "TD_PackPush.h"
 
class OdGeMatrix2d;
class OdGePoint2d;
 
class GE_TOOLKIT_EXPORT OdGeVector2d
{
public:
 
  OdGeVector2d() : x(0.0), y(0.0) {}
  
  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);
 
  OdGeVector2d& setToProduct(
    const OdGeMatrix2d& matrix, 
    const OdGeVector2d& vect)
  {
    *this = matrix * vect;
    return *this;
  }
 
  OdGeVector2d& setToProduct(
    const OdGeVector2d& vect, 
    double scale)
  {
    x = scale * vect.x;
    y = scale * vect.y;
    return *this;
  }
      
  OdGeVector2d& transformBy(
    const OdGeMatrix2d& xfm)  { return *this = xfm * *this;}
    
  OdGeVector2d& rotateBy(
    double angle);
    
  OdGeVector2d& mirror(
    const OdGeVector2d& line);
 
  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);
  }
 
  OdGeVector2d& operator*=(
    double scale)
  {
    x *= scale;
    y *= scale;
    return *this;
  }
  
  OdGeVector2d  operator/(
    double scale) const
  {
    return OdGeVector2d(x / scale, y / scale);
  }
  
  OdGeVector2d& operator/=(double scale)
  {
    x /= scale;
    y /= scale;
    return *this;
  }
 
  OdGeVector2d operator+(
    const OdGeVector2d& vect) const
  {
    return OdGeVector2d(x + vect.x, y + vect.y);
  }
  
  OdGeVector2d& operator+=(
    const OdGeVector2d& vect)
  {
    x += vect.x;
    y += vect.y;
    return *this;
  }
  
  OdGeVector2d operator-(
    const OdGeVector2d& vect) const
  {
    return OdGeVector2d(x - vect.x, y - vect.y);
  }
  
  OdGeVector2d& operator-=(
    const OdGeVector2d& vect)
  {
    x -= vect.x;
    y -= vect.y;
    return *this;
  }
 
  const OdGePoint2d& asPoint() const;
 
  OdGePoint2d& asPoint();
    
  OdGeVector2d& setToSum(
    const OdGeVector2d& vector1, 
    const OdGeVector2d& vector2)
  {
    x = vector1.x + vector2.x;
    y = vector1.y + vector2.y;
    return *this;
  }
 
  OdGeVector2d operator-() const {
    return OdGeVector2d(-x, -y);
  }
    
  OdGeVector2d& negate ()
  {
    x = -x;
    y = -y;
    return *this;
  }
 
  OdGeVector2d perpVector () const
  {
    return OdGeVector2d(-y, x);
  }
 
  double angle () const;
 
  double angleTo (
    const OdGeVector2d& vect) const;
 
  double angleToCCW (
    const OdGeVector2d& vect) const
  {
    return OD_ATAN2(crossProduct(vect), dotProduct(vect));
  }
    
  OdGeVector2d normal (
    const OdGeTol& tol = OdGeContext::gTol) const;
    
  OdGeVector2d& normalize (
    const OdGeTol& tol = OdGeContext::gTol);
  
  OdGeVector2d& normalize (
    const OdGeTol& tol, 
    OdGeError& status);
    
   double normalizeGetLength (double tol = 1.e-300);
 
        double length () const;
  
   double lengthSqrd () const
   {
     return x*x + y*y;
   }
  
        bool isUnitLength (
    const OdGeTol& tol = OdGeContext::gTol) const;
 
        bool isZeroLength (
    const OdGeTol& tol = OdGeContext::gTol) const;
 
        bool isParallelTo (
    const OdGeVector2d& vect,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
        bool isParallelTo (
    const OdGeVector2d& vect,
    const OdGeTol& tol,
    OdGeError& status) const;
    
        bool isCodirectionalTo (
    const OdGeVector2d& vect,
    const OdGeTol& tol=OdGeContext::gTol) const;
 
        bool isCodirectionalTo (
    const OdGeVector2d& vect,
    const OdGeTol& tol,
    OdGeError& status) const;
    
        bool isPerpendicularTo (
    const OdGeVector2d& vect,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
        bool isPerpendicularTo (
    const OdGeVector2d& vect,
    const OdGeTol& tol,
    OdGeError& status) const;
    
  double dotProduct (
    const OdGeVector2d& vect) const
  {
    return x * vect.x + y * vect.y;
  }
 
  double  crossProduct (
    const OdGeVector2d& vect) const
  {
    return x * vect.y - y * vect.x;
  }
 
  bool operator== (
    const OdGeVector2d& vect) const;
  
  bool operator!= (
    const OdGeVector2d& vect) const;
    
  bool isEqualTo (
    const OdGeVector2d& vect,
    const OdGeTol& tol = OdGeContext::gTol) const;
 
  double operator[] (
    unsigned int i) const
  {
    return *(&x + i);
  }
  
  double& operator[] (
    unsigned int i)
  {
    return *(&x + i);
  }
 
  unsigned int largestElement() const;
  
  OdGeVector2d& set (
    double xx, 
    double yy)
  {
    x = xx;
    y = yy;
    return *this;
  }    
 
  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