Point4 Class Reference

#include <point4.h>

Public Member Functions
	Point4 ()=default
	Initializes vector components to zero. More...
constexpr	Point4 (const Point4 &)=default
constexpr	Point4 (Point4 &&)=default
Point4 &	operator= (const Point4 &)=default
Point4 &	operator= (Point4 &&)=default
constexpr	Point4 (float X, float Y, float Z, float W)
constexpr	Point4 (double X, double Y, double Z, double W)
constexpr	Point4 (int X, int Y, int Z, int W)
constexpr	Point4 (const Point3 &a, float W=0.f)
constexpr	Point4 (const float af[4])
	Point4 (const AColor &c)
float &	operator[] (int i)
const float &	operator[] (int i) const
constexpr	operator float * ()
constexpr	operator const float * () const
constexpr Point4	operator- () const
constexpr Point4	operator+ () const
constexpr float	LengthSquared () const
float	Length () const
float	FLength () const
int	MaxComponent () const
int	MinComponent () const
Point4	Normalize () const
Point4	FNormalize () const
constexpr Point4 &	operator-= (const Point4 &a)
constexpr Point4 &	operator+= (const Point4 &a)
constexpr Point4 &	operator*= (const Point4 &a)
Point4 &	operator/= (const Point4 &a)
constexpr Point4 &	operator+= (float f)
constexpr Point4 &	operator-= (float f)
constexpr Point4 &	operator*= (float f)
Point4 &	operator/= (float f)
constexpr Point4 &	Set (float X, float Y, float Z, float W)
constexpr bool	operator== (const Point4 &p) const
constexpr bool	operator!= (const Point4 &p) const
bool	Equals (const Point4 &p, float epsilon=1E-6f) const
Point4 &	Unify ()
float	LengthUnify ()
constexpr Point4	operator- (const Point4 &a) const
constexpr Point4	operator+ (const Point4 &a) const
Point4	operator/ (const Point4 &a) const
constexpr Point4	operator* (const Point4 &a) const
constexpr float	DotProd (const Point4 &a) const
constexpr float	operator% (const Point4 &a) const

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

Static Public Attributes
static const Point4	Origin
static const Point4	XAxis
static const Point4	YAxis
static const Point4	ZAxis
static const Point4	WAxis

Detailed Description

See also

Class Point3.

Description:

This class describes a point using float x, y, z and w coordinates. Methods are provided to add and subtract points, multiply and divide by scalars, and element by element multiply and divide two points.

Data Members:

float x, y, z, w;

The x, y, z and w components of the point.

static const Point4 Origin;

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

static const Point4 XAxis;

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

static const Point4 YAxis;

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

static const Point4 ZAxis;

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

static const Point4 WAxis;

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

Constructor & Destructor Documentation

Point4() [1/9]

Point4 ( )

default

Initializes vector components to zero.

Point4() [2/9]

constexpr Point4 ( const Point4 &  )

constexprdefault

Point4() [3/9]

constexpr Point4 ( Point4 &&  )

constexprdefault

Point4() [4/9]

constexpr Point4 ( float  X, float  Y, float  Z, float  W  )

inlineconstexpr

Remarks

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

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

Point4() [5/9]

constexpr Point4 ( double  X, double  Y, double  Z, double  W  )

inlineconstexpr

Remarks

Constructor. x, y, z and w are initialized to the specified values (cast as floats).

: Point4(float(X), float(Y), float(Z), float(W)) {}

Point4() [6/9]

constexpr Point4 ( int  X, int  Y, int  Z, int  W  )

inlineconstexpr

Remarks

Constructor. x, y, z and w are initialized to the specified values (cast as floats).

: Point4(float(X), float(Y), float(Z), float(W)) {}

Point4() [7/9]

constexpr Point4 ( const Point3 &  a, float  W = 0.f  )

inlineconstexpr

Remarks

Constructor. x, y, z and w are initialized to the specified Point3 and W.

: x(a.x), y(a.y), z(a.z), w(W) {}

Point4() [8/9]

constexpr Point4 ( const float  af[4] )

inlineconstexpr

Remarks

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

: x(af[0]), y(af[1]), z(af[2]), w(af[3]) {}

Point4() [9/9]

Point4 ( const AColor &  c )

explicit

Member Function Documentation

operator=() [1/2]

Point4& operator= ( const Point4 &  )

default

operator=() [2/2]

Point4& operator= ( Point4 &&  )

default

operator[]() [1/2]

float& operator[] ( int  i )

inline

Remarks

Allows access to x, y, z and w using the subscript operator.

Returns

An value for i of 0 will return x, 1 will return y, 2 will return z and 3 will return w.

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

operator[]() [2/2]

const float& operator[] ( int  i ) const

inline

Remarks

Allows access to x, y, z and w using the subscript operator.

Returns

An value for i of 0 will return x, 1 will return y, 2 will return z and 3 will return w.

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

operator float *()

constexpr operator float * ( )

inlineconstexpr

Remarks

Conversion function. Returns the address of the Point4.x

    {
        return &x;
    }

operator const float *()

constexpr operator const float * ( ) const

inlineconstexpr

    {
        return &x;
    }

operator-() [1/2]

constexpr Point4 operator- ( ) const

inlineconstexpr

Remarks

Unary - operator. Negates x, y, z and w.

    {
        return Point4(-x, -y, -z, -w);
    }

operator+() [1/2]

constexpr Point4 operator+ ( ) const

inlineconstexpr

Remarks

Unary +. Returns the Point4.

    {
        return *this;
    }

LengthSquared()

constexpr float LengthSquared ( ) const

inlineconstexpr

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

Length()

float Length ( ) const

inline

    {
        return (float)sqrt((double)LengthSquared());
    }

FLength()

float FLength ( ) const

inline

    {
        return sqrt(LengthSquared());
    }

MaxComponent()

int MaxComponent

(

)

const

MinComponent()

int MinComponent

(

)

const

Normalize()

Point4 Normalize

(

)

const

FNormalize()

Point4 FNormalize

(

)

const

operator-=() [1/2]

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

inlineconstexpr

Remarks

Subtracts a Point4 from this Point4.

Returns

A Point4 that is the difference between two Point4s.

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

operator+=() [1/2]

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

inlineconstexpr

Remarks

Adds a Point4 to this Point4.

Returns

A Point4 that is the sum of two Point4s.

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

operator*=() [1/2]

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

inlineconstexpr

Remarks

Element-by-element multiplication of two Point4s:

(x*x, y*y, z*z, w*w).

Returns

A Point4 element-by-element multiplied by another Point4.

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

operator/=() [1/2]

Point4& operator/= ( const Point4 &  a )

inline

Remarks

Element-by-element division of two Point4s:

(x/x, y/y, z/z, w/w).

Returns

A Point4 element-by-element divided by another Point4.

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

operator+=() [2/2]

constexpr Point4& operator+= ( float  f )

inlineconstexpr

Remarks

Adds floating point value to this Point4.

Returns

A Point4 + a float.

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

operator-=() [2/2]

constexpr Point4& operator-= ( float  f )

inlineconstexpr

Remarks

Subtracts a floating point value from this Point4.

Returns

A Point4 - a float.

    {
        return *this += -f;
    }

operator*=() [2/2]

constexpr Point4& operator*= ( float  f )

inlineconstexpr

Remarks

Multiplies this Point4 by a floating point value.

Returns

A Point4 multiplied by a float.

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

operator/=() [2/2]

Point4& operator/= ( float  f )

inline

Remarks

Divides this Point4 by a floating point value.

Returns

A Point4 divided by a float.

    {
        assert(f != 0.f);
        if (f == 0.f)
            f = .000001f;
        return *this *= (1.f / f);
    }

Set()

constexpr Point4& Set ( float  X, float  Y, float  Z, float  W  )

inlineconstexpr

Remarks

Sets the x, y, z and w coordinate to the values passed and returns a reference to this Point4.

Parameters:

float X

The new x value.

float Y

The new y value.

float Z

The new z value.

float W

The new w value.

Returns

A reference to this Point4.

    {
        return *this = { X, Y, Z, W };
    }

operator==()

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

inlineconstexpr

Remarks

Equality operator. Test for equality between two Point4's.

Returns

Nonzero if the Point4's are equal; otherwise 0.

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

operator!=()

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

inlineconstexpr

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

Equals()

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

Remarks

Compares this Point4 and the specified one to see if the x, y, z and w values are within plus or minus the specified tolerance.

Parameters:

const Point4& p

The point to compare.

float epsilon = 1E-6f

The tolerance to use in the comparison.

Returns

Nonzero if the points are 'equal'; otherwise zero.

Operators:

Unify()

Point4& Unify

(

)

LengthUnify()

float LengthUnify

(

)

operator-() [2/2]

constexpr Point4 operator- ( const Point4 &  a ) const

inlineconstexpr

Remarks

Subtracts a Point4 from a Point4.

Returns

A Point4 that is the difference between two Point4s.

    {
        return Point4(*this) -= a;
    }

operator+() [2/2]

constexpr Point4 operator+ ( const Point4 &  a ) const

inlineconstexpr

Remarks

Adds a Point4 to a Point4.

Returns

A Point4 that is the sum of two Point4s.

    {
        return Point4(*this) += a;
    }

operator/()

Point4 operator/ ( const Point4 &  a ) const

inline

Remarks

Divides a Point4 by a Point4 element by element.

Returns

A Point4 resulting from dividing a Point4 by a Point4 element by element.

    {
        return Point4(*this) /= a;
    }

operator*()

constexpr Point4 operator* ( const Point4 &  a ) const

inlineconstexpr

Remarks

Multiplies a Point4 by a Point4 element by element.

(x*x, y*y, z*z, w*w).

Returns

A Point4 resulting from the multiplication of a Point4 and a Point4.

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

DotProd()

constexpr float DotProd ( const Point4 &  a ) const

inlineconstexpr

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

operator%()

constexpr float operator% ( const Point4 &  a ) const

inlineconstexpr

    {
        return DotProd(a);
    }

Member Data Documentation

x

float x = 0.f

y

float y = 0.f

z

float z = 0.f

w

float w = 0.f

Origin

const Point4 Origin

static

XAxis

const Point4 XAxis

static

YAxis

const Point4 YAxis

static

ZAxis

const Point4 ZAxis

static

WAxis

const Point4 WAxis

static