KX_ISceneConverter.h

Go to the documentation of this file.

/*
 * $Id: KX_ISceneConverter.h 35063 2011-02-22 10:33:14Z jesterking $
 *
 * ***** 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_ISCENECONVERTER_H
#define __KX_ISCENECONVERTER_H

#include "STR_String.h"
#include "KX_Python.h"

#ifdef WITH_CXX_GUARDEDALLOC
#include "MEM_guardedalloc.h"
#endif

struct Scene;

class KX_ISceneConverter 
{

public:
        KX_ISceneConverter() :addInitFromFrame(false) {}//this addInitFromFrame is a back hack, todo remove
        virtual ~KX_ISceneConverter () {};

        /*
        scenename: name of the scene to be converted,
                if the scenename is empty, convert the 'default' scene (whatever this means)
        destinationscene: pass an empty scene, everything goes into this
        dictobj: python dictionary (for pythoncontrollers)
        */
        virtual void ConvertScene(
                class KX_Scene* destinationscene,
                class RAS_IRenderTools* rendertools, 
                class RAS_ICanvas*  canvas)=0;
        
        virtual void RemoveScene(class KX_Scene *scene)=0;

        virtual void    SetAlwaysUseExpandFraming(bool to_what) = 0;

        virtual void    SetNewFileName(const STR_String& filename) = 0;
        virtual bool    TryAndLoadNewFile() = 0;
        bool    addInitFromFrame;//rcruiz

        virtual void    ResetPhysicsObjectsAnimationIpo(bool clearIpo) = 0;

        
        virtual void    WritePhysicsObjectToAnimationIpo(int frameNumber) = 0;
        virtual void    TestHandlesPhysicsObjectToAnimationIpo() = 0;

        virtual void    resetNoneDynamicObjectToIpo()=0;

        // use blender materials
        virtual void SetMaterials(bool val) =0;
        virtual bool GetMaterials()=0;

        // use blender glsl materials
        virtual void SetGLSLMaterials(bool val) =0;
        virtual bool GetGLSLMaterials()=0;

        virtual struct Scene* GetBlenderSceneForName(const STR_String& name)=0;
        
        
#ifdef WITH_CXX_GUARDEDALLOC
public:
        void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:KX_ISceneConverter"); }
        void operator delete( void *mem ) { MEM_freeN(mem); }
#endif
};

#endif //__KX_ISCENECONVERTER_H