Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

kino_plugin_utility.h File Reference

#include <cassert>
#include <deque>
#include <vector>
#include <numeric>

Include dependency graph for kino_plugin_utility.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

namespace  kino

Functions

template<typename ArgType>
ArgType clamp (const ArgType A, const ArgType MinVal, const ArgType MaxVal)
 Clamps the input value to the range [MinVal, MaxVal].
template<typename ArgType>
ArgType lerp (const ArgType A, const ArgType B, const double Mix)
 Linear interpolation between two values.
double step (const double Edge, const double A)
double linearstep (const double Edge1, const double Edge2, const double A)
double smoothstep (const double Edge1, const double Edge2, const double A)
double pulse (const double Edge1, const double Edge2, const double A)
double factorial (const unsigned int X)

Function Documentation

template<typename ArgType>
ArgType kino::clamp (  const ArgType  A,
const ArgType  MinVal,
const ArgType  MaxVal
) 
 

Clamps the input value to the range [MinVal, MaxVal].

Definition at line 33 of file kino_plugin_utility.h.

Referenced by kino::color_traits< uint8_t >::convert().

00034 {
00035         return std::min(std::max(A, MinVal), MaxVal);
00036 }

double kino::factorial (  const unsigned int  X  )  [inline]
 

Definition at line 79 of file kino_plugin_utility.h.

00080 {
00081     double result = 1;
00082     
00083     for(unsigned int i = 2; i <= X; ++i)
00084         result *= i;
00085         
00086     return result;
00087 }

template<typename ArgType>
ArgType kino::lerp (  const ArgType  A,
const ArgType  B,
const double  Mix
)  [inline]
 

Linear interpolation between two values.

Definition at line 40 of file kino_plugin_utility.h.

00041 {
00042         return static_cast<ArgType>(A * (1.0 - Mix) + B * Mix);
00043 }

double kino::linearstep (  const double  Edge1,
const double  Edge2,
const double  A
)  [inline]
 

Definition at line 50 of file kino_plugin_utility.h.

00051 {
00052         if(A < Edge1)
00053                 return 0.0;
00054                 
00055         if(A >= Edge2)
00056                 return 1.0;
00057                 
00058         return (A - Edge1) / (Edge2 - Edge1);
00059 }

double kino::pulse (  const double  Edge1,
const double  Edge2,
const double  A
)  [inline]
 

Definition at line 74 of file kino_plugin_utility.h.

References kino::step().

00075 {
00076         return step(Edge1, A) - step(Edge2, A);
00077 }

double kino::smoothstep (  const double  Edge1,
const double  Edge2,
const double  A
)  [inline]
 

Definition at line 61 of file kino_plugin_utility.h.

00062 {
00063         if(A < Edge1)
00064                 return 0.0;
00065                 
00066         if(A >= Edge2)
00067                 return 1.0;
00068                 
00069         double a = (A - Edge1) / (Edge2 - Edge1);
00070         
00071         return (a * a * (3 - 2 * a));
00072 }

double kino::step (  const double  Edge,
const double  A
)  [inline]
 

Definition at line 45 of file kino_plugin_utility.h.

Referenced by kino::pulse().

00046 {
00047         return A < Edge ? 0.0 : 1.0;
00048 }

Generated on Sun Mar 11 22:12:11 2007 for Kino by  doxygen 1.4.2