swingingPartActuator.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjcore/actuatorComponent.h"
#include "vrfmodel/vrfmodelDefines.h"
#include "vrfLua/luaScriptInterfaceImpl.h"
#include "vrfmodel/bindableLuaComponent.h"

class DtString;
class DtSimManager;
class DtBooleanInputPort;
class DtIntegerOutputPort;   
class DtSimObjectBaseObjectStateRepository;
class DtSwingingPartActuatorDescriptor;
class DtSwingingPartActuatorPSR;
class DtSwingingPartActuatorAxisInfo;

class DT_DLL_vrfmodel DtSwingingPartActuator : public DtActuatorComponent,
   public DtBindableLuaComponent<DtSwingingPartActuator>
{

public:

   DtSwingingPartActuator(const DtString& name, 
      DtVrfObject* owner,
      DtSimManager* simManager, 
      DtComponentDescriptor* desc = 0,
      DtReaderWriterRegistry* parentRegistry = 0);

   virtual ~DtSwingingPartActuator();

   virtual bool init();

   virtual bool postAddComponentsInit();

   virtual const char* type() const;

   virtual void tick();

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

   virtual void bindLuaFunctions(lua_State* L);
   virtual void bindLuaGlobals(lua_State* L);

public:
   virtual void open();
   virtual void openWithRate(double rate);

   virtual void reset();

   virtual void close();
   virtual void closeWithRate(double rate);

   virtual bool isOpened() const;

   virtual bool isClosed() const;

protected:

   enum DtPartState
   {
      State_Closed = 0,
      State_In_Transision = 1,
      State_Open = 2
   };

   virtual bool createPorts();

   virtual DtSwingingPartActuatorPSR* createPSR();

   virtual void setPositionAndRate(DtVector newPos, DtVector newRate);

   virtual bool angleWithinSlewArc(double angle, const DtSwingingPartActuatorAxisInfo& axisInfo);

   virtual DtPartState updateAxis(int axisNum, const DtSwingingPartActuatorAxisInfo& axisInfo, bool desiredOpen, DtVector& newPos, DtVector& newRate);

   virtual const DtSwingingPartActuatorAxisInfo& xAxisInfo() const;
   virtual const DtSwingingPartActuatorAxisInfo& yAxisInfo() const;
   virtual const DtSwingingPartActuatorAxisInfo& zAxisInfo() const;

private:
   DtSwingingPartActuator();
   DtSwingingPartActuator(const DtSwingingPartActuator & orig);
   const DtSwingingPartActuator & operator=(const 
      DtSwingingPartActuator & orig);

protected:


   DtIntegerOutputPort* myCurrentStateOutputPort;

   DtBooleanInputPort* myRequestedStateInputPort;

   DtArticulatedPartStateRepository *myArtPartStateRep;

   const DtSwingingPartActuatorDescriptor* myDescriptor;

   DtSwingingPartActuatorPSR* myProcessState;
};