HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ShCoeffs< C, B > Class Template Reference

#include <Harmonics.h>

Public Member Functions

 ShCoeffs ()=default
 
 ShCoeffs (const std::array< C, NUM_COEFFS > &arr)
 
Comparison Operators
bool operator== (const ShCoeffs &rhs) const
 Return true if the given vector is identical to this one. More...
 
bool operator!= (const ShCoeffs &rhs) const
 Return true if the given vector differs from this one. More...
 
Indexing Operators
C & operator[] (size_t i)
 Return the coefficient at the given index. More...
 
const C & operator[] (size_t i) const
 Return the const coefficient at the given index. More...
 

Static Public Attributes

static const size_t NUM_BANDS = B
 
static const size_t NUM_COEFFS = B * B
 

Protected Attributes

std::array< C, NUM_COEFFS_arr
 

Detailed Description

template<class C, size_t B>
class ShCoeffs< C, B >

Class template for a vector of spherical harmonic coefficients.

Template parameter C is the coefficient type (e.g. double, Color3). Template parameter B is the number of spherical harmonic bands.

Definition at line 22 of file Harmonics.h.

Constructor & Destructor Documentation

template<class C , size_t B>
ShCoeffs< C, B >::ShCoeffs ( )
default
template<class C , size_t B>
ShCoeffs< C, B >::ShCoeffs ( const std::array< C, NUM_COEFFS > &  arr)
inlineexplicit

Definition at line 30 of file Harmonics.h.

Member Function Documentation

template<class C , size_t B>
bool ShCoeffs< C, B >::operator!= ( const ShCoeffs< C, B > &  rhs) const
inline

Return true if the given vector differs from this one.

Definition at line 39 of file Harmonics.h.

template<class C , size_t B>
bool ShCoeffs< C, B >::operator== ( const ShCoeffs< C, B > &  rhs) const
inline

Return true if the given vector is identical to this one.

Definition at line 36 of file Harmonics.h.

template<class C , size_t B>
C& ShCoeffs< C, B >::operator[] ( size_t  i)
inline

Return the coefficient at the given index.

Definition at line 46 of file Harmonics.h.

template<class C , size_t B>
const C& ShCoeffs< C, B >::operator[] ( size_t  i) const
inline

Return the const coefficient at the given index.

Definition at line 49 of file Harmonics.h.

Member Data Documentation

template<class C , size_t B>
std::array<C, NUM_COEFFS> ShCoeffs< C, B >::_arr
protected

Definition at line 54 of file Harmonics.h.

template<class C , size_t B>
const size_t ShCoeffs< C, B >::NUM_BANDS = B
static

Definition at line 25 of file Harmonics.h.

template<class C , size_t B>
const size_t ShCoeffs< C, B >::NUM_COEFFS = B * B
static

Definition at line 26 of file Harmonics.h.


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