translatablePartActuator.h

Go to the documentation of this file.

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



#pragma once

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

class DtString;
class DtSimulationServices;
class DtSimObjectBaseObjectStateRepository;
class DtTranslatablePartActuatorPSR;

namespace makVrf
{
   class DtArticulatedPartStateRepository;
}

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

   typedef DtTranslatablePartActuatorDescriptor::TranslationDirection TranslationDirection;

   DtTranslatablePartActuator(const DtString& name, 
      DtLocalObject* owner,
      DtSimulationServices* simManager, 
      DtComponentDescriptor* desc = 0,
      DtReaderWriterRegistry* parentRegistry = 0);

   virtual ~DtTranslatablePartActuator() override;

   virtual bool init() override;

   virtual bool postAddComponentsInit() override;

   virtual const char* type() const override;

   virtual void tick() override;

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

public:
   virtual void lower();

   virtual void raise();

   virtual void left();

   virtual void right();

   virtual void forward();

   virtual void backward();

   virtual void stop();

   virtual void pause();

   virtual void resume();

   virtual bool isFullyTranslatedToMaximum() const;

   virtual bool isFullyTranslatedToMinimum() const;

   virtual int state() const;

   virtual bool paused() const;

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

protected:
   virtual DtTranslatablePartActuatorPSR* createPSR();

   virtual double currentPosition();

   virtual void setPositionAndRate(double newPos, double newRate);

   virtual void updatePartState();

   virtual void initializePartState();

   virtual TranslationDirection translationDirection() const;

   virtual double rangeChangeRate() const;

   virtual double minRange() const;

   virtual double maxRange() const;

   static const DtString& translationDirectionString(TranslationDirection dir);

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

protected:


   makVrf::DtArticulatedPartStateRepository *myArtPartStateRep;

   const DtTranslatablePartActuatorDescriptor* myDescriptor;

   DtTranslatablePartActuatorPSR* myProcessState;
   bool myHasDuplicatePSR;

   DtPlatformLocalObjectFacade myPlatformLocalObjectFacade;
};