IPoint3 Class Reference

#include <ipoint3.h>

Public Member Functions
	IPoint3 ()=default
	Initializes all vector components to zero.
constexpr	IPoint3 (const IPoint3 &)=default
constexpr	IPoint3 (IPoint3 &&)=default
IPoint3 &	operator= (const IPoint3 &)=default
IPoint3 &	operator= (IPoint3 &&)=default
constexpr	IPoint3 (int X, int Y, int Z)
constexpr	IPoint3 (const int ai[3])
int &	operator[] (int i)
const int &	operator[] (int i) const
constexpr	operator int * ()
constexpr	operator const int * () const
constexpr IPoint3	operator- () const
constexpr IPoint3	operator+ () const
constexpr int	LengthSquared () const
float	Length () const
int	MaxComponent () const
int	MinComponent () const
constexpr IPoint3 &	operator-= (const IPoint3 &p)
constexpr IPoint3 &	operator+= (const IPoint3 &p)
constexpr IPoint3 &	operator*= (const IPoint3 &p)
	Member-wise, in-place multiplication of this vector.
IPoint3 &	operator/= (const IPoint3 &p)
	Member-wise, in-place division of this vector.
constexpr IPoint3 &	operator*= (int f)
IPoint3 &	operator/= (int f)
constexpr IPoint3 &	operator+= (int f)
constexpr IPoint3 &	operator-= (int f)
constexpr IPoint3	operator- (const IPoint3 &p) const
constexpr IPoint3	operator+ (const IPoint3 &p) const
constexpr IPoint3	operator* (const IPoint3 &p) const
	Member-wise multiplication of two vectors: (x*x, y*y, z*z)
IPoint3	operator/ (const IPoint3 &p) const
	Member-wise division of two vectors: (x/x, y/y, z/z)
constexpr int	DotProd (const IPoint3 &p) const
constexpr int	operator% (const IPoint3 &p) const
constexpr IPoint3	CrossProd (const IPoint3 &p) const
constexpr IPoint3	operator^ (const IPoint3 &p) const
constexpr bool	operator== (const IPoint3 &p) const
constexpr bool	operator!= (const IPoint3 &p) const

Public Attributes
int	x = 0
int	y = 0
int	z = 0

Static Public Attributes
static const IPoint3	Origin
static const IPoint3	XAxis
static const IPoint3	YAxis
static const IPoint3	ZAxis

Detailed Description

See also

Class Point3.

Description:

This class describes a 3D point using integer x, y and z coordinates. Methods are provided to add and subtract points, multiply and divide by scalars, and element by element multiply and divide two points. All methods are implemented by the system.

Data Members:

int x,y,z;

Constructor & Destructor Documentation

IPoint3() [1/5]

IPoint3 ( )

default

Initializes all vector components to zero.

IPoint3() [2/5]

constexpr IPoint3 ( const IPoint3 &  )

constexprdefault

IPoint3() [3/5]

constexpr IPoint3 ( IPoint3 &&  )

constexprdefault

IPoint3() [4/5]

constexpr IPoint3 ( int  X, int  Y, int  Z  )

inlineconstexpr

Remarks

Constructor. x, y, and z are initialized to the values specified.

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

IPoint3() [5/5]

constexpr IPoint3 ( const int  ai[3] )

inlineconstexpr

Remarks

Constructor. x, y, and z are initialized to. ai[0], ai[1], and ai[2] respectively.

: x(ai[0]), y(ai[1]), z(ai[2]) {}

Member Function Documentation

operator=() [1/2]

IPoint3 & operator= ( const IPoint3 &  )

default

operator=() [2/2]

IPoint3 & operator= ( IPoint3 &&  )

default

operator[]() [1/2]

int & operator[] ( int  i )

inline

Remarks

Allows access to x, y and z using the [ ] operator.

Returns

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

    {
        assert((i >= 0) && (i <= 2));
        return (&x)[i];
    }

operator[]() [2/2]

const int & operator[] ( int  i ) const

inline

Remarks

Allows access to x, y and z using the [ ] operator.

Returns

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

    {
        assert((i >= 0) && (i <= 2));
        return (&x)[i];
    }

operator int *()

constexpr operator int * ( )

inlineconstexpr

Remarks

Conversion function. Returns the address of the IPoint3.

    {
        return &x;
    }

operator const int *()

constexpr operator const int * ( ) const

inlineconstexpr

    {
        return &x;
    }

operator-() [1/2]

constexpr IPoint3 operator- ( ) const

inlineconstexpr

Remarks

Unary - operator. Negates x, y and z.

    {
        return IPoint3(-x, -y, -z);
    }

operator+() [1/2]

constexpr IPoint3 operator+ ( ) const

inlineconstexpr

Remarks

Unary +. Returns the point unaltered.

    {
        return *this;
    }

LengthSquared()

constexpr int LengthSquared ( ) const

inlineconstexpr

Remarks

Returns the length squared of the IPoint3

    {
        return x * x + y * y + z * z;
    }

Length()

float Length ( ) const

inline

Remarks

Returns the length of the IPoint3

    {
        return sqrtf(float(LengthSquared()));
    }

MaxComponent()

int MaxComponent

(

)

const

Remarks

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

MinComponent()

int MinComponent

(

)

const

Remarks

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

operator-=() [1/2]

constexpr IPoint3 & operator-= ( const IPoint3 &  p )

inlineconstexpr

Remarks

Subtracts a IPoint3 from this IPoint3.

    {
        x -= p.x;
        y -= p.y;
        z -= p.z;
        return *this;
    }

operator+=() [1/2]

constexpr IPoint3 & operator+= ( const IPoint3 &  p )

inlineconstexpr

Remarks

Adds a IPoint3 to this IPoint3.

    {
        x += p.x;
        y += p.y;
        z += p.z;
        return *this;
    }

operator*=() [1/2]

constexpr IPoint3 & operator*= ( const IPoint3 &  p )

inlineconstexpr

Member-wise, in-place multiplication of this vector.

    {
        x *= p.x;
        y *= p.y;
        z *= p.z;
        return *this;
    }

operator/=() [1/2]

IPoint3 & operator/= ( const IPoint3 &  p )

inline

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

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

operator*=() [2/2]

constexpr IPoint3 & operator*= ( int  f )

inlineconstexpr

Remarks

Multiplies this IPoint3 by an integer value.

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

operator/=() [2/2]

IPoint3 & operator/= ( int  f )

inline

Remarks

Divides this IPoint3 by an integer value.

    {
        assert(f != 0);
        x /= f;
        y /= f;
        z /= f;
        return *this;
    }

operator+=() [2/2]

constexpr IPoint3 & operator+= ( int  f )

inlineconstexpr

Remarks

Adds int point value to this IPoint3.

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

operator-=() [2/2]

constexpr IPoint3 & operator-= ( int  f )

inlineconstexpr

Remarks

Subtracts int point value from this IPoint3.

    {
        return *this += -f;
    }

operator-() [2/2]

constexpr IPoint3 operator- ( const IPoint3 &  p ) const

inlineconstexpr

Remarks

Subtracts a IPoint3 from a IPoint3.

    {
        return IPoint3(x - p.x, y - p.y, z - p.z);
    }

operator+() [2/2]

constexpr IPoint3 operator+ ( const IPoint3 &  p ) const

inlineconstexpr

Remarks

Adds a IPoint3 to a IPoint3.

    {
        return IPoint3(x + p.x, y + p.y, z + p.z);
    }

operator*()

constexpr IPoint3 operator* ( const IPoint3 &  p ) const

inlineconstexpr

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

    {
        return IPoint3(x * p.x, y * p.y, z * p.z);
    }

operator/()

IPoint3 operator/ ( const IPoint3 &  p ) const

inline

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

    {
        assert(p.x != 0 && p.y != 0 && p.z != 0);
        return IPoint3(x / p.x, y / p.y, z / p.z);
    }

DotProd()

constexpr int DotProd ( const IPoint3 &  p ) const

inlineconstexpr

Remarks

Returns the dot product of two IPoint3s.

    {
        return x * p.x + y * p.y + z * p.z;
    }

operator%()

constexpr int operator% ( const IPoint3 &  p ) const

inlineconstexpr

    {
        return DotProd(p);
    }

CrossProd()

constexpr IPoint3 CrossProd ( const IPoint3 &  p ) const

inlineconstexpr

Remarks

The cross product of two IPoint3's (vectors).

    {
        return IPoint3(y * p.z - z * p.y, z * p.x - x * p.z, x * p.y - y * p.x);
    }

operator^()

constexpr IPoint3 operator^ ( const IPoint3 &  p ) const

inlineconstexpr

Remarks

The cross product of two IPoint3's (vectors).

    {
        return CrossProd(p);
    }

operator==()

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

inlineconstexpr

Remarks

Test for equality between two IPoint3's.

Returns

true if the IPoint3's are equal; otherwise false.

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

operator!=()

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

inlineconstexpr

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

Member Data Documentation

x

int x = 0

y

int y = 0

z

int z = 0

Origin

const IPoint3 Origin

static

XAxis

const IPoint3 XAxis

static

YAxis

const IPoint3 YAxis

static

ZAxis

const IPoint3 ZAxis

static