include/vrfLua/luaScriptController.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2010 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

#pragma once

#include <vrfLua/vrfLuaDefines.h>
#include <vrfLua/scriptPSR.h>

#include <vrfobjcore/singleTaskControllerComponent.h>
#include <vrftasks/userTask.h>
#include <vrfobjcore/entityTargetInformation.h>

#include <lua.hpp>
#include <lauxlib.h>
#include <lualib.h>

class DtAnalogOutputPort;
class DtBooleanOutputPort;
class DtConstrainedIntegerOutputPort;
class DtConstrainedAnalogOutputPort;
class DtOutputPortGroup;
class DtGroundVehicleStateRepository;
class DtScenario;
class DtAnalogOutputPort;
class DtAnalogOutputPort;
class DtOutputPortGroup;
class DtSensorContactListInputPort;
class DtSensorContactInfoList;
class DtVrfObjectMessage;
class DtTextReport;
class DtSetLocationRequest;

namespace vrfLua
{
   class DtLuaScriptManager;

const char DtLuaScriptControllerType[] = "lua-script-controller";

static void setLocationRequestCallack(DtSimMessage * msg, void * usrData);

static void textRadioMessageCallback(DtSimMessage * msg, void * usrData);

class DT_DLL_vrfLua DtLuaScriptController : public DtSingleTaskControllerComponent
{
public:

   DtLuaScriptController(const DtString & name, DtVrfObject* owner, 
      DtSimManager * simManager, DtComponentDescriptor* desc = NULL,
      DtReaderWriterRegistry * parentRegistry = 0);
   
   virtual ~DtLuaScriptController();
   
   DtLuaScriptController(const DtLuaScriptController& orig);
   
   DtLuaScriptController& operator=(const DtLuaScriptController& orig);

   virtual bool init(DtLuaScriptManager* manager);

   virtual bool createScriptPSR();

   virtual void setLuaState(lua_State* L);
   virtual lua_State* getLuaState();
   
   virtual DtString type() const;

   static DtSimComponent* creator(const DtString& name, 
      DtVrfObject* owner, DtSimManager* simManager, DtComponentDescriptor* desc,
      DtReaderWriterRegistry* parentRegistry);


   virtual void registerTaskMsgCallbacks();

   virtual void unregisterTaskMsgCallbacks();
   
   
   const DtSensorContactInfoList& getSensorContacts();

   static void setScriptCallback(DtSimMessage* msg, void* usr);
   virtual void processSetScript(DtSimMessage* msg);
   void setScript(const DtString & name);
   virtual DtString getScriptName();
   virtual void setScriptNameAndLoad(const DtString & name);
   virtual DtString getScriptSerialization();
   virtual void setScriptFromSerialization(const DtString & buffer);
   
   static void setViewTargetCallback(DtSimMessage* msg, void* usr);
   
   virtual void processSetViewTarget(DtSimMessage* msg);

   
   virtual void processTextRadioMessage(DtTextReport * textReport);

   virtual void processLocationRequest(DtSetLocationRequest * textReport);

   virtual DtBoolean checkTick();

   virtual void NotifyTaskCompleted(bool success = true);

   virtual void clearTask();

   virtual void tick();

   virtual void firstTick();

   virtual bool tickWhileDestroyed() const;


protected: 
   
   virtual DtBoolean createPortGroups();
   virtual DtBoolean createPorts();

   static void requestScriptNameCallback(const DtVrfObjectMessage * msg, void* usr);
   virtual void processRequestScriptName(const DtVrfObjectMessage * msg);
   
   virtual DtBoolean deactivateOutputControl()
   {
      return DtFalse; 
   }

   virtual void sendScriptName(const DtString& script, const DtString& origSender);

   static void aboutToSaveCheckpointCallback(DtScenario& scn, void* usr);
   virtual void processAboutToSaveCheckpoint();

   static void postLoadCheckpointCallback(const DtScenario& scn, void* usr);
   static void postRewindCallback(void* usr);
   virtual void processPostLoadCheckpoint();


protected: 

   DtUserTask myUserTask;

   DtScriptPSR* myScriptPSR;
   DtLuaScriptManager* myScriptManager;

   bool myFirstTick;
   
   DtString myLUAScript;

   lua_State* myLState;

   bool m_luaScriptWarningShown;
};
}