renderstack::control Class Reference

value control that can be updated over time

#include <control.hpp>

Public Member Functions
	control ()
void	clear ()
void	update ()
void	adjust (float delta)
void	dampen ()
void	more (bool apply)
void	less (bool apply)
void	stop (bool apply)
void	inhibit (bool apply)
void	set_max_delta (float max_delta)
void	set_damp (float damp)
float	current_delta () const
float	current_value () const
Static Protected Attributes
static const int	bit_more = 1
static const int	bit_less = 2
static const int	bit_stop = 4
static const int	bit_active = 8
static const int	bit_inhibit = 16
static const int	bit_dampen_linear = 32
static const int	bit_dampen_multiply = 64
static const int	bit_dampen_master = 128
static const int	bitmask_clear = bit_more | bit_less | bit_stop | bit_active | bit_inhibit

---

Detailed Description

Definition at line 38 of file control.hpp.

---

Constructor & Destructor Documentation

renderstack::control::control

(

)

Definition at line 193 of file control.cpp.

{
    clear();
}

---

Member Function Documentation

void renderstack::control::clear

(

)

Definition at line 198 of file control.cpp.

{
    m_damp           =  0.950f;
    m_max_delta      =  0.004f;
    m_max_value      =  1.000f;
    m_min_value      = -1.000f;
    m_current_delta  = 0;
    m_current_value  = 0;
    m_options       &= ~bitmask_clear;
    m_options       |=  bit_dampen_multiply;
}

void renderstack::control::update

(

)

Definition at line 32 of file control.cpp.

{
    if(
        ((m_options & bit_active ) == bit_active) &&
        ((m_options & bit_inhibit) == 0         )
    )
    {
        adjust(m_current_delta);
    }
    dampen();
}

void renderstack::control::adjust

(

float

delta

)

Definition at line 44 of file control.cpp.

{
    m_current_value += delta;

    if(m_current_value > m_max_value)
    {
        m_current_value = m_max_value;
    }
    else if(m_current_value < m_min_value)
    {
        m_current_value = m_min_value;
    }
}

void renderstack::control::dampen

(

)

Definition at line 58 of file control.cpp.

{
    if(
        (m_options & bit_dampen_multiply) == bit_dampen_multiply
    )
    {
        float old_value = m_current_value;
        m_current_value = m_current_value * m_damp;
        if(m_current_value == old_value)
        {
            m_current_value = 0;
        }
    }
    else if(
        ((m_options & bit_dampen_linear) == bit_dampen_linear) &&
        ((m_options & bit_active       ) == 0                )
    )

    {
        if(m_current_value > m_max_delta)
        {
            m_current_value -= m_max_delta;
            if(m_current_value < m_max_delta)
            {
                m_current_value = 0;
            }
        }
        else if(m_current_value < -m_max_delta)
        {
            m_current_value += m_max_delta;
            if(m_current_value > -m_max_delta)
            {
                m_current_value = 0;
            }
        }
        else
        {
            m_current_value *= m_damp;
        }
    }
}

void renderstack::control::more

(

bool

apply

)

Definition at line 100 of file control.cpp.

{
    if(apply)
    {
        m_options       |= bit_more | bit_active;
        m_current_delta  = m_max_delta;
    }
    else
    {
        m_options &= ~bit_more;
        if(
            (m_options & bit_less) == bit_less
        )
        {
            m_current_delta = -m_max_delta;
        }
        else
        {
            m_options       &= ~bit_active;
            m_current_delta  = 0;
        }
    }
}

void renderstack::control::less

(

bool

apply

)

Definition at line 124 of file control.cpp.

{
    if(apply)
    {
        m_options       |= bit_less | bit_active;
        m_current_delta  = -m_max_delta;
    }
    else
    {
        m_options &= ~bit_less;
        if(
            (m_options & bit_more) == bit_more)
        {
            m_current_delta = m_max_delta;
        }
        else
        {
            m_options       &= ~bit_active;
            m_current_delta  = 0;
        }
    }
}

void renderstack::control::stop

(

bool

apply

)

Definition at line 159 of file control.cpp.

{
    if(apply)
    {
        m_options |= bit_stop;
        if(m_current_value > 0)
        {
            m_current_delta = -m_max_delta;
        }
        else if(m_current_value < 0)
        {
            m_current_delta = m_max_delta;
        }
    }
    else
    {
        m_options &= ~bit_stop;
        if(
            ((m_options & bit_less) == bit_less) &&
            ((m_options & bit_more) == 0       )
        )
        {
            m_current_delta = -m_max_delta;
        }
        else if(
            ((m_options & bit_less) == 0       ) &&
            ((m_options & bit_more) == bit_more)
        )
        {
            m_current_delta = m_max_delta;
        }
    }
}

void renderstack::control::inhibit

(

bool

apply

)

Definition at line 147 of file control.cpp.

{
    if(apply)
    {
        m_options |= bit_inhibit;
    }
    else
    {
        m_options &= ~bit_inhibit;
    }
}

void renderstack::control::set_max_delta

(

float

max_delta

)

[inline]

Definition at line 63 of file control.hpp.

{ m_max_delta = max_delta; }

void renderstack::control::set_damp

(

float

damp

)

[inline]

Definition at line 64 of file control.hpp.

{ m_damp = damp; }

float renderstack::control::current_delta

(

)

const [inline]

Definition at line 66 of file control.hpp.

{ return m_current_delta; }

float renderstack::control::current_value

(

)

const [inline]

Definition at line 67 of file control.hpp.

{ return m_current_value; }

---

Field Documentation

const int renderstack::control::bit_more = 1 [static, protected]

Definition at line 41 of file control.hpp.

const int renderstack::control::bit_less = 2 [static, protected]

Definition at line 42 of file control.hpp.

const int renderstack::control::bit_stop = 4 [static, protected]

Definition at line 43 of file control.hpp.

const int renderstack::control::bit_active = 8 [static, protected]

Definition at line 44 of file control.hpp.

const int renderstack::control::bit_inhibit = 16 [static, protected]

Definition at line 45 of file control.hpp.

const int renderstack::control::bit_dampen_linear = 32 [static, protected]

Definition at line 46 of file control.hpp.

const int renderstack::control::bit_dampen_multiply = 64 [static, protected]

Definition at line 47 of file control.hpp.

const int renderstack::control::bit_dampen_master = 128 [static, protected]

Definition at line 48 of file control.hpp.

const int renderstack::control::bitmask_clear = bit_more | bit_less | bit_stop | bit_active | bit_inhibit [static, protected]

Definition at line 49 of file control.hpp.

---

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

• control.hpp
• control.cpp