IPoint2 Class Reference

#include <ipoint2.h>

Public Member Functions
	IPoint2 ()=default
constexpr	IPoint2 (const IPoint2 &)=default
constexpr	IPoint2 (IPoint2 &&)=default
IPoint2 &	operator= (const IPoint2 &)=default
IPoint2 &	operator= (IPoint2 &&)=default
constexpr	IPoint2 (int X, int Y)
constexpr	IPoint2 (int af[2])
int &	operator[] (int i)
const int &	operator[] (int i) const
constexpr	operator int * ()
constexpr	operator const int * () const
constexpr IPoint2	operator- () const
constexpr IPoint2	operator+ () const
constexpr int	LengthSquared () const
float	Length () const
int	MaxComponent () const
int	MinComponent () const
constexpr IPoint2 &	operator-= (const IPoint2 &a)
constexpr IPoint2 &	operator+= (const IPoint2 &a)
constexpr IPoint2 &	operator*= (const IPoint2 &a)
	Member-wise, in-place multiplication of this vector: (x*x, y*y)
constexpr IPoint2 &	operator/= (const IPoint2 &a)
	Member-wise, in-place division of this vector:
constexpr IPoint2 &	operator*= (int f)
constexpr IPoint2 &	operator/= (int f)
constexpr IPoint2 &	operator+= (int f)
constexpr IPoint2 &	operator-= (int f)
constexpr IPoint2	operator- (const IPoint2 &a) const
constexpr IPoint2	operator+ (const IPoint2 &a) const
constexpr IPoint2	operator* (const IPoint2 &a) const
	Member-wise multiplication of two vectors: (x*x, y*y)
constexpr IPoint2	operator/ (const IPoint2 &a) const
	Member-wise division of two vectors:
constexpr int	DotProd (const IPoint2 &a) const
constexpr int	operator% (const IPoint2 &a) const
constexpr bool	operator== (const IPoint2 &a) const
constexpr bool	operator!= (const IPoint2 &a) const

Public Attributes
int	x = 0
int	y = 0

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

Detailed Description

See also

Class Point2.

Description:

This class describes a 2D point using int 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 IPoint2s. All methods are implemented by the system.

Data Members:

int x,y;

Constructor & Destructor Documentation

IPoint2() [1/5]

IPoint2 ( )

default

IPoint2() [2/5]

constexpr IPoint2 ( const IPoint2 &  )

constexprdefault

IPoint2() [3/5]

constexpr IPoint2 ( IPoint2 &&  )

constexprdefault

IPoint2() [4/5]

constexpr IPoint2 ( int  X, int  Y  )

inlineconstexpr

Remarks

Constructor. Data members are initialized to X and Y.

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

IPoint2() [5/5]

constexpr IPoint2 ( int  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]

IPoint2 & operator= ( const IPoint2 &  )

default

operator=() [2/2]

IPoint2 & operator= ( IPoint2 &&  )

default

operator[]() [1/2]

int & operator[] ( int  i )

inline

Remarks

Allows access to x, y using the subscript operator.

Returns

An index of 0 will return x, 1 will return y.

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

operator[]() [2/2]

const int & operator[] ( int  i ) const

inline

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

operator int *()

constexpr operator int * ( )

inlineconstexpr

Remarks

Returns the address of the IPoint2.x.

    {
        return &x;
    }

operator const int *()

constexpr operator const int * ( ) const

inlineconstexpr

    {
        return &x;
    }

operator-() [1/2]

constexpr IPoint2 operator- ( ) const

inlineconstexpr

Remarks

Unary -. Negates both x and y.

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

operator+() [1/2]

constexpr IPoint2 operator+ ( ) const

inlineconstexpr

Remarks

Unary +. Returns the Ipoint2 unaltered.

    {
        return *this;
    }

LengthSquared()

constexpr int LengthSquared ( ) const

inlineconstexpr

Remarks

Returns the length squared of the IPoint2

    {
        return x * x + y * y;
    }

Length()

float Length ( ) const

inline

Remarks

Returns the length of the IPoint2

    {
        return (float)sqrt((double)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.

operator-=() [1/2]

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

inlineconstexpr

Remarks

Subtracts a IPoint2 from this IPoint2.

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

operator+=() [1/2]

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

inlineconstexpr

Remarks

Adds a IPoint2 to this IPoint2.

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

operator*=() [1/2]

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

inlineconstexpr

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

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

operator/=() [1/2]

constexpr IPoint2 & operator/= ( const IPoint2 &  a )

inlineconstexpr

Member-wise, in-place division of this vector:

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

operator*=() [2/2]

constexpr IPoint2 & operator*= ( int  f )

inlineconstexpr

Remarks

Multiplies this IPoint2 by an integer value.

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

operator/=() [2/2]

constexpr IPoint2 & operator/= ( int  f )

inlineconstexpr

Remarks

Divides this IPoint2 by an integer value.

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

operator+=() [2/2]

constexpr IPoint2 & operator+= ( int  f )

inlineconstexpr

Remarks

Adds floating point value to this Point2.

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

operator-=() [2/2]

constexpr IPoint2 & operator-= ( int  f )

inlineconstexpr

Remarks

Subtracts floating point value from this Point2.

    {
        return *this += -f;
    }

operator-() [2/2]

constexpr IPoint2 operator- ( const IPoint2 &  a ) const

inlineconstexpr

Remarks

Subtracts IPoint2 from this IPoint2.

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

operator+() [2/2]

constexpr IPoint2 operator+ ( const IPoint2 &  a ) const

inlineconstexpr

Remarks

Adds IPoint2 to this IPoint2.

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

operator*()

constexpr IPoint2 operator* ( const IPoint2 &  a ) const

inlineconstexpr

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

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

operator/()

constexpr IPoint2 operator/ ( const IPoint2 &  a ) const

inlineconstexpr

Member-wise division of two vectors:

    {
        return IPoint2(x / a.x, y / a.y);
    }

DotProd()

constexpr int DotProd ( const IPoint2 &  a ) const

inlineconstexpr

Remarks

Returns the dot product of two IPoint2's.

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

operator%()

constexpr int operator% ( const IPoint2 &  a ) const

inlineconstexpr

    {
        return DotProd(a);
    }

operator==()

constexpr bool operator== ( const IPoint2 &  a ) const

inlineconstexpr

Remarks

Equality operator. Compares two Point2's.

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

operator!=()

constexpr bool operator!= ( const IPoint2 &  a ) const

inlineconstexpr

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

Member Data Documentation

x

int x = 0

y

int y = 0

Origin

const IPoint2 Origin

static

XAxis

const IPoint2 XAxis

static

YAxis

const IPoint2 YAxis

static