Main Page | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals

pge::ValueFader Class Reference

#include <ValueFader.h>


Public Member Functions

 ValueFader (float min, float max)
 Constructor.

virtual ~ValueFader (void)
 Destructor.

float getValue (void)
void setValue (float value)
void update (void)
float getChange (void)
void setChange (float change)
float getMax (void)
void setMax (float max)
float getMin (void)
void setMin (float min)

Private Attributes

float m_value
bool m_valuePlus
float m_min
float m_max
float m_change


Constructor & Destructor Documentation

pge::ValueFader::ValueFader float  min,
float  max
[inline]
 

Constructor.

Definition at line 20 of file ValueFader.h.

References m_change, m_max, m_min, m_value, and m_valuePlus.

00020                                                  {
00021                         m_value = min;
00022                         m_valuePlus = true;
00023                         m_min = min;
00024                         m_max = max;
00025                         m_change = 0.05f;
00026                 }

virtual pge::ValueFader::~ValueFader void   )  [inline, virtual]
 

Destructor.

Definition at line 35 of file ValueFader.h.

00035                                           {
00036                 }


Member Function Documentation

float pge::ValueFader::getChange void   )  [inline]
 

Definition at line 69 of file ValueFader.h.

References m_change.

00069                                       {
00070                         return m_change;
00071                 }

float pge::ValueFader::getMax void   )  [inline]
 

Definition at line 79 of file ValueFader.h.

References m_max.

00079                                    {
00080                         return m_max;
00081                 }

float pge::ValueFader::getMin void   )  [inline]
 

Definition at line 89 of file ValueFader.h.

References m_min.

00089                                    {
00090                         return m_min;
00091                 }

float pge::ValueFader::getValue void   )  [inline]
 

Definition at line 44 of file ValueFader.h.

References m_value.

Referenced by pge::DayNightCycle::getAmbientLight(), pge::DayNightCycle::getDayNightCycle(), and pge::DayNightCycle::update().

00044                                      {
00045                         return m_value;
00046                 }

void pge::ValueFader::setChange float  change  )  [inline]
 

Definition at line 74 of file ValueFader.h.

References m_change.

Referenced by pge::DayNightCycle::DayNightCycle().

00074                                              {
00075                         m_change = change;
00076                 }

void pge::ValueFader::setMax float  max  )  [inline]
 

Definition at line 84 of file ValueFader.h.

References m_max.

00084                                        {
00085                         m_max = max;
00086                 }

void pge::ValueFader::setMin float  min  )  [inline]
 

Definition at line 94 of file ValueFader.h.

References m_min.

00094                                        {
00095                         m_min = min;
00096                 }

void pge::ValueFader::setValue float  value  )  [inline]
 

Definition at line 49 of file ValueFader.h.

References m_value.

Referenced by pge::DayNightCycle::setDayNightCycle(), pge::DayNightCycle::setToDay(), pge::DayNightCycle::setToNight(), and pge::DayNightCycle::update().

00049                                            {
00050                         m_value = value;
00051                 }

void pge::ValueFader::update void   )  [inline]
 

Definition at line 54 of file ValueFader.h.

References m_change, m_max, m_min, m_value, and m_valuePlus.

Referenced by pge::DayNightCycle::update().

00054                                   {
00055                         if(m_valuePlus) {
00056                                 m_value += m_change;
00057                         } else {
00058                                 m_value -= m_change;
00059                         }
00060                         if(m_value >= m_max) {
00061                                 m_valuePlus = false;
00062                         }
00063                         if(m_value <= m_min) {
00064                                 m_valuePlus = true;
00065                         }
00066                 }


Field Documentation

float pge::ValueFader::m_change [private]
 

Definition at line 116 of file ValueFader.h.

Referenced by getChange(), setChange(), update(), and ValueFader().

float pge::ValueFader::m_max [private]
 

Definition at line 115 of file ValueFader.h.

Referenced by getMax(), setMax(), update(), and ValueFader().

float pge::ValueFader::m_min [private]
 

Definition at line 114 of file ValueFader.h.

Referenced by getMin(), setMin(), update(), and ValueFader().

float pge::ValueFader::m_value [private]
 

Definition at line 112 of file ValueFader.h.

Referenced by getValue(), setValue(), update(), and ValueFader().

bool pge::ValueFader::m_valuePlus [private]
 

Definition at line 113 of file ValueFader.h.

Referenced by update(), and ValueFader().


The documentation for this class was generated from the following file:
Generated on Mon Oct 16 12:09:50 2006 for Phobosengine by doxygen 1.3.4