SLGLUniform< T > Class Template Reference

Template for a single GLSL uniform variable. More...

#include <SLGLUniform.h>

Inheritance diagram for SLGLUniform< T >:

Public Member Functions
	SLGLUniform (SLUniformType type, const SLchar *name, T value, T inc=0.0f, T min=0.0f, T max=0.0f, SLKey keyInc=K_none)
	Constructs a custom uniform variable. More...
	SLGLUniform (const SLchar *name, function< T(void)> getFunc)
const SLchar *	name ()
T	value ()
SLbool	onKeyPress (const SLKey key, const SLKey mod) override
	Key press event-handler. More...
Public Member Functions inherited from SLEventHandler
	SLEventHandler ()
virtual	~SLEventHandler ()
virtual SLbool	onMouseDown (const SLMouseButton button, const SLint x, const SLint y, const SLKey mod)
virtual SLbool	onMouseUp (const SLMouseButton button, const SLint x, const SLint y, const SLKey mod)
virtual SLbool	onMouseMove (const SLMouseButton button, const SLint x, const SLint y, const SLKey mod)
virtual SLbool	onDoubleClick (const SLMouseButton button, const SLint x, const SLint y, const SLKey mod)
virtual SLbool	onMouseWheel (const SLint delta, const SLKey mod)
virtual SLbool	onTouch2Down (const SLint x1, const SLint y1, const SLint x2, const SLint y2)
virtual SLbool	onTouch2Move (const SLint x1, const SLint y1, const SLint x2, const SLint y2)
virtual SLbool	onTouch2Up (const SLint x1, const SLint y1, const SLint x2, const SLint y2)
virtual SLbool	onTouch3Down (const SLint x1, const SLint y1)
virtual SLbool	onTouch3Move (const SLint x1, const SLint y1)
virtual SLbool	onTouch3Up (const SLint x1, const SLint y1)
virtual SLbool	onKeyRelease (const SLKey key, const SLKey mod)
virtual SLbool	onRotationPYR (const SLfloat pitchRAD, const SLfloat yawRAD, const SLfloat rollRAD)
void	mouseRotationFactor (SLfloat rf)
SLfloat	mouseRotationFactor ()

Private Attributes
SLstring	_name
	Name of the variable. More...
T	_value
	Current value. More...
T	_max
	Max. value for IncInc, IncDec & random types. More...
T	_min
	Min. value for IncInc, IncDec & random types. More...
T	_inc
	Increment value for IncInc, IncDec & Inc types. More...
SLUniformType	_type
	Uniform1f type. More...
SLKey	_keyInc
	keyboard key incrementing const values More...
function< T(void)>	getValue
	lambda getter function More...

Additional Inherited Members
Protected Attributes inherited from SLEventHandler
SLfloat	_mouseRotationFactor
	Mouse rotation sensibility. More...
SLfloat	_keyboardDeltaPos
	Delta dist. for keyboard translation. More...

Detailed Description

template<class T>
class SLGLUniform< T >

Template for a single GLSL uniform variable.

Class for GLSL uniform variables that change per frame. An SLGLProgram holds a list of this type of uniform variables that are applied within the beginUse method.

Definition at line 23 of file SLGLUniform.h.

Constructor & Destructor Documentation

SLGLUniform() [1/2]

template<class T >

SLGLUniform< T >::SLGLUniform ( SLUniformType  type, const SLchar *  name, T  value, T  inc = 0.0f, T  min = 0.0f, T  max = 0.0f, SLKey  keyInc = K_none  )

inline

Constructs a custom uniform variable.

Parameters

type	Type of uniform variable
name	Name of uniform variable
value	Current value
inc	Increment value
min	Minimal value
max	Maximal value
keyInc	Key F1-F10 to increment the value decrement with SHIFT key

Definition at line 36 of file SLGLUniform.h.

    {
        _name   = name;
        _value  = value;
        _min    = min;
        _max    = max;
        _inc    = inc;
        _type   = type;
        _keyInc = keyInc;
 
        if (_keyInc != K_none && !(_keyInc >= K_F1 && _keyInc <= K_F10))
            SL_EXIT_MSG("Please use keys F1-F10 for uniform variables.");
    }

SLGLUniform() [2/2]

template<class T >

SLGLUniform< T >::SLGLUniform ( const SLchar *  name, function< T(void)>  getFunc  )

inline

Definition at line 56 of file SLGLUniform.h.

    {
        _name    = name;
        _type    = UT_lambda;
        getValue = getFunc;
    }

Member Function Documentation

name()

template<class T >

const SLchar* SLGLUniform< T >::name ( )

inline

Definition at line 64 of file SLGLUniform.h.

{ return _name.c_str(); }

onKeyPress()

template<class T >

SLbool SLGLUniform< T >::onKeyPress ( const SLKey  key, const SLKey  mod  )

inlineoverridevirtual

Key press event-handler.

Reimplemented from SLEventHandler.

Definition at line 116 of file SLGLUniform.h.

    {
        if (_keyInc != K_none)
        {
            if (key == _keyInc)
            {
                if (mod == K_none)
                {
                    if (_value < _max)
                    {
                        _value += _inc;
                        SL_LOG("Uniform: %s = %5.4f", _name.c_str(),(float)_value);
                        return true;
                    }
                    else if (_inc == _max) // Toggle between min & max
                    {
                        _value = _min;
                        SL_LOG("Uniform: %s = %5.4f", _name.c_str(),(float)_value);
                        return true;
                    }
                }
                else if (mod == K_shift)
                {
                    if (_value > _min)
                    {
                        _value -= _inc;
                        SL_LOG("Uniform: %s = %5.4f", _name.c_str(),(float)_value);
                        return true;
                    }
                }
            }
        }
        return false;
    }

value()

template<class T >

T SLGLUniform< T >::value ( )

inline

calculates the current value & returns it. This method is called on every frame.

Definition at line 70 of file SLGLUniform.h.

    {
        if (_type == UT_const)
            return _value;
 
        if (_type == UT_lambda)
            return getValue();
 
        if (_type == UT_incDec)
        {
            if ((_inc > 0.0f && _value >= _max) ||
                (_inc < 0.0f && _value <= _min)) _inc *= -1;
            _value += _inc;
            return _value;
        }
 
        if (_type == UT_incInc)
        {
            if (_inc > 0 && _value >= _max) _value = _min;
            if (_inc < 0 && _value <= _min) _value = _max;
            _value += _inc;
            return _value;
        }
 
        if (_type == UT_inc)
        {
            _value += _inc;
            return _value;
        }
 
        if (_type == UT_random)
        {
            _value = _min + ((T)rand() / (T)RAND_MAX) * (_max - _min);
            return _value;
        }
 
        if (_type == UT_seconds)
        {
            _value = (T)clock() / CLOCKS_PER_SEC;
            return _value;
        }
        else
            return _value;
    }

Member Data Documentation

_inc

template<class T >

T SLGLUniform< T >::_inc

private

Increment value for IncInc, IncDec & Inc types.

Definition at line 156 of file SLGLUniform.h.

_keyInc

template<class T >

SLKey SLGLUniform< T >::_keyInc

private

keyboard key incrementing const values

Definition at line 158 of file SLGLUniform.h.

_max

template<class T >

T SLGLUniform< T >::_max

private

Max. value for IncInc, IncDec & random types.

Definition at line 154 of file SLGLUniform.h.

_min

template<class T >

T SLGLUniform< T >::_min

private

Min. value for IncInc, IncDec & random types.

Definition at line 155 of file SLGLUniform.h.

_name

template<class T >

SLstring SLGLUniform< T >::_name

private

Name of the variable.

Definition at line 152 of file SLGLUniform.h.

_type

template<class T >

SLUniformType SLGLUniform< T >::_type

private

Uniform1f type.

Definition at line 157 of file SLGLUniform.h.

_value

template<class T >

T SLGLUniform< T >::_value

private

Current value.

Definition at line 153 of file SLGLUniform.h.

getValue

template<class T >

function<T(void)> SLGLUniform< T >::getValue

private

lambda getter function

Definition at line 159 of file SLGLUniform.h.

---

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

• SLGLUniform.h