vreHumanCrosswalkController.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreHumanCrosswalkController.h
//! \ingroup vreVrfmodel
//! \brief Controller for human crosswalk behavior
//!
//! This file defines the DtVreHumanCrosswalkController class which models the behavior
//! of human entities when approaching and crossing at crosswalks. It handles street
//! crossing logic including checking for approaching vehicles before crossing.
 
#pragma once
 
#include "vreVrfmodel/export.h"
#include <vrfmodel/humanCrosswalkController.h>
#include "vreVrfModel/vreSimComponent.h"
 
namespace makVre
{
//! \brief Type identifier for the VRE human crosswalk controller component
const char DtVreHumanCrosswalkControllerType[] = "vre-human-crosswalk-controller";
 
//! \brief Controller for modeling human crosswalk behavior
//!
//! DtVreHumanCrosswalkController models the behavior of human entities when
//! approaching and crossing at crosswalks. It manages the human's awareness of
//! traffic, decision-making for when to cross safely, and interactions with
//! traffic signals. The controller modifies the entity's movement based on
//! environmental conditions and perceived safety.
//!
//! Uses Descriptor Type: DtVreHumanCrosswalkControllerDescriptor
class VREVRFMODEL_DLL DtVreHumanCrosswalkController : public DtVreSimComponent<DtHumanCrosswalkController>
{
private:
   //! \brief Default constructor (not implemented)
   //!
   //! Default constructor is private and not implemented to prevent
   //! creation of instances without proper initialization.
   DtVreHumanCrosswalkController();
   //! \brief Copy constructor (not implemented)
   //!
   //! Copy constructor is private and not implemented to prevent
   //! copy construction.
   DtVreHumanCrosswalkController(const DtVreHumanCrosswalkController& orig);
   //! \brief Assignment operator (not implemented)
   //! \return Reference to this object
   //!
   //! Assignment operator is private and not implemented to prevent assignment.
   DtVreHumanCrosswalkController& operator=(const DtVreHumanCrosswalkController& orig);
 
public:
   //! \brief Constructor
   //! \param name The name of this component
   //! \param owner The local object that owns this component
   //! \param simManager The simulation services manager
   //! \param desc Component descriptor with configuration parameters
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //!
   //! Creates a new human crosswalk controller component with the specified parameters.
   DtVreHumanCrosswalkController(const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager,
      DtComponentDescriptor* desc = 0, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the human crosswalk controller component.
   virtual ~DtVreHumanCrosswalkController() override;
 
   //! \brief Gets the type identifier for this component
   //! \return String identifying the component type (DtVreHumanCrosswalkControllerType)
   //!
   //! Implements the DtSimComponent::type() method to return the
   //! type identifier for this component.
   virtual const char* type() const override;
 
   //! \brief Updates the controller state each simulation frame
   //!
   //! Processes the human entity's crosswalk behavior during each simulation frame.
   //! This includes detecting nearby crosswalks, checking for approaching vehicles,
   //! and making decisions about when to cross safely. The controller adjusts the
   //! entity's movement based on these assessments.
   virtual void tick() override;
 
   //! \brief Factory method to create a new instance of this component
   //! \param name The name for the new component
   //! \param owner The local object that will own this component
   //! \param simManager The simulation services manager
   //! \param desc Optional component descriptor
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //! \return Pointer to the newly created component
   //!
   //! Static factory method used by the component creation system to instantiate
   //! new instances of this component type.
   static DtSimComponent* creator(const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager,
      DtComponentDescriptor* desc = 0, DtReaderWriterRegistry* parentRegistry = 0);
};
 
} // namespace makVre