Plasma Engine  2.0
Loading...
Searching...
No Matches
plVec4Template< Type > Class Template Reference

A 4-component vector class. More...

#include <Vec4.h>

Public Types

using ComponentType = Type
 

Public Member Functions

 PL_DECLARE_POD_TYPE ()
 
 plVec4Template ()
 Default-constructed vector is uninitialized (for speed)
 
 plVec4Template (Type x, Type y, Type z, Type w)
 Initializes the vector with x,y,z,w.
 
 plVec4Template (plVec3Template< Type > vXyz, Type w)
 Initializes the vector from a vec3 and a float.
 
 plVec4Template (Type v)
 Initializes all 4 components with xyzw.
 
const plVec2Template< Type > GetAsVec2 () const
 Returns an plVec2Template with x and y from this vector.
 
const plVec3Template< Type > GetAsVec3 () const
 Returns an plVec3Template with x,y and z from this vector.
 
const Type * GetData () const
 Returns the data as an array.
 
Type * GetData ()
 Returns the data as an array.
 
void Set (Type xyzw)
 Sets all 4 components to this value.
 
void Set (Type x, Type y, Type z, Type w)
 Sets the vector to these values.
 
void SetZero ()
 Sets the vector to all zero.
 
PL_DECLARE_IF_FLOAT_TYPE Type GetLength () const
 Returns the length of the vector.
 
Type GetLengthSquared () const
 Returns the squared length. Faster, since no square-root is taken. Useful, if one only wants to compare the lengths of two vectors.
 
PL_DECLARE_IF_FLOAT_TYPE Type GetLengthAndNormalize ()
 Normalizes this vector and returns its previous length in one operation. More efficient than calling GetLength and then Normalize.
 
PL_DECLARE_IF_FLOAT_TYPE const plVec4Template< Type > GetNormalized () const
 Returns a normalized version of this vector, leaves the vector itself unchanged.
 
PL_DECLARE_IF_FLOAT_TYPE void Normalize ()
 Normalizes this vector.
 
PL_DECLARE_IF_FLOAT_TYPE plResult NormalizeIfNotZero (const plVec4Template< Type > &vFallback=plVec4Template< Type >(1, 0, 0, 0), Type fEpsilon=plMath::SmallEpsilon< Type >())
 Tries to normalize this vector. If the vector is too close to zero, PL_FAILURE is returned and the vector is set to the given fallback value.
 
bool IsZero () const
 Returns, whether this vector is (0, 0, 0, 0).
 
bool IsZero (Type fEpsilon) const
 Returns, whether this vector is (0, 0, 0, 0).
 
PL_DECLARE_IF_FLOAT_TYPE bool IsNormalized (Type fEpsilon=plMath::HugeEpsilon< Type >()) const
 Returns, whether the squared length of this vector is between 0.999f and 1.001f.
 
bool IsNaN () const
 Returns true, if any of x, y, z or w is NaN.
 
bool IsValid () const
 Checks that all components are finite numbers.
 
const plVec4Template< Type > operator- () const
 Returns the negation of this vector.
 
void operator+= (const plVec4Template< Type > &vCc)
 Adds cc component-wise to this vector.
 
void operator-= (const plVec4Template< Type > &vCc)
 Subtracts cc component-wise from this vector.
 
void operator*= (Type f)
 Multiplies all components of this vector with f.
 
void operator/= (Type f)
 Divides all components of this vector by f.
 
bool IsIdentical (const plVec4Template< Type > &rhs) const
 Equality Check (bitwise).
 
bool IsEqual (const plVec4Template< Type > &rhs, Type fEpsilon) const
 Equality Check with epsilon.
 
Type Dot (const plVec4Template< Type > &rhs) const
 Returns the dot-product of the two vectors (commutative, order does not matter).
 
const plVec4Template< Type > CompMin (const plVec4Template< Type > &rhs) const
 Returns the component-wise minimum of *this and rhs.
 
const plVec4Template< Type > CompMax (const plVec4Template< Type > &rhs) const
 Returns the component-wise maximum of *this and rhs.
 
const plVec4Template< Type > CompClamp (const plVec4Template< Type > &vLow, const plVec4Template< Type > &vHigh) const
 Returns the component-wise clamped value of *this between low and high.
 
const plVec4Template< Type > CompMul (const plVec4Template< Type > &rhs) const
 Returns the component-wise multiplication of *this and rhs.
 
const plVec4Template< Type > CompDiv (const plVec4Template< Type > &rhs) const
 Returns the component-wise division of *this and rhs.
 
const plVec4Template< Type > Abs () const
 brief Returns the component-wise absolute of *this.
 

Static Public Member Functions

static PL_DECLARE_IF_FLOAT_TYPE plVec4Template< Type > MakeNaN ()
 Returns a vector with all components set to Not-a-Number (NaN).
 
static plVec4Template< Type > MakeZero ()
 Returns a vector with all components set to zero.
 

Public Attributes

Type x
 
Type y
 
Type z
 
Type w
 

Detailed Description

template<typename Type>
class plVec4Template< Type >

A 4-component vector class.

Member Function Documentation

◆ IsNormalized()

template<typename Type >
PL_IMPLEMENT_IF_FLOAT_TYPE bool plVec4Template< Type >::IsNormalized ( Type fEpsilon = plMath::HugeEpsilon<Type>()) const
inline

Returns, whether the squared length of this vector is between 0.999f and 1.001f.

Note
Normalization, especially with SSE is not very precise. So this function checks whether the (squared) length is between a lower and upper limit.

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