Vec4 Class Reference

#include <Vec4.h>

Public Types
using	Type = struct { float mData[4]; }

Public Member Functions
	Vec4 ()=default
	Constructor.
	Vec4 (const Vec4 &inRHS)=default
Vec4 &	operator= (const Vec4 &inRHS)=default
JPH_INLINE	Vec4 (Vec3Arg inRHS)
	WARNING: W component undefined!
JPH_INLINE	Vec4 (Vec3Arg inRHS, float inW)
JPH_INLINE	Vec4 (Type inRHS)
JPH_INLINE	Vec4 (float inX, float inY, float inZ, float inW)
	Create a vector from 4 components.
JPH_INLINE float	GetX () const
	Get individual components.
JPH_INLINE float	GetY () const
JPH_INLINE float	GetZ () const
JPH_INLINE float	GetW () const
JPH_INLINE void	SetX (float inX)
	Set individual components.
JPH_INLINE void	SetY (float inY)
JPH_INLINE void	SetZ (float inZ)
JPH_INLINE void	SetW (float inW)
JPH_INLINE void	Set (float inX, float inY, float inZ, float inW)
	Set all components.
JPH_INLINE float	operator[] (uint inCoordinate) const
	Get float component by index.
JPH_INLINE float &	operator[] (uint inCoordinate)
JPH_INLINE bool	operator== (Vec4Arg inV2) const
	Comparison.
JPH_INLINE bool	operator!= (Vec4Arg inV2) const
JPH_INLINE bool	IsClose (Vec4Arg inV2, float inMaxDistSq=1.0e-12f) const
	Test if two vectors are close.
JPH_INLINE bool	IsNearZero (float inMaxDistSq=1.0e-12f) const
	Test if vector is near zero.
JPH_INLINE bool	IsNormalized (float inTolerance=1.0e-6f) const
	Test if vector is normalized.
JPH_INLINE bool	IsNaN () const
	Test if vector contains NaN elements.
JPH_INLINE Vec4	operator* (Vec4Arg inV2) const
	Multiply two float vectors (component wise)
JPH_INLINE Vec4	operator* (float inV2) const
	Multiply vector with float.
JPH_INLINE Vec4	operator/ (float inV2) const
	Divide vector by float.
JPH_INLINE Vec4 &	operator*= (float inV2)
	Multiply vector with float.
JPH_INLINE Vec4 &	operator*= (Vec4Arg inV2)
	Multiply vector with vector.
JPH_INLINE Vec4 &	operator/= (float inV2)
	Divide vector by float.
JPH_INLINE Vec4	operator+ (Vec4Arg inV2) const
	Add two float vectors (component wise)
JPH_INLINE Vec4 &	operator+= (Vec4Arg inV2)
	Add two float vectors (component wise)
JPH_INLINE Vec4	operator- () const
	Negate.
JPH_INLINE Vec4	operator- (Vec4Arg inV2) const
	Subtract two float vectors (component wise)
JPH_INLINE Vec4 &	operator-= (Vec4Arg inV2)
	Subtract two float vectors (component wise)
JPH_INLINE Vec4	operator/ (Vec4Arg inV2) const
	Divide (component wise)
template<uint32 SwizzleX, uint32 SwizzleY, uint32 SwizzleZ, uint32 SwizzleW>
JPH_INLINE Vec4	Swizzle () const
	Swizzle the elements in inV.
JPH_INLINE Vec4	SplatX () const
	Replicate the X component to all components.
JPH_INLINE Vec4	SplatY () const
	Replicate the Y component to all components.
JPH_INLINE Vec4	SplatZ () const
	Replicate the Z component to all components.
JPH_INLINE Vec4	SplatW () const
	Replicate the W component to all components.
JPH_INLINE Vec3	SplatX3 () const
	Replicate the X component to all components.
JPH_INLINE Vec3	SplatY3 () const
	Replicate the Y component to all components.
JPH_INLINE Vec3	SplatZ3 () const
	Replicate the Z component to all components.
JPH_INLINE Vec3	SplatW3 () const
	Replicate the W component to all components.
JPH_INLINE int	GetLowestComponentIndex () const
	Get index of component with lowest value.
JPH_INLINE int	GetHighestComponentIndex () const
	Get index of component with highest value.
JPH_INLINE Vec4	Abs () const
	Return the absolute value of each of the components.
JPH_INLINE Vec4	Reciprocal () const
	Reciprocal vector (1 / value) for each of the components.
JPH_INLINE Vec4	DotV (Vec4Arg inV2) const
	Dot product, returns the dot product in X, Y, Z and W components.
JPH_INLINE float	Dot (Vec4Arg inV2) const
	Dot product.
JPH_INLINE float	LengthSq () const
	Squared length of vector.
JPH_INLINE float	Length () const
	Length of vector.
JPH_INLINE Vec4	Normalized () const
	Normalize vector.
JPH_INLINE void	StoreFloat4 (Float4 *outV) const
	Store 4 floats to memory.
JPH_INLINE UVec4	ToInt () const
	Convert each component from a float to an int.
JPH_INLINE UVec4	ReinterpretAsInt () const
	Reinterpret Vec4 as a UVec4 (doesn't change the bits)
JPH_INLINE int	GetSignBits () const
	Store if X is negative in bit 0, Y in bit 1, Z in bit 2 and W in bit 3.
JPH_INLINE float	ReduceMin () const
	Get the minimum of X, Y, Z and W.
JPH_INLINE float	ReduceMax () const
	Get the maximum of X, Y, Z and W.
JPH_INLINE Vec4	Sqrt () const
	Component wise square root.
JPH_INLINE Vec4	GetSign () const
	Get vector that contains the sign of each element (returns 1.0f if positive, -1.0f if negative)
template<int X, int Y, int Z, int W>
JPH_INLINE Vec4	FlipSign () const
	Flips the signs of the components, e.g. FlipSign<-1, 1, -1, 1>() will flip the signs of the X and Z components.
void	SinCos (Vec4 &outSin, Vec4 &outCos) const
	Calculate the sine and cosine for each element of this vector (input in radians)
Vec4	Tan () const
	Calculate the tangent for each element of this vector (input in radians)
Vec4	ASin () const
Vec4	ACos () const
Vec4	ATan () const
	Calculate the arc tangent for each element of this vector (returns value in the range [-PI / 2, PI / 2])
JPH_INLINE uint32	CompressUnitVector () const
	Compress a unit vector to a 32 bit value, precision is around 0.5 * 10^-3.
template<uint32 SwizzleX, uint32 SwizzleY, uint32 SwizzleZ, uint32 SwizzleW>
Vec4	Swizzle () const
template<const int Scale>
Vec4	sGatherFloat4 (const float *inBase, UVec4Arg inOffsets)

Static Public Member Functions
static JPH_INLINE Vec4	sZero ()
	Vector with all zeros.
static JPH_INLINE Vec4	sOne ()
	Vector with all ones.
static JPH_INLINE Vec4	sNaN ()
	Vector with all NaN's.
static JPH_INLINE Vec4	sReplicate (float inV)
	Replicate inV across all components.
static JPH_INLINE Vec4	sLoadFloat4 (const Float4 *inV)
	Load 4 floats from memory.
static JPH_INLINE Vec4	sLoadFloat4Aligned (const Float4 *inV)
	Load 4 floats from memory, 16 bytes aligned.
template<const int Scale>
static JPH_INLINE Vec4	sGatherFloat4 (const float *inBase, UVec4Arg inOffsets)
	Gather 4 floats from memory at inBase + inOffsets[i] * Scale.
static JPH_INLINE Vec4	sMin (Vec4Arg inV1, Vec4Arg inV2)
	Return the minimum value of each of the components.
static JPH_INLINE Vec4	sMax (Vec4Arg inV1, Vec4Arg inV2)
	Return the maximum of each of the components.
static JPH_INLINE Vec4	sClamp (Vec4Arg inV, Vec4Arg inMin, Vec4Arg inMax)
	Clamp a vector between min and max (component wise)
static JPH_INLINE UVec4	sEquals (Vec4Arg inV1, Vec4Arg inV2)
	Equals (component wise)
static JPH_INLINE UVec4	sLess (Vec4Arg inV1, Vec4Arg inV2)
	Less than (component wise)
static JPH_INLINE UVec4	sLessOrEqual (Vec4Arg inV1, Vec4Arg inV2)
	Less than or equal (component wise)
static JPH_INLINE UVec4	sGreater (Vec4Arg inV1, Vec4Arg inV2)
	Greater than (component wise)
static JPH_INLINE UVec4	sGreaterOrEqual (Vec4Arg inV1, Vec4Arg inV2)
	Greater than or equal (component wise)
static JPH_INLINE Vec4	sFusedMultiplyAdd (Vec4Arg inMul1, Vec4Arg inMul2, Vec4Arg inAdd)
	Calculates inMul1 * inMul2 + inAdd.
static JPH_INLINE Vec4	sSelect (Vec4Arg inNotSet, Vec4Arg inSet, UVec4Arg inControl)
	Component wise select, returns inNotSet when highest bit of inControl = 0 and inSet when highest bit of inControl = 1.
static JPH_INLINE Vec4	sOr (Vec4Arg inV1, Vec4Arg inV2)
	Logical or (component wise)
static JPH_INLINE Vec4	sXor (Vec4Arg inV1, Vec4Arg inV2)
	Logical xor (component wise)
static JPH_INLINE Vec4	sAnd (Vec4Arg inV1, Vec4Arg inV2)
	Logical and (component wise)
static JPH_INLINE void	sSort4 (Vec4 &ioValue, UVec4 &ioIndex)
static JPH_INLINE void	sSort4Reverse (Vec4 &ioValue, UVec4 &ioIndex)
static Vec4	sATan2 (Vec4Arg inY, Vec4Arg inX)
	Calculate the arc tangent of y / x using the signs of the arguments to determine the correct quadrant (returns value in the range [-PI, PI])
static JPH_INLINE Vec4	sDecompressUnitVector (uint32 inValue)
	Decompress a unit vector from a 32 bit value.

Public Attributes
union {
Type   mValue
float   mF32 [4]
};

Friends
JPH_INLINE Vec4	operator* (float inV1, Vec4Arg inV2)
	Multiply vector with float.
ostream &	operator<< (ostream &inStream, Vec4Arg inV)
	To String.

Member Typedef Documentation

Type

using Vec4::Type = struct { float mData[4]; }

Constructor & Destructor Documentation

Vec4() [1/6]

Vec4::Vec4 ( )

default

Constructor.

Intentionally not initialized for performance reasons

Vec4() [2/6]

Vec4::Vec4 ( const Vec4 & inRHS )

default

Vec4() [3/6]

JPH_NAMESPACE_BEGIN Vec4::Vec4 ( Vec3Arg inRHS )

explicit

WARNING: W component undefined!

Vec4() [4/6]

Vec4::Vec4	(	Vec3Arg	inRHS,
		float	inW )

Vec4() [5/6]

JPH_INLINE Vec4::Vec4 ( Type inRHS )

inline

Vec4() [6/6]

Vec4::Vec4	(	float	inX,
		float	inY,
		float	inZ,
		float	inW )

Create a vector from 4 components.

Member Function Documentation

Abs()

Vec4 Vec4::Abs

(

)

const

Return the absolute value of each of the components.

ACos()

Vec4 Vec4::ACos ( ) const

inline

Calculate the arc cosine for each element of this vector (returns value in the range [0, PI]) Note that all input values will be clamped to the range [-1, 1] and this function will not return NaNs like std::acos

ASin()

Vec4 Vec4::ASin ( ) const

inline

Calculate the arc sine for each element of this vector (returns value in the range [-PI / 2, PI / 2]) Note that all input values will be clamped to the range [-1, 1] and this function will not return NaNs like std::asin

ATan()

Vec4 Vec4::ATan ( ) const

inline

Calculate the arc tangent for each element of this vector (returns value in the range [-PI / 2, PI / 2])

CompressUnitVector()

uint32 Vec4::CompressUnitVector

(

)

const

Compress a unit vector to a 32 bit value, precision is around 0.5 * 10^-3.

Dot()

float Vec4::Dot

(

Vec4Arg

inV2

)

const

Dot product.

DotV()

Vec4 Vec4::DotV

(

Vec4Arg

inV2

)

const

Dot product, returns the dot product in X, Y, Z and W components.

FlipSign()

template<int X, int Y, int Z, int W>

JPH_INLINE Vec4 Vec4::FlipSign

(

)

const

Flips the signs of the components, e.g. FlipSign<-1, 1, -1, 1>() will flip the signs of the X and Z components.

GetHighestComponentIndex()

int Vec4::GetHighestComponentIndex

(

)

const

Get index of component with highest value.

GetLowestComponentIndex()

int Vec4::GetLowestComponentIndex

(

)

const

Get index of component with lowest value.

GetSign()

Vec4 Vec4::GetSign

(

)

const

Get vector that contains the sign of each element (returns 1.0f if positive, -1.0f if negative)

GetSignBits()

int Vec4::GetSignBits

(

)

const

Store if X is negative in bit 0, Y in bit 1, Z in bit 2 and W in bit 3.

GetW()

JPH_INLINE float Vec4::GetW ( ) const

inline

GetX()

JPH_INLINE float Vec4::GetX ( ) const

inline

Get individual components.

GetY()

JPH_INLINE float Vec4::GetY ( ) const

inline

GetZ()

JPH_INLINE float Vec4::GetZ ( ) const

inline

IsClose()

bool Vec4::IsClose	(	Vec4Arg	inV2,
		float	inMaxDistSq = 1.0e-12f ) const

Test if two vectors are close.

IsNaN()

bool Vec4::IsNaN

(

)

const

Test if vector contains NaN elements.

IsNearZero()

bool Vec4::IsNearZero

(

float

inMaxDistSq = 1.0e-12f

)

const

Test if vector is near zero.

IsNormalized()

bool Vec4::IsNormalized

(

float

inTolerance = 1.0e-6f

)

const

Test if vector is normalized.

Length()

float Vec4::Length

(

)

const

Length of vector.

LengthSq()

float Vec4::LengthSq

(

)

const

Squared length of vector.

Normalized()

Vec4 Vec4::Normalized

(

)

const

Normalize vector.

operator!=()

JPH_INLINE bool Vec4::operator!= ( Vec4Arg inV2 ) const

inline

operator*() [1/2]

Vec4 Vec4::operator*

(

float

inV2

)

const

Multiply vector with float.

operator*() [2/2]

Vec4 Vec4::operator*

(

Vec4Arg

inV2

)

const

Multiply two float vectors (component wise)

operator*=() [1/2]

Vec4 & Vec4::operator*=

(

float

inV2

)

Multiply vector with float.

operator*=() [2/2]

Vec4 & Vec4::operator*=

(

Vec4Arg

inV2

)

Multiply vector with vector.

operator+()

Vec4 Vec4::operator+

(

Vec4Arg

inV2

)

const

Add two float vectors (component wise)

operator+=()

Vec4 & Vec4::operator+=

(

Vec4Arg

inV2

)

Add two float vectors (component wise)

operator-() [1/2]

Vec4 Vec4::operator-

(

)

const

Negate.

operator-() [2/2]

Vec4 Vec4::operator-

(

Vec4Arg

inV2

)

const

Subtract two float vectors (component wise)

operator-=()

Vec4 & Vec4::operator-=

(

Vec4Arg

inV2

)

Subtract two float vectors (component wise)

operator/() [1/2]

Vec4 Vec4::operator/

(

float

inV2

)

const

Divide vector by float.

operator/() [2/2]

Vec4 Vec4::operator/

(

Vec4Arg

inV2

)

const

Divide (component wise)

operator/=()

Vec4 & Vec4::operator/=

(

float

inV2

)

Divide vector by float.

operator=()

Vec4 & Vec4::operator= ( const Vec4 & inRHS )

default

operator==()

bool Vec4::operator==

(

Vec4Arg

inV2

)

const

Comparison.

operator[]() [1/2]

JPH_INLINE float & Vec4::operator[] ( uint inCoordinate )

inline

operator[]() [2/2]

JPH_INLINE float Vec4::operator[] ( uint inCoordinate ) const

inline

Get float component by index.

Reciprocal()

Vec4 Vec4::Reciprocal

(

)

const

Reciprocal vector (1 / value) for each of the components.

ReduceMax()

float Vec4::ReduceMax

(

)

const

Get the maximum of X, Y, Z and W.

ReduceMin()

float Vec4::ReduceMin

(

)

const

Get the minimum of X, Y, Z and W.

ReinterpretAsInt()

UVec4 Vec4::ReinterpretAsInt

(

)

const

Reinterpret Vec4 as a UVec4 (doesn't change the bits)

sAnd()

Vec4 Vec4::sAnd ( Vec4Arg inV1, Vec4Arg inV2 )

static

Logical and (component wise)

sATan2()

Vec4 Vec4::sATan2 ( Vec4Arg inY, Vec4Arg inX )

inlinestatic

Calculate the arc tangent of y / x using the signs of the arguments to determine the correct quadrant (returns value in the range [-PI, PI])

sClamp()

Vec4 Vec4::sClamp ( Vec4Arg inV, Vec4Arg inMin, Vec4Arg inMax )

static

Clamp a vector between min and max (component wise)

sDecompressUnitVector()

Vec4 Vec4::sDecompressUnitVector ( uint32 inValue )

static

Decompress a unit vector from a 32 bit value.

sEquals()

UVec4 Vec4::sEquals ( Vec4Arg inV1, Vec4Arg inV2 )

static

Equals (component wise)

Set()

JPH_INLINE void Vec4::Set ( float inX, float inY, float inZ, float inW )

inline

Set all components.

SetW()

JPH_INLINE void Vec4::SetW ( float inW )

inline

SetX()

JPH_INLINE void Vec4::SetX ( float inX )

inline

Set individual components.

SetY()

JPH_INLINE void Vec4::SetY ( float inY )

inline

SetZ()

JPH_INLINE void Vec4::SetZ ( float inZ )

inline

sFusedMultiplyAdd()

Vec4 Vec4::sFusedMultiplyAdd ( Vec4Arg inMul1, Vec4Arg inMul2, Vec4Arg inAdd )

static

Calculates inMul1 * inMul2 + inAdd.

sGatherFloat4() [1/2]

template<const int Scale>

static JPH_INLINE Vec4 Vec4::sGatherFloat4 ( const float * inBase, UVec4Arg inOffsets )

static

Gather 4 floats from memory at inBase + inOffsets[i] * Scale.

sGatherFloat4() [2/2]

template<const int Scale>

Vec4 Vec4::sGatherFloat4	(	const float *	inBase,
		UVec4Arg	inOffsets )

sGreater()

UVec4 Vec4::sGreater ( Vec4Arg inV1, Vec4Arg inV2 )

static

Greater than (component wise)

sGreaterOrEqual()

UVec4 Vec4::sGreaterOrEqual ( Vec4Arg inV1, Vec4Arg inV2 )

static

Greater than or equal (component wise)

SinCos()

void Vec4::SinCos ( Vec4 & outSin, Vec4 & outCos ) const

inline

Calculate the sine and cosine for each element of this vector (input in radians)

sLess()

UVec4 Vec4::sLess ( Vec4Arg inV1, Vec4Arg inV2 )

static

Less than (component wise)

sLessOrEqual()

UVec4 Vec4::sLessOrEqual ( Vec4Arg inV1, Vec4Arg inV2 )

static

Less than or equal (component wise)

sLoadFloat4()

Vec4 Vec4::sLoadFloat4 ( const Float4 * inV )

static

Load 4 floats from memory.

sLoadFloat4Aligned()

Vec4 Vec4::sLoadFloat4Aligned ( const Float4 * inV )

static

Load 4 floats from memory, 16 bytes aligned.

sMax()

Vec4 Vec4::sMax ( Vec4Arg inV1, Vec4Arg inV2 )

static

Return the maximum of each of the components.

sMin()

Vec4 Vec4::sMin ( Vec4Arg inV1, Vec4Arg inV2 )

static

Return the minimum value of each of the components.

sNaN()

Vec4 Vec4::sNaN ( )

static

Vector with all NaN's.

sOne()

Vec4 Vec4::sOne ( )

static

Vector with all ones.

sOr()

Vec4 Vec4::sOr ( Vec4Arg inV1, Vec4Arg inV2 )

static

Logical or (component wise)

SplatW()

Vec4 Vec4::SplatW

(

)

const

Replicate the W component to all components.

SplatW3()

Vec3 Vec4::SplatW3

(

)

const

Replicate the W component to all components.

SplatX()

Vec4 Vec4::SplatX

(

)

const

Replicate the X component to all components.

SplatX3()

Vec3 Vec4::SplatX3

(

)

const

Replicate the X component to all components.

SplatY()

Vec4 Vec4::SplatY

(

)

const

Replicate the Y component to all components.

SplatY3()

Vec3 Vec4::SplatY3

(

)

const

Replicate the Y component to all components.

SplatZ()

Vec4 Vec4::SplatZ

(

)

const

Replicate the Z component to all components.

SplatZ3()

Vec3 Vec4::SplatZ3

(

)

const

Replicate the Z component to all components.

Sqrt()

Vec4 Vec4::Sqrt

(

)

const

Component wise square root.

sReplicate()

Vec4 Vec4::sReplicate ( float inV )

static

Replicate inV across all components.

sSelect()

Vec4 Vec4::sSelect ( Vec4Arg inNotSet, Vec4Arg inSet, UVec4Arg inControl )

static

Component wise select, returns inNotSet when highest bit of inControl = 0 and inSet when highest bit of inControl = 1.

sSort4()

void Vec4::sSort4 ( Vec4 & ioValue, UVec4 & ioIndex )

static

Sort the four elements of ioValue and sort ioIndex at the same time. Based on a sorting network: http://en.wikipedia.org/wiki/Sorting_network

sSort4Reverse()

void Vec4::sSort4Reverse ( Vec4 & ioValue, UVec4 & ioIndex )

static

Reverse sort the four elements of ioValue (highest first) and sort ioIndex at the same time. Based on a sorting network: http://en.wikipedia.org/wiki/Sorting_network

StoreFloat4()

void Vec4::StoreFloat4

(

Float4 *

outV

)

const

Store 4 floats to memory.

Swizzle() [1/2]

template<uint32 SwizzleX, uint32 SwizzleY, uint32 SwizzleZ, uint32 SwizzleW>

JPH_INLINE Vec4 Vec4::Swizzle

(

)

const

Swizzle the elements in inV.

Swizzle() [2/2]

template<uint32 SwizzleX, uint32 SwizzleY, uint32 SwizzleZ, uint32 SwizzleW>

Vec4 Vec4::Swizzle

(

)

const

sXor()

Vec4 Vec4::sXor ( Vec4Arg inV1, Vec4Arg inV2 )

static

Logical xor (component wise)

sZero()

Vec4 Vec4::sZero ( )

static

Vector with all zeros.

Tan()

Vec4 Vec4::Tan ( ) const

inline

Calculate the tangent for each element of this vector (input in radians)

ToInt()

UVec4 Vec4::ToInt

(

)

const

Convert each component from a float to an int.

Friends And Related Symbol Documentation

operator*

JPH_INLINE Vec4 operator* ( float inV1, Vec4Arg inV2 )

friend

Multiply vector with float.

operator<<

ostream & operator<< ( ostream & inStream, Vec4Arg inV )

friend

To String.

Member Data Documentation

[union]

union { ... } Vec4

mF32

float Vec4::mF32[4]

mValue

Type Vec4::mValue

---

The documentation for this class was generated from the following files:

• Jolt/Math/Vec4.h
• Jolt/Math/Vec4.inl