JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Vector3D< Type > Class Template Reference

A three-coordinate vector. More...

Public Member Functions

 Vector3D () noexcept
 
 Vector3D (const Type &xValue, const Type &yValue, const Type &zValue) noexcept
 
 Vector3D (const Vector3D &other) noexcept
 
Vector3Doperator= (const Vector3D &other) noexcept
 
Vector3Doperator+= (const Vector3D &other) noexcept
 
Vector3Doperator-= (const Vector3D &other) noexcept
 
Vector3Doperator*= (const Type &scaleFactor) noexcept
 
Vector3Doperator/= (const Type &scaleFactor) noexcept
 
Vector3D operator+ (const Vector3D &other) const noexcept
 
Vector3D operator- (const Vector3D &other) const noexcept
 
Vector3D operator* (const Type &scaleFactor) const noexcept
 
Vector3D operator/ (const Type &scaleFactor) const noexcept
 
Vector3D operator- () const noexcept
 
Type operator* (const Vector3D &other) const noexcept
 Returns the dot-product of these two vectors.
 
Vector3D operator^ (const Vector3D &other) const noexcept
 Returns the cross-product of these two vectors.
 
Type length () const noexcept
 
Type lengthSquared () const noexcept
 
Vector3D normalised () const noexcept
 
bool lengthIsBelowEpsilon () const noexcept
 Returns true if the vector is practically equal to the origin.
 

Static Public Member Functions

static Vector3D xAxis () noexcept
 Returns a vector that lies along the X axis.
 
static Vector3D yAxis () noexcept
 Returns a vector that lies along the Y axis.
 
static Vector3D zAxis () noexcept
 Returns a vector that lies along the Z axis.
 

Public Attributes

Type x
 
Type y
 
Type z
 

Detailed Description

template<typename Type>
class Vector3D< Type >

A three-coordinate vector.

Constructor & Destructor Documentation

template<typename Type>
Vector3D< Type >::Vector3D ( )
noexcept
template<typename Type>
Vector3D< Type >::Vector3D ( const Type &  xValue,
const Type &  yValue,
const Type &  zValue 
)
noexcept
template<typename Type>
Vector3D< Type >::Vector3D ( const Vector3D< Type > &  other)
noexcept

Member Function Documentation

template<typename Type>
Vector3D& Vector3D< Type >::operator= ( const Vector3D< Type > &  other)
noexcept
template<typename Type>
static Vector3D Vector3D< Type >::xAxis ( )
staticnoexcept

Returns a vector that lies along the X axis.

template<typename Type>
static Vector3D Vector3D< Type >::yAxis ( )
staticnoexcept

Returns a vector that lies along the Y axis.

template<typename Type>
static Vector3D Vector3D< Type >::zAxis ( )
staticnoexcept

Returns a vector that lies along the Z axis.

template<typename Type>
Vector3D& Vector3D< Type >::operator+= ( const Vector3D< Type > &  other)
noexcept
template<typename Type>
Vector3D& Vector3D< Type >::operator-= ( const Vector3D< Type > &  other)
noexcept
template<typename Type>
Vector3D& Vector3D< Type >::operator*= ( const Type &  scaleFactor)
noexcept
template<typename Type>
Vector3D& Vector3D< Type >::operator/= ( const Type &  scaleFactor)
noexcept
template<typename Type>
Vector3D Vector3D< Type >::operator+ ( const Vector3D< Type > &  other) const
noexcept
template<typename Type>
Vector3D Vector3D< Type >::operator- ( const Vector3D< Type > &  other) const
noexcept
template<typename Type>
Vector3D Vector3D< Type >::operator* ( const Type &  scaleFactor) const
noexcept
template<typename Type>
Vector3D Vector3D< Type >::operator/ ( const Type &  scaleFactor) const
noexcept
template<typename Type>
Vector3D Vector3D< Type >::operator- ( ) const
noexcept
template<typename Type>
Type Vector3D< Type >::operator* ( const Vector3D< Type > &  other) const
noexcept

Returns the dot-product of these two vectors.

template<typename Type>
Vector3D Vector3D< Type >::operator^ ( const Vector3D< Type > &  other) const
noexcept

Returns the cross-product of these two vectors.

template<typename Type>
Type Vector3D< Type >::length ( ) const
noexcept
template<typename Type>
Type Vector3D< Type >::lengthSquared ( ) const
noexcept
template<typename Type>
Vector3D Vector3D< Type >::normalised ( ) const
noexcept
template<typename Type>
bool Vector3D< Type >::lengthIsBelowEpsilon ( ) const
noexcept

Returns true if the vector is practically equal to the origin.

Member Data Documentation

template<typename Type>
Type Vector3D< Type >::x
template<typename Type>
Type Vector3D< Type >::y
template<typename Type>
Type Vector3D< Type >::z

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