ImageAccessorBase< ChannelType, nch > Class Template Reference

ImageAccessorBase< ChannelType, nch > Class Template Reference

#include <image.h>

Class Description

template<class ChannelType, cu_int nch>
class mudbox::ImageAccessorBase< ChannelType, nch >

The ImageAccessorBase class gives you very fast access to pixels when the data type and channel count of an image are known at compile time (and this is very often the case.)

Definition at line 2496 of file image.h.

+ Inheritance diagram for ImageAccessorBase< ChannelType, nch >:

Public Member Functions

 ImageAccessorBase (Image *parent)
 
u_int Width () const
 
u_int Height () const
 
u_int ChannelCount () const
 
void SetValueAt (u_int X, u_int Y, u_int Ch, float fVal)
 Set value for a specified texel. More...
 
float ValueAt (u_int X, u_int Y, u_int Ch) const
 Get the value at a given coordinate. More...
 
void SetColorAt (u_int X, u_int Y, const Color &cColor)
 Set value for a specified texel. More...
 
voidAddrAt (u_int X, u_int Y, u_int Ch)
 
template<>
voidAddrAt (u_int X, u_int Y, u_int Ch)
 
template<>
voidAddrAt (u_int X, u_int Y, u_int Ch)
 
template<>
voidAddrAt (u_int X, u_int Y, u_int Ch)
 
template<>
voidAddrAt (u_int X, u_int Y, u_int Ch)
 
template<>
voidAddrAt (u_int X, u_int Y, u_int Ch)
 
template<>
voidAddrAt (u_int X, u_int Y, u_int Ch)
 
template<>
voidAddrAt (u_int X, u_int Y, u_int Ch)
 
template<>
voidAddrAt (u_int X, u_int Y, u_int Ch)
 
template<>
voidAddrAt (u_int X, u_int Y, u_int Ch)
 
template<>
voidAddrAt (u_int X, u_int Y, u_int Ch)
 
template<>
voidAddrAt (u_int X, u_int Y, u_int Ch)
 
template<>
voidAddrAt (u_int X, u_int Y, u_int Ch)
 
template<>
voidAddrAt (u_int X, u_int Y, u_int Ch)
 
template<>
voidAddrAt (u_int X, u_int Y, u_int Ch)
 
template<>
voidAddrAt (u_int X, u_int Y, u_int Ch)
 
template<>
voidAddrAt (u_int X, u_int Y, u_int Ch)
 
template<>
void SetValueAt (u_int X, u_int Y, u_int Ch, float fVal)
 
template<>
void SetValueAt (u_int X, u_int Y, u_int Ch, float fVal)
 
template<>
void SetValueAt (u_int X, u_int Y, u_int Ch, float fVal)
 
template<>
void SetValueAt (u_int X, u_int Y, u_int Ch, float fVal)
 
template<>
void SetValueAt (u_int X, u_int Y, u_int Ch, float fVal)
 
template<>
void SetValueAt (u_int X, u_int Y, u_int Ch, float fVal)
 
template<>
void SetValueAt (u_int X, u_int Y, u_int Ch, float fVal)
 
template<>
void SetValueAt (u_int X, u_int Y, u_int Ch, float fVal)
 
template<>
void SetValueAt (u_int X, u_int Y, u_int Ch, float fVal)
 
template<>
void SetValueAt (u_int X, u_int Y, u_int Ch, float fVal)
 
template<>
void SetValueAt (u_int X, u_int Y, u_int Ch, float fVal)
 
template<>
void SetValueAt (u_int X, u_int Y, u_int Ch, float fVal)
 
template<>
void SetValueAt (u_int X, u_int Y, u_int Ch, float fVal)
 
template<>
void SetValueAt (u_int X, u_int Y, u_int Ch, float fVal)
 
template<>
void SetValueAt (u_int X, u_int Y, u_int Ch, float fVal)
 
template<>
void SetValueAt (u_int X, u_int Y, u_int Ch, float fVal)
 
template<>
float ValueAt (u_int X, u_int Y, u_int Ch) const
 
template<>
float ValueAt (u_int X, u_int Y, u_int Ch) const
 
template<>
float ValueAt (u_int X, u_int Y, u_int Ch) const
 
template<>
float ValueAt (u_int X, u_int Y, u_int Ch) const
 
template<>
float ValueAt (u_int X, u_int Y, u_int Ch) const
 
template<>
float ValueAt (u_int X, u_int Y, u_int Ch) const
 
template<>
float ValueAt (u_int X, u_int Y, u_int Ch) const
 
template<>
float ValueAt (u_int X, u_int Y, u_int Ch) const
 
template<>
float ValueAt (u_int X, u_int Y, u_int Ch) const
 
template<>
float ValueAt (u_int X, u_int Y, u_int Ch) const
 
template<>
float ValueAt (u_int X, u_int Y, u_int Ch) const
 
template<>
float ValueAt (u_int X, u_int Y, u_int Ch) const
 
template<>
float ValueAt (u_int X, u_int Y, u_int Ch) const
 
template<>
float ValueAt (u_int X, u_int Y, u_int Ch) const
 
template<>
float ValueAt (u_int X, u_int Y, u_int Ch) const
 
template<>
float ValueAt (u_int X, u_int Y, u_int Ch) const
 
template<>
float ValueAt (u_int X, u_int Y, u_int Ch) const
 
template<>
float ValueAt (u_int X, u_int Y, u_int Ch) const
 
template<>
void SetValueAt (u_int X, u_int Y, u_int Ch, float fVal)
 
template<>
void SetValueAt (u_int X, u_int Y, u_int Ch, float fVal)
 
template<>
void SetColorAt (u_int X, u_int Y, const Color &c)
 
template<>
void SetColorAt (u_int X, u_int Y, const Color &c)
 
template<>
void SetColorAt (u_int X, u_int Y, const Color &c)
 
template<>
void SetColorAt (u_int X, u_int Y, const Color &c)
 
template<>
void SetColorAt (u_int X, u_int Y, const Color &c)
 
template<>
void SetColorAt (u_int X, u_int Y, const Color &c)
 
template<>
void SetColorAt (u_int X, u_int Y, const Color &c)
 
template<>
void SetColorAt (u_int X, u_int Y, const Color &c)
 

Constructor & Destructor Documentation

ImageAccessorBase ( Image parent)
inline

Definition at line 2506 of file image.h.

2507  {
2508  m_Stride = parent->Width();
2509  m_Height = parent->Height();
2510  m_chans = parent->ChannelCount();
2511  m_Image = parent;
2512  m_pData = (ChannelType *)parent->Data();
2513  }

Member Function Documentation

u_int Width ( void  ) const
inline

Definition at line 2515 of file image.h.

2515 { return m_Stride; }
u_int Height ( void  ) const
inline

Definition at line 2516 of file image.h.

2516 { return m_Height; }
u_int ChannelCount ( void  ) const
inline

Definition at line 2517 of file image.h.

2517 { return m_chans; }
void SetValueAt ( u_int  X,
u_int  Y,
u_int  Ch,
float  fVal 
)
inline

Set value for a specified texel.

For integer maps 1 should be mapped for the maximum value (255 for 8 bit images and 65535 for 16 bit images)

float ValueAt ( u_int  X,
u_int  Y,
u_int  Ch 
) const
inline

Get the value at a given coordinate.

void SetColorAt ( u_int  X,
u_int  Y,
const Color cColor 
)
inline

Set value for a specified texel.

For integer maps 1 should be mapped for the maximum value (255 for 8 bit images and 65535 for 16 bit images)

void* AddrAt ( u_int  X,
u_int  Y,
u_int  Ch 
)
inline
void * AddrAt ( u_int  X,
u_int  Y,
u_int  Ch 
)
inline

Definition at line 2606 of file image.h.

2607 { return (void *)&m_pData[Ch + ((X + m_Stride * Y) )]; }
void * AddrAt ( u_int  X,
u_int  Y,
u_int  Ch 
)
inline

Definition at line 2609 of file image.h.

2610 { return (void *)&m_pData[Ch + ((X + m_Stride * Y) * 2)]; }
void * AddrAt ( u_int  X,
u_int  Y,
u_int  Ch 
)
inline

Definition at line 2612 of file image.h.

2613 { return (void *)&m_pData[Ch + ((X + m_Stride * Y) * 3)]; }
void * AddrAt ( u_int  X,
u_int  Y,
u_int  Ch 
)
inline

Definition at line 2615 of file image.h.

2616 { return (void *)&m_pData[Ch + ((X + m_Stride * Y) * 4)]; }
void * AddrAt ( u_int  X,
u_int  Y,
u_int  Ch 
)
inline

Definition at line 2619 of file image.h.

2620 { return (void *)&m_pData[Ch + ((X + m_Stride * Y) )]; }
void * AddrAt ( u_int  X,
u_int  Y,
u_int  Ch 
)
inline

Definition at line 2622 of file image.h.

2623 { return (void *)&m_pData[Ch + ((X + m_Stride * Y) * 2)]; }
void * AddrAt ( u_int  X,
u_int  Y,
u_int  Ch 
)
inline

Definition at line 2625 of file image.h.

2626 { return (void *)&m_pData[Ch + ((X + m_Stride * Y) * 3)]; }
void * AddrAt ( u_int  X,
u_int  Y,
u_int  Ch 
)
inline

Definition at line 2628 of file image.h.

2629 { return (void *)&m_pData[Ch + ((X + m_Stride * Y) * 4)]; }
void * AddrAt ( u_int  X,
u_int  Y,
u_int  Ch 
)
inline

Definition at line 2633 of file image.h.

2634 { return (void *)&m_pData[Ch + ((X + m_Stride * Y) )]; }
void * AddrAt ( u_int  X,
u_int  Y,
u_int  Ch 
)
inline

Definition at line 2636 of file image.h.

2637 { return (void *)&m_pData[Ch + ((X + m_Stride * Y) * 2)]; }
void * AddrAt ( u_int  X,
u_int  Y,
u_int  Ch 
)
inline

Definition at line 2639 of file image.h.

2640 { return (void *)&m_pData[Ch + ((X + m_Stride * Y) * 3)]; }
void * AddrAt ( u_int  X,
u_int  Y,
u_int  Ch 
)
inline

Definition at line 2642 of file image.h.

2643 { return (void *)&m_pData[Ch + ((X + m_Stride * Y) * 4)]; }
void * AddrAt ( u_int  X,
u_int  Y,
u_int  Ch 
)
inline

Definition at line 2646 of file image.h.

2647 { return (void *)&m_pData[Ch + ((X + m_Stride * Y) )]; }
void * AddrAt ( u_int  X,
u_int  Y,
u_int  Ch 
)
inline

Definition at line 2649 of file image.h.

2650 { return (void *)&m_pData[Ch + ((X + m_Stride * Y) * 2)]; }
void * AddrAt ( u_int  X,
u_int  Y,
u_int  Ch 
)
inline

Definition at line 2652 of file image.h.

2653 { return (void *)&m_pData[Ch + ((X + m_Stride * Y) * 3)]; }
void * AddrAt ( u_int  X,
u_int  Y,
u_int  Ch 
)
inline

Definition at line 2655 of file image.h.

2656 { return (void *)&m_pData[Ch + ((X + m_Stride * Y) * 4)]; }
void SetValueAt ( u_int  X,
u_int  Y,
u_int  Ch,
float  fVal 
)
inline

Definition at line 2660 of file image.h.

2661 { m_pData[Ch + ((X + m_Stride * Y) )] = (u_char)(255.0f * fVal); }
#define u_char
Definition: image.h:2488
GLclampf f
Definition: GLee.h:9303
void SetValueAt ( u_int  X,
u_int  Y,
u_int  Ch,
float  fVal 
)
inline

Definition at line 2663 of file image.h.

2664 { m_pData[Ch + ((X + m_Stride * Y) * 2)] = (u_char)(255.0f * fVal); }
#define u_char
Definition: image.h:2488
GLclampf f
Definition: GLee.h:9303
void SetValueAt ( u_int  X,
u_int  Y,
u_int  Ch,
float  fVal 
)
inline

Definition at line 2666 of file image.h.

2667 { m_pData[Ch + ((X + m_Stride * Y) * 3)] = (u_char)(255.0f * fVal); }
#define u_char
Definition: image.h:2488
GLclampf f
Definition: GLee.h:9303
void SetValueAt ( u_int  X,
u_int  Y,
u_int  Ch,
float  fVal 
)
inline

Definition at line 2669 of file image.h.

2670 { m_pData[Ch + ((X + m_Stride * Y) * 4)] = (u_char)(255.0f * fVal); }
#define u_char
Definition: image.h:2488
GLclampf f
Definition: GLee.h:9303
void SetValueAt ( u_int  X,
u_int  Y,
u_int  Ch,
float  fVal 
)
inline

Definition at line 2673 of file image.h.

2674 { m_pData[Ch + ((X + m_Stride * Y) )] = (u_short)(65535.0f * fVal); }
#define u_short
Definition: image.h:2487
GLclampf f
Definition: GLee.h:9303
void SetValueAt ( u_int  X,
u_int  Y,
u_int  Ch,
float  fVal 
)
inline

Definition at line 2676 of file image.h.

2677 { m_pData[Ch + ((X + m_Stride * Y) * 2)] = (u_short)(65535.0f * fVal); }
#define u_short
Definition: image.h:2487
GLclampf f
Definition: GLee.h:9303
void SetValueAt ( u_int  X,
u_int  Y,
u_int  Ch,
float  fVal 
)
inline

Definition at line 2679 of file image.h.

2680 { m_pData[Ch + ((X + m_Stride * Y) * 3)] = (u_short)(65535.0f * fVal); }
#define u_short
Definition: image.h:2487
GLclampf f
Definition: GLee.h:9303
void SetValueAt ( u_int  X,
u_int  Y,
u_int  Ch,
float  fVal 
)
inline

Definition at line 2682 of file image.h.

2683 { m_pData[Ch + ((X + m_Stride * Y) * 4)] = (u_short)(65535.0f * fVal); }
#define u_short
Definition: image.h:2487
GLclampf f
Definition: GLee.h:9303
void SetValueAt ( u_int  X,
u_int  Y,
u_int  Ch,
float  fVal 
)
inline

Definition at line 2687 of file image.h.

2688 { m_pData[Ch + ((X + m_Stride * Y) )] = (u_int)(0xffffffff * fVal); }
#define u_int
Definition: image.h:2486
void SetValueAt ( u_int  X,
u_int  Y,
u_int  Ch,
float  fVal 
)
inline

Definition at line 2690 of file image.h.

2691 { m_pData[Ch + ((X + m_Stride * Y) * 2)] = (u_int)(0xffffffff * fVal); }
#define u_int
Definition: image.h:2486
void SetValueAt ( u_int  X,
u_int  Y,
u_int  Ch,
float  fVal 
)
inline

Definition at line 2693 of file image.h.

2694 { m_pData[Ch + ((X + m_Stride * Y) * 3)] = (u_int)(0xffffffff * fVal); }
#define u_int
Definition: image.h:2486
void SetValueAt ( u_int  X,
u_int  Y,
u_int  Ch,
float  fVal 
)
inline

Definition at line 2696 of file image.h.

2697 { m_pData[Ch + ((X + m_Stride * Y) * 4)] = (u_int)(0xffffffff * fVal); }
#define u_int
Definition: image.h:2486
void SetValueAt ( u_int  X,
u_int  Y,
u_int  Ch,
float  fVal 
)
inline

Definition at line 2700 of file image.h.

2701 { m_pData[Ch + ((X + m_Stride * Y) )] = fVal; }
void SetValueAt ( u_int  X,
u_int  Y,
u_int  Ch,
float  fVal 
)
inline

Definition at line 2703 of file image.h.

2704 { m_pData[Ch + ((X + m_Stride * Y) * 2)] = fVal; }
void SetValueAt ( u_int  X,
u_int  Y,
u_int  Ch,
float  fVal 
)
inline

Definition at line 2706 of file image.h.

2707 { m_pData[Ch + ((X + m_Stride * Y) * 3)] = fVal; }
void SetValueAt ( u_int  X,
u_int  Y,
u_int  Ch,
float  fVal 
)
inline

Definition at line 2709 of file image.h.

2710 { m_pData[Ch + ((X + m_Stride * Y) * 4)] = fVal; }
float ValueAt ( u_int  X,
u_int  Y,
u_int  Ch 
) const
inline

Definition at line 2713 of file image.h.

2714 { return m_pData[Ch + ((X + m_Stride * Y) )] * (1.0f/255.0f); }
float ValueAt ( u_int  X,
u_int  Y,
u_int  Ch 
) const
inline

Definition at line 2716 of file image.h.

2717 { return m_pData[Ch + ((X + m_Stride * Y) * 2)] * (1.0f/255.0f); }
float ValueAt ( u_int  X,
u_int  Y,
u_int  Ch 
) const
inline

Definition at line 2719 of file image.h.

2720 { return m_pData[Ch + ((X + m_Stride * Y) * 3)] * (1.0f/255.0f); }
float ValueAt ( u_int  X,
u_int  Y,
u_int  Ch 
) const
inline

Definition at line 2722 of file image.h.

2723 { return m_pData[Ch + ((X + m_Stride * Y) * 4)] * (1.0f/255.0f); }
float ValueAt ( u_int  X,
u_int  Y,
u_int  Ch 
) const
inline

Definition at line 2726 of file image.h.

2727 { return m_pData[Ch + ((X + m_Stride * Y) )] * (1.0f/65535.0f); }
float ValueAt ( u_int  X,
u_int  Y,
u_int  Ch 
) const
inline

Definition at line 2729 of file image.h.

2730 { return m_pData[Ch + ((X + m_Stride * Y) * 2)] * (1.0f/65535.0f); }
float ValueAt ( u_int  X,
u_int  Y,
u_int  Ch 
) const
inline

Definition at line 2732 of file image.h.

2733 { return m_pData[Ch + ((X + m_Stride * Y) * 3)] * (1.0f/65535.0f); }
float ValueAt ( u_int  X,
u_int  Y,
u_int  Ch 
) const
inline

Definition at line 2735 of file image.h.

2736 { return m_pData[Ch + ((X + m_Stride * Y) * 4)] * (1.0f/65535.0f); }
float ValueAt ( u_int  X,
u_int  Y,
u_int  Ch 
) const
inline

Definition at line 2739 of file image.h.

2740 { return m_pData[Ch + ((X + m_Stride * Y) )] * (1.0f/float(0xffffffff)); }
float ValueAt ( u_int  X,
u_int  Y,
u_int  Ch 
) const
inline

Definition at line 2742 of file image.h.

2743 { return m_pData[Ch + ((X + m_Stride * Y) * 2)] * (1.0f/float(0xffffffff)); }
float ValueAt ( u_int  X,
u_int  Y,
u_int  Ch 
) const
inline

Definition at line 2745 of file image.h.

2746 { return m_pData[Ch + ((X + m_Stride * Y) * 3)] * (1.0f/float(0xffffffff)); }
float ValueAt ( u_int  X,
u_int  Y,
u_int  Ch 
) const
inline

Definition at line 2748 of file image.h.

2749 { return m_pData[Ch + ((X + m_Stride * Y) * 4)] * (1.0f/float(0xffffffff)); }
float ValueAt ( u_int  X,
u_int  Y,
u_int  Ch 
) const
inline

Definition at line 2752 of file image.h.

2753 { return m_pData[Ch + ((X + m_Stride * Y) )]; }
float ValueAt ( u_int  X,
u_int  Y,
u_int  Ch 
) const
inline

Definition at line 2755 of file image.h.

2756 { return m_pData[Ch + ((X + m_Stride * Y) * 2)]; }
float ValueAt ( u_int  X,
u_int  Y,
u_int  Ch 
) const
inline

Definition at line 2758 of file image.h.

2759 { return m_pData[Ch + ((X + m_Stride * Y) * 3)]; }
float ValueAt ( u_int  X,
u_int  Y,
u_int  Ch 
) const
inline

Definition at line 2761 of file image.h.

2762 { return m_pData[Ch + ((X + m_Stride * Y) * 4)]; }
float ValueAt ( u_int  X,
u_int  Y,
u_int  Ch 
) const
inline

Definition at line 2810 of file image.h.

2811 { return float(m_pData[Ch + ((X + m_Stride * Y) * 3)]); }
float ValueAt ( u_int  X,
u_int  Y,
u_int  Ch 
) const
inline

Definition at line 2815 of file image.h.

2816 { return float(m_pData[Ch + ((X + m_Stride * Y) * 4)]); }
void SetValueAt ( u_int  X,
u_int  Y,
u_int  Ch,
float  fVal 
)
inline

Definition at line 2820 of file image.h.

2821 { m_pData[Ch + ((X + m_Stride * Y) * 3)] = fVal; }
void SetValueAt ( u_int  X,
u_int  Y,
u_int  Ch,
float  fVal 
)
inline

Definition at line 2825 of file image.h.

2826 { m_pData[Ch + ((X + m_Stride * Y) * 4)] = fVal; }
void SetColorAt ( u_int  X,
u_int  Y,
const Color c 
)
inline

Definition at line 2846 of file image.h.

2847 {
2848  SetValueAt(X, Y, 0, c.r);
2849  SetValueAt(X, Y, 1, c.g);
2850  SetValueAt(X, Y, 2, c.b);
2851  SetValueAt(X, Y, 3, c.a);
2852 };
void SetValueAt(u_int X, u_int Y, u_int Ch, float fVal)
Set value for a specified texel.
const GLubyte * c
Definition: GLee.h:5419
void SetColorAt ( u_int  X,
u_int  Y,
const Color c 
)
inline

Definition at line 2856 of file image.h.

2857 {
2858  SetValueAt(X, Y, 0, c.r);
2859  SetValueAt(X, Y, 1, c.g);
2860  SetValueAt(X, Y, 2, c.b);
2861 };
void SetValueAt(u_int X, u_int Y, u_int Ch, float fVal)
Set value for a specified texel.
const GLubyte * c
Definition: GLee.h:5419
void SetColorAt ( u_int  X,
u_int  Y,
const Color c 
)
inline

Definition at line 2865 of file image.h.

2866 {
2867  SetValueAt(X, Y, 0, c.r);
2868  SetValueAt(X, Y, 1, c.g);
2869  SetValueAt(X, Y, 2, c.b);
2870  SetValueAt(X, Y, 3, c.a);
2871 };
void SetValueAt(u_int X, u_int Y, u_int Ch, float fVal)
Set value for a specified texel.
const GLubyte * c
Definition: GLee.h:5419
void SetColorAt ( u_int  X,
u_int  Y,
const Color c 
)
inline

Definition at line 2875 of file image.h.

2876 {
2877  SetValueAt(X, Y, 0, c.r);
2878  SetValueAt(X, Y, 1, c.g);
2879  SetValueAt(X, Y, 2, c.b);
2880 };
void SetValueAt(u_int X, u_int Y, u_int Ch, float fVal)
Set value for a specified texel.
const GLubyte * c
Definition: GLee.h:5419
void SetColorAt ( u_int  X,
u_int  Y,
const Color c 
)
inline

Definition at line 2884 of file image.h.

2885 {
2886  SetValueAt(X, Y, 0, c.r);
2887  SetValueAt(X, Y, 1, c.g);
2888  SetValueAt(X, Y, 2, c.b);
2889  SetValueAt(X, Y, 3, c.a);
2890 };
void SetValueAt(u_int X, u_int Y, u_int Ch, float fVal)
Set value for a specified texel.
const GLubyte * c
Definition: GLee.h:5419
void SetColorAt ( u_int  X,
u_int  Y,
const Color c 
)
inline

Definition at line 2894 of file image.h.

2895 {
2896  SetValueAt(X, Y, 0, c.r);
2897  SetValueAt(X, Y, 1, c.g);
2898  SetValueAt(X, Y, 2, c.b);
2899 };
void SetValueAt(u_int X, u_int Y, u_int Ch, float fVal)
Set value for a specified texel.
const GLubyte * c
Definition: GLee.h:5419
void SetColorAt ( u_int  X,
u_int  Y,
const Color c 
)
inline

Definition at line 2903 of file image.h.

2904 {
2905  SetValueAt(X, Y, 0, c.r);
2906  SetValueAt(X, Y, 1, c.g);
2907  SetValueAt(X, Y, 2, c.b);
2908  SetValueAt(X, Y, 3, c.a);
2909 };
void SetValueAt(u_int X, u_int Y, u_int Ch, float fVal)
Set value for a specified texel.
const GLubyte * c
Definition: GLee.h:5419
void SetColorAt ( u_int  X,
u_int  Y,
const Color c 
)
inline

Definition at line 2913 of file image.h.

2914 {
2915  SetValueAt(X, Y, 0, c.r);
2916  SetValueAt(X, Y, 1, c.g);
2917  SetValueAt(X, Y, 2, c.b);
2918 };
void SetValueAt(u_int X, u_int Y, u_int Ch, float fVal)
Set value for a specified texel.
const GLubyte * c
Definition: GLee.h:5419

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