scriptedMovementController.h

Go to the documentation of this file.

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

#pragma once

#include "vrfmodel/vrfmodelDefines.h"
#include "vrfmodel/bindableLuaComponent.h"
#include "vrfobjcore/singleTaskControllerComponent.h"
#include "vrfMsgTransport/fireEvent.h"
#include "vrfutil/scriptedMovementObject.h"

class DtBooleanOutputPort;
class DtScriptedMovementControllerPSR;
class DtUpdateRepositoryOutputPortGroup;

class DT_DLL_vrfmodel DtScriptedMovementController : public DtSingleTaskControllerComponent
{
private:
   //Not Implemented.
   DtScriptedMovementController();
   //Not Implemented.
   DtScriptedMovementController(const DtScriptedMovementController& orig);
   //Not Implemented.
   DtScriptedMovementController& operator=(const DtScriptedMovementController& orig);

public:

   //\copydoc DtSimComponent(const DtString&,DtLocalObject*,DtSimulationServices*,
   //DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)
   DtScriptedMovementController(const DtString& name, 
      DtLocalObject* owner,
      DtSimulationServices* simManager, 
      DtComponentDescriptor* desc = NULL,
      DtReaderWriterRegistry* parentRegistry = NULL);

   virtual ~DtScriptedMovementController();

   //Initial setup of component after creation. Register attribute provider functions.
   virtual bool init();

   //Creates the process state repository for this component.
   virtual bool createPSR();

   //\copydoc DtSimComponent::type()
   //\return DtScriptedMovementControllerType.
   virtual const char* type() const;

   //Main processing for component.
   virtual void tick();

   virtual void setDesiredLocation(const DtVector&);

   virtual void setDesiredSpeed(const DtVector& velocity, const DtVector& acceleration);

   virtual void setDesiredRotationalVelocity(const DtVector&);

   virtual void setDesiredOrientation(const DtTaitBryan&);

   virtual void clearTask();

   virtual DtScriptedMovementControllerPSR* getPSR(){return myProcessState;}

   static DtReaderWriter* provideAnimationFrame(void* controller);

protected:

   virtual void registerTaskMsgCallbacks();
   static void scriptedMovementTaskCallback(DtSimMessage* msg, void* usr);
   virtual void processScriptedMovementTask(DtSimMessage* msg);

   virtual void preFirstTickInit();

   virtual bool setup();

   virtual makVrfEvents::DtFireEvent* createFireInteraction();

   virtual void finishUp();
   virtual void sendDetonation();

   static void animatedMovementTaskCallback( DtSimMessage* msg, void* usr );
   virtual void processAnimatedMovementTask( DtSimMessage* msg );

   virtual int detonationResultFromDistance( double d, const DtVector& detonationPosition, const DtEntityType& targetType ) const;

   virtual bool createPortGroups() override;
   virtual bool createPorts() override;

   virtual bool createNegateSpeedPort();

   virtual bool tickWhileDestroyed() const;

   virtual void setupInitialState();

   virtual void updateTaskVisualizations();

public:

   //\copydoc DtSimComponent(const DtString&,DtLocalObject*,DtSimulationServices*,
   //DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)
   //\return New instance of this class.
   static DtSimComponent * creator( const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager,
      DtComponentDescriptor* desc = 0, DtReaderWriterRegistry* parentRegistry = 0 );

protected:

   DtScriptedMovementControllerPSR* myProcessState;
   DtSimObjectReference myTargetPoint;
   bool myInitialized;

   DtUpdateRepositoryOutputPortGroup* myUpdateRepositoryOutputPortGroup;

   DtBooleanOutputPort* myNegateSpeedPort;

   bool myCompleteNextTick;

};