vector2DD.h

Go to the documentation of this file.

/*********************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*********************************************************************************/
 
#pragma once
 
//! \file vector2DD.h
//! \brief Provides a class for 2D vector operations with double precision
 
#include "vreUtil/export.h"
 
namespace makVre
{
//! \brief Class representing a 2D vector with double precision
//!
//! This class provides functionality for working with 2D vectors including
//! basic vector operations such as length calculation, normalization, and rotation.
class UTIL_DLL DtVector2DD
{
public:
   //! \brief Default constructor
   //!
   //! Creates a vector with coordinates (0,0)
   DtVector2DD();
 
   //! \brief Constructor with x and y coordinates
   //!
   //! \param x The x coordinate
   //! \param y The y coordinate
   DtVector2DD(double x, double y);
 
   //! \brief Copy constructor
   //!
   //! \param orig The vector to copy
   DtVector2DD(const DtVector2DD& orig);
 
   //! \brief Assignment operator
   //!
   //! \param orig The vector to copy
   //! \return Reference to this vector after assignment
   const DtVector2DD& operator=(const DtVector2DD& orig);
 
   //! \brief Division assignment operator
   //!
   //! Divides both x and y components by a scalar value
   //!
   //! \param scalar The scalar to divide by
   //! \return Reference to this vector after division
   inline DtVector2DD& operator/=(double scalar);
 
   //! \brief Sets the x coordinate
   //!
   //! \param x The new x coordinate
   void setX(double x);
 
   //! \brief Gets the x coordinate
   //!
   //! \return The x coordinate
   double x() const;
 
   //! \brief Sets the y coordinate
   //!
   //! \param y The new y coordinate
   void setY(double y);
 
   //! \brief Gets the y coordinate
   //!
   //! \return The y coordinate
   double y() const;
 
   //! \brief Rotates the vector counter-clockwise
   //!
   //! \param rotationAngle The angle to rotate in radians
   inline void rotate(double rotationAngle);
 
   //! \brief Calculates the length/magnitude of the vector
   //!
   //! \return The length of the vector
   inline double length() const;
 
   //! \brief Calculates the squared length/magnitude of the vector
   //!
   //! This is more efficient than length() when comparing distances,
   //! as it avoids the square root calculation
   //!
   //! \return The squared length of the vector
   inline double lengthSquared() const;
 
   //! \brief Normalizes the vector
   //!
   //! Adjusts the vector to have a length of 1 while preserving its direction
   void normalize();
 
protected:
   //! \brief The x coordinate
   double myX;
 
   //! \brief The y coordinate
   double myY;
};
 
//! \brief Stream insertion operator for DtVector2DD
//!
//! Allows for convenient printing of vectors to output streams
//!
//! \param str The output stream
//! \param vec The vector to output
//! \return Reference to the output stream
inline std::ostream& operator<<(std::ostream& str, const makVre::DtVector2DD& vec)
{
   str << "[ x= " << vec.x() << " y= " << vec.y() << " ]";
   return str;
}
} // namespace makVre