EGG::Vector3f Struct Reference

#include <Vector.hh>

Description

A 3D float vector.

Definition at line 83 of file Vector.hh.

Public Member Functions
constexpr	Vector3f (f32 x_, f32 y_, f32 z_)
void	setZero ()
void	set (f32 val)
Vector3f	operator- () const
Vector3f	operator- (const Vector3f &rhs) const
Vector3f &	operator-= (const Vector3f &rhs)
Vector3f	operator+ (const Vector3f &rhs) const
Vector3f &	operator+= (const Vector3f &rhs)
Vector3f	operator+ (f32 val) const
Vector3f &	operator+= (f32 val)
Vector3f	operator* (const Vector3f &rhs) const
Vector3f	operator* (f32 scalar) const
Vector3f &	operator*= (f32 scalar)
Vector3f	operator/ (f32 scalar) const
Vector3f &	operator/= (f32 scalar)
bool	operator== (const Vector3f &rhs) const
bool	operator!= (const Vector3f &rhs) const
	operator std::string () const
	Allows for copy construction from a vector to a string.
Vector3f	cross (const Vector3f &rhs) const
f32	squaredLength () const
	The dot product between the vector and itself.
f32	dot (const Vector3f &rhs) const
	The dot product between two vectors.
f32	length () const
	The square root of the vector's dot product.
Vector3f	proj (const Vector3f &rhs) const
	The projection of this vector onto rhs.
Vector3f	rej (const Vector3f &rhs) const
	The rejection of this vector onto rhs.
std::pair< Vector3f, Vector3f >	projAndRej (const Vector3f &rhs) const
Vector3f	abs () const
	Returns the absolute value of each element of the vector.
f32	sqDistance (const Vector3f &rhs) const
	The square of the distance between two vectors.
EGG::Vector3f	multInv (f32 val) const
	Multiplies a vector by the inverse of val.
f32	ps_dot () const
	Paired-singles dot product implementation.
f32	ps_dot (const EGG::Vector3f &rhs) const
	Paired-singles dot product implementation.
f32	ps_squareMag () const
	Differs from ps_dot due to variation in which operands are fused.
f32	normalise ()
	Normalizes the vector and returns the original length.
void	normalise2 ()
Vector3f	maximize (const Vector3f &rhs) const
	Returns a vector whose elements are the max of the elements of both vectors.
Vector3f	minimize (const Vector3f &rhs) const
	Returns a vector whose elements are the min of the elements of both vectors.
f32	ps_sqDistance (const Vector3f &rhs) const
	Paired-singles impl. of sqDistance.
Vector3f	perpInPlane (const EGG::Vector3f &rhs, bool normalise) const
	Calculates the orthogonal vector, based on the plane defined by this vector and rhs.
void	read (Stream &stream)
	Initializes a Vector3f by reading 12 bytes from the stream.

Public Attributes
f32	x
f32	y
f32	z

Static Public Attributes
static const Vector3f	zero = Vector3f(0.0f, 0.0f, 0.0f)
static const Vector3f	ex = Vector3f(1.0f, 0.0f, 0.0f)
static const Vector3f	ey = Vector3f(0.0f, 1.0f, 0.0f)
static const Vector3f	ez = Vector3f(0.0f, 0.0f, 1.0f)
static const Vector3f	inf

Constructor & Destructor Documentation

Vector3f()

EGG::Vector3f::Vector3f ( f32 x_, f32 y_, f32 z_ )

inlineconstexpr

Definition at line 92 of file Vector.hh.

Member Function Documentation

abs()

Vector3f EGG::Vector3f::abs ( ) const

inlinenodiscard

Returns the absolute value of each element of the vector.

Definition at line 209 of file Vector.hh.

cross()

Vector3f EGG::Vector3f::cross ( const Vector3f & rhs ) const

inlinenodiscard0x80214968

Definition at line 172 of file Vector.hh.

dot()

f32 EGG::Vector3f::dot ( const Vector3f & rhs ) const

inlinenodiscard

The dot product between two vectors.

Definition at line 182 of file Vector.hh.

length()

f32 EGG::Vector3f::length ( ) const

inlinenodiscard

The square root of the vector's dot product.

Definition at line 187 of file Vector.hh.

maximize()

Vector3f EGG::Vector3f::maximize ( const Vector3f & rhs ) const

nodiscard0x80085580

Returns a vector whose elements are the max of the elements of both vectors.

Definition at line 65 of file Vector.cc.

minimize()

Vector3f EGG::Vector3f::minimize ( const Vector3f & rhs ) const

nodiscard0x800855C0

Returns a vector whose elements are the min of the elements of both vectors.

Definition at line 77 of file Vector.cc.

multInv()

EGG::Vector3f EGG::Vector3f::multInv ( f32 val ) const

inlinenodiscard0x806A62A4

Multiplies a vector by the inverse of val.

Definition at line 221 of file Vector.hh.

normalise()

f32 EGG::Vector3f::normalise ( )

0x80243ADC

Normalizes the vector and returns the original length.

Returns

(optional) The length of the vector before normalisation.

Definition at line 44 of file Vector.cc.

normalise2()

void EGG::Vector3f::normalise2 ( )

0x80243B6C

Definition at line 56 of file Vector.cc.

operator std::string()

EGG::Vector3f::operator std::string ( ) const

inlineexplicit

Allows for copy construction from a vector to a string.

Definition at line 166 of file Vector.hh.

operator!=()

bool EGG::Vector3f::operator!= ( const Vector3f & rhs ) const

inline

Definition at line 161 of file Vector.hh.

operator*() [1/2]

Vector3f EGG::Vector3f::operator* ( const Vector3f & rhs ) const

inlinenodiscard

Definition at line 133 of file Vector.hh.

operator*() [2/2]

Vector3f EGG::Vector3f::operator* ( f32 scalar ) const

inlinenodiscard

Definition at line 137 of file Vector.hh.

operator*=()

Vector3f & EGG::Vector3f::operator*= ( f32 scalar )

inline

Definition at line 145 of file Vector.hh.

operator+() [1/2]

Vector3f EGG::Vector3f::operator+ ( const Vector3f & rhs ) const

inlinenodiscard

Definition at line 117 of file Vector.hh.

operator+() [2/2]

Vector3f EGG::Vector3f::operator+ ( f32 val ) const

inlinenodiscard

Definition at line 125 of file Vector.hh.

operator+=() [1/2]

Vector3f & EGG::Vector3f::operator+= ( const Vector3f & rhs )

inline

Definition at line 121 of file Vector.hh.

operator+=() [2/2]

Vector3f & EGG::Vector3f::operator+= ( f32 val )

inline

Definition at line 129 of file Vector.hh.

operator-() [1/2]

Vector3f EGG::Vector3f::operator- ( ) const

inlinenodiscard

Definition at line 105 of file Vector.hh.

operator-() [2/2]

Vector3f EGG::Vector3f::operator- ( const Vector3f & rhs ) const

inlinenodiscard

Definition at line 109 of file Vector.hh.

operator-=()

Vector3f & EGG::Vector3f::operator-= ( const Vector3f & rhs )

inline

Definition at line 113 of file Vector.hh.

operator/()

Vector3f EGG::Vector3f::operator/ ( f32 scalar ) const

inlinenodiscard

Definition at line 149 of file Vector.hh.

operator/=()

Vector3f & EGG::Vector3f::operator/= ( f32 scalar )

inline

Definition at line 153 of file Vector.hh.

operator==()

bool EGG::Vector3f::operator== ( const Vector3f & rhs ) const

inline

Definition at line 157 of file Vector.hh.

perpInPlane()

Vector3f EGG::Vector3f::perpInPlane ( const EGG::Vector3f & rhs, bool normalise ) const

nodiscard0x805AE9EC

Calculates the orthogonal vector, based on the plane defined by this vector and rhs.

Definition at line 96 of file Vector.cc.

proj()

Vector3f EGG::Vector3f::proj ( const Vector3f & rhs ) const

inlinenodiscard0x805AEB88

The projection of this vector onto rhs.

Definition at line 193 of file Vector.hh.

projAndRej()

std::pair< Vector3f, Vector3f > EGG::Vector3f::projAndRej ( const Vector3f & rhs ) const

inlinenodiscard0x805AEC24

Definition at line 204 of file Vector.hh.

ps_dot() [1/2]

f32 EGG::Vector3f::ps_dot ( ) const

nodiscard

Paired-singles dot product implementation.

Definition at line 22 of file Vector.cc.

ps_dot() [2/2]

f32 EGG::Vector3f::ps_dot ( const EGG::Vector3f & rhs ) const

nodiscard0x8019ACAC

Paired-singles dot product implementation.

Definition at line 28 of file Vector.cc.

ps_sqDistance()

f32 EGG::Vector3f::ps_sqDistance ( const Vector3f & rhs ) const

nodiscard0x8019ADE0

Paired-singles impl. of sqDistance.

Definition at line 89 of file Vector.cc.

ps_squareMag()

f32 EGG::Vector3f::ps_squareMag ( ) const

nodiscard

Differs from ps_dot due to variation in which operands are fused.

Definition at line 35 of file Vector.cc.

read()

void EGG::Vector3f::read

(

Stream &

stream

)

Initializes a Vector3f by reading 12 bytes from the stream.

Definition at line 115 of file Vector.cc.

rej()

Vector3f EGG::Vector3f::rej ( const Vector3f & rhs ) const

inlinenodiscard0x805AEBD0

The rejection of this vector onto rhs.

Definition at line 199 of file Vector.hh.

set()

void EGG::Vector3f::set ( f32 val )

inline

Definition at line 101 of file Vector.hh.

setZero()

void EGG::Vector3f::setZero ( )

inline

Definition at line 97 of file Vector.hh.

sqDistance()

f32 EGG::Vector3f::sqDistance ( const Vector3f & rhs ) const

inlinenodiscard

The square of the distance between two vectors.

Definition at line 214 of file Vector.hh.

squaredLength()

f32 EGG::Vector3f::squaredLength ( ) const

inlinenodiscard

The dot product between the vector and itself.

Definition at line 177 of file Vector.hh.

Member Data Documentation

ex

const Vector3f EGG::Vector3f::ex = Vector3f(1.0f, 0.0f, 0.0f)

static0x80384BB8

Definition at line 242 of file Vector.hh.

ey

const Vector3f EGG::Vector3f::ey = Vector3f(0.0f, 1.0f, 0.0f)

static0x80384BD0

Definition at line 242 of file Vector.hh.

ez

const Vector3f EGG::Vector3f::ez = Vector3f(0.0f, 0.0f, 1.0f)

static0x80384BE8

Definition at line 242 of file Vector.hh.

inf

const Vector3f EGG::Vector3f::inf

static0x809C3C04

Initial value:

= Vector3f(std::numeric_limits<f32>::infinity(),
        std::numeric_limits<f32>::infinity(), std::numeric_limits<f32>::infinity())

Definition at line 243 of file Vector.hh.

x

f32 EGG::Vector3f::x

Definition at line 237 of file Vector.hh.

y

f32 EGG::Vector3f::y

Definition at line 238 of file Vector.hh.

z

f32 EGG::Vector3f::z

Definition at line 239 of file Vector.hh.

zero

const Vector3f EGG::Vector3f::zero = Vector3f(0.0f, 0.0f, 0.0f)

static0x80384BA0

Definition at line 241 of file Vector.hh.