JUCE API reference
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
juce::Vector3D< Type > Class Template Reference

A three-coordinate vector. More...

Public Member Functions

 Vector3D () noexcept
 
 Vector3D (Type xValue, Type yValue, Type zValue) noexcept
 
 Vector3D (const Vector3D &other) noexcept
 
Vector3D & operator= (Vector3D other) noexcept
 
Vector3D & operator+= (Vector3D other) noexcept
 
Vector3D & operator-= (Vector3D other) noexcept
 
Vector3D & operator*= (Type scaleFactor) noexcept
 
Vector3D & operator/= (Type scaleFactor) noexcept
 
Vector3D operator+ (Vector3D other) const noexcept
 
Vector3D operator- (Vector3D other) const noexcept
 
Vector3D operator* (Type scaleFactor) const noexcept
 
Vector3D operator/ (Type scaleFactor) const noexcept
 
Vector3D operator- () const noexcept
 
Type operator* (Vector3D other) const noexcept
 Returns the dot-product of these two vectors.
 
Vector3D operator^ (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 juce::Vector3D< Type >

A three-coordinate vector.

Constructor & Destructor Documentation

◆ Vector3D() [1/3]

template<typename Type >
juce::Vector3D< Type >::Vector3D ( )
inlinenoexcept

◆ Vector3D() [2/3]

template<typename Type >
juce::Vector3D< Type >::Vector3D ( Type  xValue,
Type  yValue,
Type  zValue 
)
inlinenoexcept

◆ Vector3D() [3/3]

template<typename Type >
juce::Vector3D< Type >::Vector3D ( const Vector3D< Type > &  other)
inlinenoexcept

Member Function Documentation

◆ operator=()

template<typename Type >
Vector3D & juce::Vector3D< Type >::operator= ( Vector3D< Type >  other)
inlinenoexcept

◆ xAxis()

template<typename Type >
static Vector3D juce::Vector3D< Type >::xAxis ( )
inlinestaticnoexcept

Returns a vector that lies along the X axis.

◆ yAxis()

template<typename Type >
static Vector3D juce::Vector3D< Type >::yAxis ( )
inlinestaticnoexcept

Returns a vector that lies along the Y axis.

◆ zAxis()

template<typename Type >
static Vector3D juce::Vector3D< Type >::zAxis ( )
inlinestaticnoexcept

Returns a vector that lies along the Z axis.

◆ operator+=()

template<typename Type >
Vector3D & juce::Vector3D< Type >::operator+= ( Vector3D< Type >  other)
inlinenoexcept

◆ operator-=()

template<typename Type >
Vector3D & juce::Vector3D< Type >::operator-= ( Vector3D< Type >  other)
inlinenoexcept

◆ operator*=()

template<typename Type >
Vector3D & juce::Vector3D< Type >::operator*= ( Type  scaleFactor)
inlinenoexcept

◆ operator/=()

template<typename Type >
Vector3D & juce::Vector3D< Type >::operator/= ( Type  scaleFactor)
inlinenoexcept

◆ operator+()

template<typename Type >
Vector3D juce::Vector3D< Type >::operator+ ( Vector3D< Type >  other) const
inlinenoexcept

◆ operator-() [1/2]

template<typename Type >
Vector3D juce::Vector3D< Type >::operator- ( Vector3D< Type >  other) const
inlinenoexcept

◆ operator*() [1/2]

template<typename Type >
Vector3D juce::Vector3D< Type >::operator* ( Type  scaleFactor) const
inlinenoexcept

◆ operator/()

template<typename Type >
Vector3D juce::Vector3D< Type >::operator/ ( Type  scaleFactor) const
inlinenoexcept

◆ operator-() [2/2]

template<typename Type >
Vector3D juce::Vector3D< Type >::operator- ( ) const
inlinenoexcept

◆ operator*() [2/2]

template<typename Type >
Type juce::Vector3D< Type >::operator* ( Vector3D< Type >  other) const
inlinenoexcept

Returns the dot-product of these two vectors.

References juce::Vector3D< Type >::x, juce::Vector3D< Type >::y, and juce::Vector3D< Type >::z.

◆ operator^()

template<typename Type >
Vector3D juce::Vector3D< Type >::operator^ ( Vector3D< Type >  other) const
inlinenoexcept

Returns the cross-product of these two vectors.

References juce::Vector3D< Type >::x, juce::Vector3D< Type >::y, and juce::Vector3D< Type >::z.

◆ length()

template<typename Type >
Type juce::Vector3D< Type >::length ( ) const
inlinenoexcept

◆ lengthSquared()

template<typename Type >
Type juce::Vector3D< Type >::lengthSquared ( ) const
inlinenoexcept

◆ normalised()

template<typename Type >
Vector3D juce::Vector3D< Type >::normalised ( ) const
inlinenoexcept

◆ lengthIsBelowEpsilon()

template<typename Type >
bool juce::Vector3D< Type >::lengthIsBelowEpsilon ( ) const
inlinenoexcept

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

References juce::Vector3D< Type >::x, juce::Vector3D< Type >::y, and juce::Vector3D< Type >::z.

Member Data Documentation

◆ x

template<typename Type >
Type juce::Vector3D< Type >::x

◆ y

template<typename Type >
Type juce::Vector3D< Type >::y

◆ z

template<typename Type >
Type juce::Vector3D< Type >::z

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