HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Vector3 Class Reference

#include <Types.h>

+ Inheritance diagram for Vector3:

Public Member Functions

 Vector3 ()=default
 
 Vector3 (float x, float y, float z)
 
Vector3 cross (const Vector3 &rhs) const
 Return the cross product of two vectors. More...
 
- Public Member Functions inherited from VectorN< Vector3, float, 3 >
 VectorN ()
 
 VectorN (Uninit)
 
 VectorN (floats)
 
 VectorN (const std::array< float, N > &arr)
 
 VectorN (const vector< float > &vec)
 
 VectorN (const float *begin, const float *end)
 
bool operator== (const Vector3 &rhs) const
 Return true if the given vector is identical to this one. More...
 
bool operator!= (const Vector3 &rhs) const
 Return true if the given vector differs from this one. More...
 
bool operator< (const Vector3 &rhs) const
 Compare two vectors lexicographically. More...
 
floatoperator[] (size_t i)
 Return the scalar value at the given index. More...
 
const floatoperator[] (size_t i) const
 Return the const scalar value at the given index. More...
 
Vector3 operator+ (const Vector3 &rhs) const
 Component-wise addition of two vectors. More...
 
VectorNoperator+= (const Vector3 &rhs)
 Component-wise addition of two vectors. More...
 
Vector3 operator- (const Vector3 &rhs) const
 Component-wise subtraction of two vectors. More...
 
Vector3 operator- () const
 Unary negation of a vector. More...
 
VectorNoperator-= (const Vector3 &rhs)
 Component-wise subtraction of two vectors. More...
 
Vector3 operator* (const Vector3 &rhs) const
 Component-wise multiplication of two vectors. More...
 
Vector3 operator* (floats) const
 Component-wise multiplication of a vector by a scalar. More...
 
VectorNoperator*= (const Vector3 &rhs)
 Component-wise multiplication of two vectors. More...
 
VectorNoperator*= (floats)
 Component-wise multiplication of a vector by a scalar. More...
 
Vector3 operator/ (const Vector3 &rhs) const
 Component-wise division of two vectors. More...
 
Vector3 operator/ (floats) const
 Component-wise division of a vector by a scalar. More...
 
VectorNoperator/= (const Vector3 &rhs)
 Component-wise division of two vectors. More...
 
VectorNoperator/= (floats)
 Component-wise division of a vector by a scalar. More...
 
float getMagnitude () const
 Return the magnitude of the vector. More...
 
Vector3 getNormalized () const
 Return a normalized vector. More...
 
float dot (const Vector3 &rhs) const
 Return the dot product of two vectors. More...
 
Iterator begin ()
 
ConstIterator begin () const
 
Iterator end ()
 
ConstIterator end () const
 
floatdata ()
 Return a pointer to the underlying data array. More...
 
const floatdata () const
 Return a const pointer to the underlying data array. More...
 

Additional Inherited Members

- Public Types inherited from VectorN< Vector3, float, 3 >
using Iterator = typename std::array< float, N >::iterator
 
using ConstIterator = typename std::array< float, N >::const_iterator
 
- Static Public Member Functions inherited from VectorN< Vector3, float, 3 >
static constexpr size_t numElements ()
 Return the number of scalar elements for the vector. More...
 
- Protected Attributes inherited from VectorN< Vector3, float, 3 >
std::array< float, N > _arr
 

Detailed Description

A vector of three floating-point values

Definition at line 302 of file Types.h.

Constructor & Destructor Documentation

Vector3::Vector3 ( )
default
Vector3::Vector3 ( float  x,
float  y,
float  z 
)
inline

Definition at line 307 of file Types.h.

Member Function Documentation

Vector3 Vector3::cross ( const Vector3 rhs) const
inline

Return the cross product of two vectors.

Definition at line 314 of file Types.h.


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