SG_Controller.h

Go to the documentation of this file.

/*
 * Implementationclass to derive controllers from
 *
 * $Id: SG_Controller.h 35082 2011-02-22 19:30:37Z 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 __SG_CONTROLLER_H
#define __SG_CONTROLLER_H

#include "SG_IObject.h"

class SG_Controller 
{
public:

#ifdef WITH_CXX_GUARDEDALLOC
        void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "SG_Controller"); }
        void operator delete( void *mem ) { MEM_freeN(mem); }
#endif

        SG_Controller(
        ) :
                m_pObject(NULL) {
        }

        virtual 
        ~SG_Controller(
        ) {};

        virtual 
                bool    
        Update(
                double time
        )=0;

        virtual 
                void 
        SetObject (
                SG_IObject* object
        );

                void
        ClearObject(
        );

        virtual 
                void    
        SetSimulatedTime(
                double time
        )=0;

        virtual 
                SG_Controller*  
        GetReplica(
                class SG_Node* destnode
        )=0;

        virtual
                void
        SetOption(
                int option,
                int value
        )=0;

        enum SG_Controller_option {
                SG_CONTR_NODEF = 0,
                SG_CONTR_IPO_IPO_AS_FORCE,
                SG_CONTR_IPO_IPO_ADD,
                SG_CONTR_IPO_LOCAL,
                SG_CONTR_IPO_RESET,
                SG_CONTR_CAMIPO_LENS,
                SG_CONTR_CAMIPO_CLIPEND,
                SG_CONTR_CAMIPO_CLIPSTART,
                SG_CONTR_MAX
        };

protected:
        SG_IObject*             m_pObject;

};

#endif //__SG_CONTROLLER_H