laTimeTrig.h

/*

Jump'n'Run Engine
http://www.atanaslaskov.com/jnr/

BSD LICENSE
Copyright (c) 2007-2013, Atanas Laskov
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL ATANAS LASKOV BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/
#ifndef M_TIME_TRIG_H
#define M_TIME_TRIG_H




class laTimeTrig
{
protected:
    // Parameters of the time-trigger
    //
    double _dElapse, _dHold;
    M_BOOL _bCyclic;

    // Current status
    //
    M_BOOL _bEnabled, _bEvent, _bFired;
    double _nTimeLeft;

    // Event callback
    //
    void (*_pEventHandler)(void*);
    void *_pEventObject;

public:
    // Constructor/destructor
    //
    laTimeTrig(void);
    //~laTimeTrig(void);

    // Control methods
    //
    inline void    enable(M_BOOL bEnable=M_TRUE) { _bEnabled = bEnable; }

    inline void force() {
        _bFired = _bEvent = M_TRUE;
    };

    inline void reset() {
        _nTimeLeft = _dElapse;
        _bEvent    = M_FALSE;
        _bFired    = M_FALSE;
    }

    // Parameter setup methods
    //
    void parameters(double dElapse, double dHold=1, M_BOOL bCyclic=M_FALSE){
        _dElapse = dElapse;
        _dHold   = dHold;
        _bCyclic = bCyclic;
        reset();
    }

    void setElapseTime(double sec)          { _dElapse = sec; reset();}
    void setHoldTime(double sec)            { _dHold   = sec; reset();}
    void setCyclic(M_BOOL bCylcic=M_TRUE)   { _bCyclic = bCylcic; reset();}

    double getElapseTime()  const{ return _dElapse; }
    double getHoldTime()        const{ return _dHold; }

    // Query parameters and status
    //
    inline M_BOOL isEnabled() const{ return _bEnabled; }
    inline M_BOOL isElapsed() const{ return _bEvent; }

    inline double timeRemaining()   const{ return _bEvent ? 0 : _nTimeLeft; }               //< remaining between [t - 0]
    inline double timeElapsed() const{ return _bEvent ? _dElapse : _dElapse-_nTimeLeft; }   //< elapsed between [0 - t]

    inline double progress()    const{ return timeElapsed()/_dElapse; }         //< progress varies between [0 - 1]
    inline double reminder()    const{ return timeRemaining()/_dElapse; }       //< reminder varies between [1 - 0]

    // Event callback function
    //
    void setEventHandler( void (*pEventHandler)(void*), void* pObject ){
        _pEventHandler = pEventHandler;
        _pEventObject = pObject;
    }

    // "Animate" the time triggered event; This method must be called on every frame,
    // when the time-trigger needs to be active
    //
    void animate(class laTimer &t);

};
#endif //#ifndef M_TIME_TRIG_H