KX_SceneActuator.cpp

Go to the documentation of this file.

/*
 * Set scene/camera stuff
 *
 *
 * ***** 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 *****
 */

#include "SCA_IActuator.h"
#include "KX_SceneActuator.h"
#include <iostream>
#include "KX_Scene.h"
#include "KX_Camera.h"
#include "KX_KetsjiEngine.h"

/* ------------------------------------------------------------------------- */
/* Native functions                                                          */
/* ------------------------------------------------------------------------- */

KX_SceneActuator::KX_SceneActuator(SCA_IObject *gameobj, 
                                   int mode,
                                   KX_Scene *scene,
                                   KX_KetsjiEngine* ketsjiEngine,
                                   const STR_String& nextSceneName,
                                   KX_Camera* camera)
                                   : SCA_IActuator(gameobj, KX_ACT_SCENE)
{
    m_mode = mode;
    m_scene  = scene;
    m_KetsjiEngine=ketsjiEngine;
    m_camera = camera;
    m_nextSceneName = nextSceneName;
    if (m_camera)
        m_camera->RegisterActuator(this);
} /* End of constructor */



KX_SceneActuator::~KX_SceneActuator()
{ 
    if (m_camera)
        m_camera->UnregisterActuator(this);
} /* end of destructor */



CValue* KX_SceneActuator::GetReplica()
{
    KX_SceneActuator* replica = new KX_SceneActuator(*this);
    replica->ProcessReplica();
    return replica;
}

void KX_SceneActuator::ProcessReplica()
{
    if (m_camera)
        m_camera->RegisterActuator(this);
    SCA_IActuator::ProcessReplica();
}

bool KX_SceneActuator::UnlinkObject(SCA_IObject* clientobj)
{
    if (clientobj == (SCA_IObject*)m_camera)
    {
        // this object is being deleted, we cannot continue to track it.
        m_camera = NULL;
        return true;
    }
    return false;
}

void KX_SceneActuator::Relink(CTR_Map<CTR_HashedPtr, void*> *obj_map)
{
    void **h_obj = (*obj_map)[m_camera];
    if (h_obj) {
        if (m_camera)
            m_camera->UnregisterActuator(this);
        m_camera = (KX_Camera*)(*h_obj);
        m_camera->RegisterActuator(this);
    }
}


bool KX_SceneActuator::Update()
{
    // bool result = false; /*unused*/
    bool bNegativeEvent = IsNegativeEvent();
    RemoveAllEvents();

    if (bNegativeEvent)
        return false; // do nothing on negative events

    switch (m_mode)
    {
    case KX_SCENE_RESTART:
        {
            m_KetsjiEngine->ReplaceScene(m_scene->GetName(),m_scene->GetName());
            break;
        }
    case KX_SCENE_SET_CAMERA:
        if (m_camera)
        {
            m_scene->SetActiveCamera(m_camera);
        }
        else
        {
            // if no camera is set and the parent object is a camera, use it as the camera
            SCA_IObject* parent = GetParent();
            if (parent->GetGameObjectType()==SCA_IObject::OBJ_CAMERA)
            {
                m_scene->SetActiveCamera((KX_Camera*)parent);
            }
        }
        break;
    default:
        break;
    }
    
    if (!m_nextSceneName.Length())
        return false;
    
    switch (m_mode)
    {
    case KX_SCENE_SET_SCENE:
        {
            m_KetsjiEngine->ReplaceScene(m_scene->GetName(),m_nextSceneName);
            break;
        }
    case KX_SCENE_ADD_FRONT_SCENE:
        {
            bool overlay=true;
            m_KetsjiEngine->ConvertAndAddScene(m_nextSceneName,overlay);
            break;
        }
    case KX_SCENE_ADD_BACK_SCENE:
        {
            bool overlay=false;
            m_KetsjiEngine->ConvertAndAddScene(m_nextSceneName,overlay);
            break;
        }
    case KX_SCENE_REMOVE_SCENE:
        {
            m_KetsjiEngine->RemoveScene(m_nextSceneName);
            break;
        }
    case KX_SCENE_SUSPEND:
        {
            m_KetsjiEngine->SuspendScene(m_nextSceneName);
            break;
        }
    case KX_SCENE_RESUME:
        {
            m_KetsjiEngine->ResumeScene(m_nextSceneName);
            break;
        }
    default:
        ; /* do nothing? this is an internal error !!! */
    }
    
    return false;
}



/*  returns a camera if the name is valid */
KX_Camera* KX_SceneActuator::FindCamera(const char *camName)
{
    KX_SceneList* sl = m_KetsjiEngine->CurrentScenes();
    STR_String name = STR_String(camName);
    KX_SceneList::iterator it = sl->begin();
    KX_Camera* cam = NULL;

    while ((it != sl->end()) && (!cam))
    {
        cam = (*it)->FindCamera(name);
        it++;
    }

    return cam;
}



KX_Scene* KX_SceneActuator::FindScene(const char * sceneName)
{
    return m_KetsjiEngine->FindScene(sceneName);
}


#ifdef WITH_PYTHON

/* ------------------------------------------------------------------------- */
/* Python functions                                                          */
/* ------------------------------------------------------------------------- */

/* Integration hooks ------------------------------------------------------- */
PyTypeObject KX_SceneActuator::Type = {
    PyVarObject_HEAD_INIT(NULL, 0)
    "KX_SceneActuator",
    sizeof(PyObjectPlus_Proxy),
    0,
    py_base_dealloc,
    0,
    0,
    0,
    0,
    py_base_repr,
    0,0,0,0,0,0,0,0,0,
    Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
    0,0,0,0,0,0,0,
    Methods,
    0,
    0,
    &SCA_IActuator::Type,
    0,0,0,0,0,0,
    py_base_new
};

PyMethodDef KX_SceneActuator::Methods[] =
{
    {NULL,NULL} //Sentinel
};

PyAttributeDef KX_SceneActuator::Attributes[] = {
    KX_PYATTRIBUTE_STRING_RW("scene",0,MAX_ID_NAME-2,true,KX_SceneActuator,m_nextSceneName),
    KX_PYATTRIBUTE_RW_FUNCTION("camera",KX_SceneActuator,pyattr_get_camera,pyattr_set_camera),
    KX_PYATTRIBUTE_BOOL_RW("useRestart", KX_SceneActuator, m_restart),
    KX_PYATTRIBUTE_INT_RW("mode", KX_SCENE_NODEF+1, KX_SCENE_MAX-1, true, KX_SceneActuator, m_mode),
    { NULL }    //Sentinel
};

PyObject* KX_SceneActuator::pyattr_get_camera(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef)
{
    KX_SceneActuator* actuator = static_cast<KX_SceneActuator*>(self);
    if (!actuator->m_camera)
        Py_RETURN_NONE;
    
    return actuator->m_camera->GetProxy();
}

int KX_SceneActuator::pyattr_set_camera(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value)
{
    KX_SceneActuator* actuator = static_cast<KX_SceneActuator*>(self);
    KX_Camera *camOb;
    
    if (!ConvertPythonToCamera(value, &camOb, true, "actu.camera = value: KX_SceneActuator"))
        return PY_SET_ATTR_FAIL;
    
    if (actuator->m_camera)
        actuator->m_camera->UnregisterActuator(actuator);
    
    if(camOb==NULL) {
        actuator->m_camera= NULL;
    }
    else {  
        actuator->m_camera = camOb;
        actuator->m_camera->RegisterActuator(actuator);
    }
    
    return PY_SET_ATTR_SUCCESS;
}

#endif // WITH_PYTHON

/* eof */