Point2 Class Reference

#include <point2.h>

Public Member Functions
	Point2 ()=default
constexpr	Point2 (const Point2 &)=default
constexpr	Point2 (Point2 &&)=default
Point2 &	operator= (const Point2 &)=default
Point2 &	operator= (Point2 &&)=default
constexpr	Point2 (float X, float Y)
constexpr	Point2 (double X, double Y)
constexpr	Point2 (int X, int Y)
constexpr	Point2 (const IPoint2 &a)
constexpr	Point2 (const float af[2])
float &	operator[] (int i)
const float &	operator[] (int i) const
constexpr	operator float * ()
constexpr	operator const float * () const
constexpr Point2	operator- () const
constexpr Point2	operator+ () const
constexpr float	LengthSquared () const
float	Length () const
int	MaxComponent () const
int	MinComponent () const
Point2	Normalize () const
constexpr Point2 &	operator+= (const Point2 &a)
	Member-wise, in-place addition of this vector (x+a.x, y+a.y)
constexpr Point2 &	operator-= (const Point2 &a)
	Member-wise, in-place subtraction of this vector (x-a.x, y-a.y)
constexpr Point2 &	operator*= (const Point2 &a)
	Member-wise, in-place multiplication of this vector: (x*a.x, y*a.y)
Point2 &	operator/= (const Point2 &a)
	Member-wise, in-place division of this vector: (x/a.x, y/a.y)
constexpr Point2 &	operator+= (float f)
constexpr Point2 &	operator-= (float f)
constexpr Point2 &	operator*= (float f)
Point2 &	operator/= (float f)
constexpr Point2 &	Set (float X, float Y)
constexpr Point2	operator- (const Point2 &a) const
	Member-wise subtraction of two vectors: (x-a.x, y-a.y)
constexpr Point2	operator+ (const Point2 &a) const
	Member-wise addition of two vectors: (x+a.x, y+a.y)
constexpr Point2	operator* (const Point2 &a) const
	Member-wise multiplication of two vectors: (x*a.x, y*a.y)
Point2	operator/ (const Point2 &a) const
	Member-wise division of two vectors: (x/a.x, y/a.y)
constexpr float	DotProd (const Point2 &a) const
	Returns the dot product of two Point2's.
constexpr float	operator% (const Point2 &a) const
	Returns the dot product of two Point2's.
constexpr bool	operator== (const Point2 &p) const
constexpr bool	operator!= (const Point2 &p) const
bool	Equals (const Point2 &p, float epsilon=1E-6f) const
Point2 &	Unify ()
float	LengthUnify ()

Public Attributes
float	x = 0.f
float	y = 0.f

Static Public Attributes
static const Point2	Origin
static const Point2	XAxis
static const Point2	YAxis

Detailed Description

See also

Class IPoint2.

Description:

This class describes a 2D point using float x and y coordinates. Methods are provided to add and subtract points, multiply and divide by scalars, normalize and compute the dot product of two Point2s. All methods are implemented by the system.

Data Members:

float x,y;

The x and y components of the point.

static const Point2 Origin;

This is equivalent to Point2(0.0f, 0.0f);

static const Point2 XAxis;

This is equivalent to Point2(1.0f, 0.0f);

static const Point2 YAxis;

This is equivalent to Point2(0.0f, 1.0f);
Constructors

Constructor & Destructor Documentation

Point2() [1/8]

Point2 ( )

default

Point2() [2/8]

constexpr Point2 ( const Point2 &  )

constexprdefault

Point2() [3/8]

constexpr Point2 ( Point2 &&  )

constexprdefault

Point2() [4/8]

constexpr Point2 ( float  X, float  Y  )

inlineconstexpr

Remarks

Constructor. Data members are initialized to X and Y.

: x(X), y(Y) {}

Point2() [5/8]

constexpr Point2 ( double  X, double  Y  )

inlineconstexpr

Remarks

Constructor. Data members are initialized to X and Y cast as floats.

: x((float)X), y((float)Y) {}

Point2() [6/8]

constexpr Point2 ( int  X, int  Y  )

inlineconstexpr

Remarks

Constructor. Data members are initialized to X and Y cast as floats.

: x((float)X), y((float)Y) {}

Point2() [7/8]

constexpr Point2 ( const IPoint2 &  a )

inlineexplicitconstexpr

Remarks

Constructor. Data members are initialized to a.x and a.y.

: x((float)a.x), y((float)a.y) {}

Point2() [8/8]

constexpr Point2 ( const float  af[2] )

inlineconstexpr

Remarks

Constructor. Data members are initialized as x = af[0] and y = af[1].

: x(af[0]), y(af[1]) {}

Member Function Documentation

operator=() [1/2]

Point2 & operator= ( const Point2 &  )

default

operator=() [2/2]

Point2 & operator= ( Point2 &&  )

default

operator[]() [1/2]

float & operator[] ( int  i )

inline

Remarks

Allows access to x, y using the subscript operator.

Returns

A value for i of 0 will return x, 1 will return y.

    {
        assert((i == 0) || (i == 1));
        return (i == 0) ? x : y;
    }

operator[]() [2/2]

const float & operator[] ( int  i ) const

inline

    {
        assert((i == 0) || (i == 1));
        return (i == 0) ? x : y;
    }

operator float *()

constexpr operator float * ( )

inlineconstexpr

Remarks

Returns the address of the Point2.x

    {
        return &x;
    }

operator const float *()

constexpr operator const float * ( ) const

inlineconstexpr

    {
        return &x;
    }

operator-() [1/2]

constexpr Point2 operator- ( ) const

inlineconstexpr

Remarks

Unary -. Negates both x and y.

    {
        return Point2(-x, -y);
    }

operator+() [1/2]

constexpr Point2 operator+ ( ) const

inlineconstexpr

Remarks

Unary +. Returns the point unaltered.

    {
        return *this;
    }

LengthSquared()

constexpr float LengthSquared ( ) const

inlineconstexpr

Remarks

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

    {
        return x * x + y * y;
    }

Length()

float Length ( ) const

inline

Remarks

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

    {
        return sqrtf(LengthSquared());
    }

MaxComponent()

int MaxComponent

(

)

const

Remarks

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

MinComponent()

int MinComponent

(

)

const

Remarks

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

Normalize()

Point2 Normalize

(

)

const

Remarks

This method returns a normalized version of this Point2. This method is more accurate than *this/Length() (internal computations are done in double precision).

operator+=() [1/2]

constexpr Point2 & operator+= ( const Point2 &  a )

inlineconstexpr

Member-wise, in-place addition of this vector (x+a.x, y+a.y)

    {
        x += a.x;
        y += a.y;
        return *this;
    }

operator-=() [1/2]

constexpr Point2 & operator-= ( const Point2 &  a )

inlineconstexpr

Member-wise, in-place subtraction of this vector (x-a.x, y-a.y)

    {
        x -= a.x;
        y -= a.y;
        return *this;
    }

operator*=() [1/2]

constexpr Point2 & operator*= ( const Point2 &  a )

inlineconstexpr

Member-wise, in-place multiplication of this vector: (x*a.x, y*a.y)

    {
        x *= a.x;
        y *= a.y;
        return *this;
    }

operator/=() [1/2]

Point2 & operator/= ( const Point2 &  a )

inline

Member-wise, in-place division of this vector: (x/a.x, y/a.y)

    {
        assert(a.x != 0 && a.y != 0);
        x /= a.x;
        y /= a.y;
        return *this;
    }

operator+=() [2/2]

constexpr Point2 & operator+= ( float  f )

inlineconstexpr

Remarks

Adds floating point value to this Point2.

    {
        x += f;
        y += f;
        return *this;
    }

operator-=() [2/2]

constexpr Point2 & operator-= ( float  f )

inlineconstexpr

Remarks

Subtracts floating point value from this Point2.

    {
        return *this += -f;
    }

operator*=() [2/2]

constexpr Point2 & operator*= ( float  f )

inlineconstexpr

Remarks

Multiplies this Point2 by a floating point value.

    {
        x *= f;
        y *= f;
        return *this;
    }

operator/=() [2/2]

Point2 & operator/= ( float  f )

inline

Remarks

Divides this Point2 by a floating point value.

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

Set()

constexpr Point2 & Set ( float  X, float  Y  )

inlineconstexpr

Remarks

Sets the x and y coordinate and returns a reference to this Point2.

    {
        x = X;
        y = Y;
        return *this;
    }

operator-() [2/2]

constexpr Point2 operator- ( const Point2 &  a ) const

inlineconstexpr

Member-wise subtraction of two vectors: (x-a.x, y-a.y)

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

operator+() [2/2]

constexpr Point2 operator+ ( const Point2 &  a ) const

inlineconstexpr

Member-wise addition of two vectors: (x+a.x, y+a.y)

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

operator*()

constexpr Point2 operator* ( const Point2 &  a ) const

inlineconstexpr

Member-wise multiplication of two vectors: (x*a.x, y*a.y)

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

operator/()

Point2 operator/ ( const Point2 &  a ) const

inline

Member-wise division of two vectors: (x/a.x, y/a.y)

    {
        assert(a.x != 0 && a.y != 0);
        return Point2(x / a.x, y / a.y);
    }

DotProd()

constexpr float DotProd ( const Point2 &  a ) const

inlineconstexpr

Returns the dot product of two Point2's.

    {
        return x * a.x + y * a.y;
    }

operator%()

constexpr float operator% ( const Point2 &  a ) const

inlineconstexpr

Returns the dot product of two Point2's.

    {
        return DotProd(a);
    }

operator==()

constexpr bool operator== ( const Point2 &  p ) const

inlineconstexpr

Remarks

Equality operator. Compares two Point2's.

    {
        return x == p.x && y == p.y;
    }

operator!=()

constexpr bool operator!= ( const Point2 &  p ) const

inlineconstexpr

    {
        return !(*this == p);
    }

Equals()

bool Equals	(	const Point2 &	p,
		float	epsilon = 1E-6f
	)		const

Remarks

Returns true if the absolute difference between point components is less or equal to the given epsilon for each component

Unify()

Point2 & Unify

(

)

Remarks

This method is used to unify (or normalize) this Point2 (in place) and return the result. Internal computations are done in double precision.

LengthUnify()

float LengthUnify

(

)

Remarks

This method is used to unify (or normalize) this Point2 (in place) and return the previous length. Internal computations are done in double precision.

Member Data Documentation

x

float x = 0.f

y

float y = 0.f

Origin

const Point2 Origin

static

XAxis

const Point2 XAxis

static

YAxis

const Point2 YAxis

static