point2.h File Reference

#include "GeomExport.h"
#include "ipoint2.h"
#include <cassert>
#include <cmath>
#include <iosfwd>

Classes
class	Point2

Functions
float	Length (const Point2 &v)
constexpr float	LengthSquared (const Point2 &v)
int	MaxComponent (const Point2 &v)
int	MinComponent (const Point2 &v)
Point2	Normalize (const Point2 &v)
constexpr float	DotProd (const Point2 &a, const Point2 &b)
constexpr Point2	operator* (const Point2 &a, float f)
constexpr Point2	operator* (float f, const Point2 &a)
constexpr Point2	operator+ (const Point2 &a, float f)
constexpr Point2	operator+ (float f, const Point2 &a)
constexpr Point2	operator- (const Point2 &a, float f)
Point2	operator/ (const Point2 &a, float f)

Function Documentation

Length()

float Length ( const Point2 &  v )

inline

Remarks

Returns the length of the point. This is sqrt(v.x*v.x+v.y*v.y);

{
    return v.Length();
}

LengthSquared()

constexpr float LengthSquared ( const Point2 &  v )

constexpr

Remarks

The 'Length' squared of the point. This is v.x*v.x+v.y*v.y.

{
    return v.LengthSquared();
}

MaxComponent()

int MaxComponent ( const Point2 &  v )

inline

Remarks

Returns the component with the maximum absolute value. 0=x, 1=y.

{
    return v.MaxComponent();
}

MinComponent()

int MinComponent ( const Point2 &  v )

inline

Remarks

Returns the component with the minimum absolute value. 0=x, 1=y.

{
    return v.MinComponent();
}

Normalize()

Point2 Normalize ( const Point2 &  v )

inline

Remarks

Returns a unit vector. This is a Point2 with each component divided by the point Length().

{
    return v.Normalize();
}

DotProd()

constexpr float DotProd ( const Point2 &  a, const Point2 &  b  )

constexpr

Remarks

Returns the dot product of two Point2's

{
    return a % b;
}

operator*() [1/2]

constexpr Point2 operator* ( const Point2 &  a, float  f  )

constexpr

Remarks

Returns a Point2 multiplied by a scalar.

{
    return Point2(a.x * f, a.y * f);
}

operator*() [2/2]

constexpr Point2 operator* ( float  f, const Point2 &  a  )

constexpr

{
    return a * f;
}

operator+() [1/2]

constexpr Point2 operator+ ( const Point2 &  a, float  f  )

constexpr

Remarks

Returns a copy of the Point2 argument offset by (f, f).

{
    return Point2(a.x + f, a.y + f);
}

operator+() [2/2]

constexpr Point2 operator+ ( float  f, const Point2 &  a  )

constexpr

{
    return a + f;
}

operator-()

constexpr Point2 operator- ( const Point2 &  a, float  f  )

constexpr

Remarks

Returns a copy of the Point2 argument offset by (-f, -f).

{
    return a + -f;
}

operator/()

Point2 operator/ ( const Point2 &  a, float  f  )

inline

Remarks

Returns a Point2 whose x and y members are divided by a scalar.

{
    assert(f != 0.0f);
    return a * (1.0f / f);
}