KX_IpoActuator.h

Go to the documentation of this file.

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#ifndef __KX_IPOACTUATOR
#define __KX_IPOACTUATOR

#include "SCA_IActuator.h"

class KX_IpoActuator : public SCA_IActuator
{
    Py_Header
private:
    void SetStartTime(float curtime);
    void SetLocalTime(float curtime);
    bool ClampLocalTime();

protected:
    bool    m_bNegativeEvent;

    float   m_startframe;
    
    float   m_endframe;

    bool    m_recurse;

    float   m_localtime;
    
    float   m_starttime;

    float   m_direction;

    STR_String  m_propname;

    STR_String  m_framepropname;

    bool    m_ipo_as_force;
    
    bool    m_ipo_add;
    
    bool    m_ipo_local;

    bool    m_bIpoPlaying;

    void    ResetStartTime();

public:
    enum IpoActType
    {
        KX_ACT_IPO_NODEF = 0,
        KX_ACT_IPO_PLAY,
        KX_ACT_IPO_PINGPONG,
        KX_ACT_IPO_FLIPPER,
        KX_ACT_IPO_LOOPSTOP,
        KX_ACT_IPO_LOOPEND,
        KX_ACT_IPO_KEY2KEY,
        KX_ACT_IPO_FROM_PROP,
        KX_ACT_IPO_MAX
    };

#ifdef WITH_PYTHON
    static PyObject*    pyattr_get_frame_start(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
    static int          pyattr_set_frame_start(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
    static PyObject*    pyattr_get_frame_end(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
    static int          pyattr_set_frame_end(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
#endif
    static const char *S_KX_ACT_IPO_PLAY_STRING;
    static const char *S_KX_ACT_IPO_PINGPONG_STRING;
    static const char *S_KX_ACT_IPO_FLIPPER_STRING;
    static const char *S_KX_ACT_IPO_LOOPSTOP_STRING;
    static const char *S_KX_ACT_IPO_LOOPEND_STRING;
    static const char *S_KX_ACT_IPO_KEY2KEY_STRING;
    static const char *S_KX_ACT_IPO_FROM_PROP_STRING;

    int string2mode(const char *modename);
    
    int m_type;

    KX_IpoActuator(SCA_IObject* gameobj,
                   const STR_String& propname,
                   const STR_String& framePropname,
                   float starttime,
                   float endtime,
                   bool recurse,
                   int acttype,
                   bool ipo_as_force,
                   bool ipo_add,
                   bool ipo_local);
    virtual ~KX_IpoActuator() {};

    virtual CValue* GetReplica() {
        KX_IpoActuator* replica = new KX_IpoActuator(*this);//m_float,GetName());
        replica->ProcessReplica();
        return replica;
    };

    void        SetStart(float starttime);
    void        SetEnd(float endtime);
    virtual     bool Update(double curtime, bool frame);

    /* --------------------------------------------------------------------- */
    /* Python interface ---------------------------------------------------- */
    /* --------------------------------------------------------------------- */
    
};

#endif //__KX_IPOACTUATOR