MercuryObjectCommands.h

Go to the documentation of this file.

#ifndef MERCURYOBJECTCOMMANDS_H
#define MERCURYOBJECTCOMMANDS_H

#include "global.h"
#include "MercuryCommands.h"
#include <map>
#include <vector>

//Class definition, to allow use of class (but not including)
class MercuryObject;
class MercuryTweenOperation;

typedef void (*MercuryTweenFunction)( const float fPercent, const float fLastPercent, MercuryObject * pObject, MercuryTweenOperation * pOperation );
typedef float (*MercuryTweenType)( const float fPercent, PStack & pArgs  );

class AutoCommandRegisterer
{
public:
    MercuryTweenFunction GetFunction( const MString &name );
    int RegisterFunction( MercuryTweenFunction fnct, const MString & name );

    MercuryTweenType GetTweenType( const MString &name );
    int RegisterTweenType( MercuryTweenType fnct, const MString & name );
    
    std::map< MString, MercuryTweenFunction > * sMapFunctions;
    std::map< MString, MercuryTweenType > * sMapTweens;

    int sNumFunctions;
};
extern AutoCommandRegisterer CommandRegisterer;

class MercuryTweenOperation
{
public:
    MercuryTweenFunction    Function;
    MString                 Command;    //Object-specific command
    PStack                  Parameters;
};

class MercuryTween
{
public:
    MercuryTween();
    MercuryTween( const MercuryTween & rhs );
    MercuryTween & operator = ( const MercuryTween & rhs );
    ~MercuryTween();
    MVector< MercuryTweenOperation *> Operations;
    void Operate(  const float fPercent, const float fLastPercent, MercuryObject * pObject );
    float   fStart;
    float   fEnd;
    MercuryTweenType pTT;
    PStack  pTArgs;
    PStack  pKArgs;
    bool bAutoDelete;
    bool bDeleteChildren;
    int     iEndBase;
};

class MercuryTweenState
{
public:
    enum SPACE
    {
        CURRENT = 0,
        LOCAL,
        GLOBAL
    };
    MercuryTweenState();
    MercuryTweenState( const MercuryTweenState & rhs );
    MercuryTweenState & operator = ( const MercuryTweenState & rhs );
    ~MercuryTweenState();

    void AttachToObject( MercuryObject * object );
    void Update( float fDeltaTime );

    //Timestamps here relative to now=0
    void AddCommand( MercuryTween * ToPush, float fFuture = 0, SPACE iWhichPlace = CURRENT, MString sTweenName = "" );
    void AddCommand( const MString &command, SPACE iWhichPlace = CURRENT, MString sTweenName = "" );

    void ExecuteCommand( const MString & sName, const PStack & pKArgs );

    void FinishTweening();
    void StopTweening();
    void PauseTweening() { m_bPauseTweening = true; }
    void ResumeTweening() { m_bPauseTweening = false; }
    bool IsTweeningPaused() { return m_bPauseTweening; }

    //Temporary work around.  We need to have this public
    //so that tweens can access KArgs for the current tween
    MercuryTween * m_pCurrentTween;

    bool IsTweening() const { return !m_qTweens.empty(); } 
private:

    float CalculateRemainingPercent( float fDeltaTime );
    float CalculateCurrentPercent( float fDeltaTime );

    float   m_fCurTime;
    bool    m_bPauseTweening;
    float   m_fRunningEnd;

    MercuryObject * m_pObject;
    MDeque< MercuryTween * > m_qTweens;

    void InternalUpdate( float fDeltaTime, bool bFinish = false );

    std::map< MString, std::vector< MercuryTween * > > m_LocalTweens;
    static std::map< MString, std::vector< MercuryTween * > > m_GlobalTweens;
    bool    m_bCloned;
};

#endif

/* 
 * Copyright (c) 2005-2006, Charles Lohr
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 *  -   Redistributions of source code must retain the above
 *      copyright notice, this list of conditions and the following disclaimer.
 *  -   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.
 *  -   Neither the name of the <ORGANIZATION> nor the names of its
 *      contributors may be used to endorse or promote products derived from
 *      this software without specific prior written permission.
 *
 * 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 THE COPYRIGHT OWNER OR CONTRIBUTORS 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.
 */

---

Hosted by