vehicleBlinkerActuator.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2024 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vehicleBlinkerActuator.h
//! \ingroup vreExamples
 
//! \brief DtVehicleBlinkerActuator; actuator that controls vehicle turn signal lights.
#pragma once
 
#include "vrfobjcore/actuatorComponent.h"
#include <vrfobjcore/localObject.h>
 
// OBJ Core
#include <vrfobjcore/boolIOPort.h>
 
namespace makVre
{
class DtVehicleBlinkerDescriptor;
 
constexpr char DtVehicleBlinkerActuatorType[] = "vehicle-blinker-actuator";
 
class DtVehicleBlinkerActuator : public DtActuatorComponent
{
public:
   //! \copydoc DtSimComponent(const DtString&,DtLocalObject*,DtSimulationServices*,
   //! DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)
   DtVehicleBlinkerActuator(const DtString& name,
      DtLocalObject* owner,
      DtSimulationServices* simManager,
      DtComponentDescriptor* desc = nullptr,
      DtReaderWriterRegistry* parentRegistry = nullptr);
 
   //! default constructor; not implemented
   DtVehicleBlinkerActuator() = delete;
 
   //! copy constructor; not implemented
   DtVehicleBlinkerActuator(const DtVehicleBlinkerActuator& orig) = delete;
 
   //! assignment operator; not implemented
   const DtVehicleBlinkerActuator& operator=(const DtVehicleBlinkerActuator& orig) = delete;
 
   //! destructor
   virtual ~DtVehicleBlinkerActuator() override;
 
public:
   virtual bool init() override;
 
   //! \copydoc DtSimComponent::type()
   //! \return DtVehicleBlinkerActuatorType
   virtual const char* type() const override;
 
   virtual void tick() override;
 
   //! \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 = nullptr,
      DtReaderWriterRegistry* parentRegistry = nullptr);
 
protected:
   //! Overridden to create local input ports for blinker commands.
   virtual bool createPorts() override;
 
   //! Updates left blinker lighting state based on current property value.
   void updateLeftBlinker();
 
   //! Updates right blinker lighting state based on current property value.
   void updateRightBlinker();
 
protected:
   DtVehicleBlinkerDescriptor* myLightsDescriptor;
 
   DtBooleanInputPort* myLeftBlinkerPort;
   DtBooleanInputPort* myRightBlinkerPort;
 
   DtRwBoolean* myLeftBlinkerActive;
   DtRwBoolean* myRightBlinkerActive;
};
 
} // namespace makVre