GeVector2d.h

Go to the documentation of this file.

// Copyright (C) 2002-2017, 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-2017 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 "Ge/GeTol.h"
 
#include "TD_PackPush.h"
 
class OdGeMatrix2d;
 
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);
      
  OdGeVector2d& transformBy (
    const OdGeMatrix2d& xfm)  { return *this = xfm * *this;}
    
  OdGeVector2d& rotateBy (
    double angle);
    
  OdGeVector2d& mirror (
    const OdGeVector2d& line);
 
  OdGeVector2d operator* (
    double scale) const;
  friend GE_TOOLKIT_EXPORT OdGeVector2d operator* (
    double scale, const OdGeVector2d& vector);
 
  OdGeVector2d& operator*= (
    double scale);
    
  OdGeVector2d  operator/ (
    double scale) const;
  OdGeVector2d& operator/= (double scale);
 
  OdGeVector2d operator+ (
    const OdGeVector2d& vect) const;
  OdGeVector2d& operator+= (
    const OdGeVector2d& vect);
  OdGeVector2d operator- (
    const OdGeVector2d& vect) const;
  OdGeVector2d& operator-= (
    const OdGeVector2d& vect);
    
    OdGeVector2d& setToSum (
    const OdGeVector2d& vector1, 
    const OdGeVector2d& vector2);
    
  OdGeVector2d operator- () const;
  
  OdGeVector2d& negate ();
 
  OdGeVector2d perpVector () const;
 
  double angle () const;
 
  double angleTo (
    const OdGeVector2d& vect) const;
 
  double angleToCCW (
    const OdGeVector2d& vect) const
  {
    return crossProduct (vect) > 0.0 ? angleTo(vect) : -angleTo(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;
  
        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;
 
  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;
  double& operator[] (
    unsigned int i) ;
  
  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"
 
#endif