vreLadderClimbingActuatorDescriptor.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreLadderClimbingActuatorDescriptor.h
//! \ingroup vreVrfobjparam
//! \brief Ladder climbing actuator descriptor for VREngage
//!
//! This file defines the DtLadderClimbingActuatorDescriptor class, which configures
//! ladder climbing actuator components in VREngage. It extends the base actuator
//! component descriptor to add ladder climbing speed parameters.
 
#pragma once
 
#include "vreVrfobjparam/export.h"
 
#include <vrfobjparam/actuatorComponentDescriptor.h>
 
 
namespace makVre
{
//! \brief Type identifier string for the ladder climbing actuator descriptor
const char DtLadderClimbingActuatorDescriptorType[] = "vre-ladder-climbing-actuator-descriptor";
 
//! \brief Ladder climbing actuator descriptor for VREngage
//!
//! This class defines a descriptor for ladder climbing actuator components in VREngage.
//! It extends the base actuator component descriptor to add configuration for
//! ladder climbing speed, which affects how quickly human entities can climb ladders
//! in VREngage simulations.
class VREVRFOBJPARAM_DLL DtLadderClimbingActuatorDescriptor : public DtActuatorComponentDescriptor
{
public:
   //! \brief Constructor with component name
   //! \param name The name of this component
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new ladder climbing actuator descriptor with the specified name.
   DtLadderClimbingActuatorDescriptor(const DtString& name, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Constructor with component name as symbol string
   //! \param name The name of this component as a symbol string
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new ladder climbing actuator descriptor with the specified name.
   DtLadderClimbingActuatorDescriptor(const DtSymbolString& name, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Copy constructor
   //! \param orig The source descriptor to copy from
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new ladder climbing actuator descriptor as a copy of the provided original.
   DtLadderClimbingActuatorDescriptor(
      const DtLadderClimbingActuatorDescriptor& orig, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Assignment operator
   //! \param orig The source descriptor to copy from
   //! \return Reference to this descriptor after assignment
   //!
   //! Assigns the contents of the provided descriptor to this one.
   DtLadderClimbingActuatorDescriptor& operator=(const DtLadderClimbingActuatorDescriptor& orig);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the descriptor.
   virtual ~DtLadderClimbingActuatorDescriptor() override;
 
   //! \brief Gets the type identifier for this descriptor
   //! \return String identifying this descriptor type
   //!
   //! Returns a unique type identifier string for this descriptor type.
   //! Will return DtLadderClimbingActuatorDescriptorType.
   virtual DtString type() const override;
 
   //! \brief Creates a clone of this descriptor
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //! \return Pointer to a new descriptor that is a clone of this one
   //!
   //! Creates a new ladder climbing actuator descriptor as a deep copy of this one.
   virtual DtComponentDescriptor* clone(DtReaderWriterRegistry* parentRegistry = NULL) const override;
 
   //! \brief Gets the ladder climbing speed
   //! \return The ladder climbing speed in meters per second
   //!
   //! Returns the maximum speed at which entities can climb ladders.
   virtual DtReal ladderClimbingSpeed() const;
 
   //! \brief Sets the ladder climbing speed
   //! \param speed The ladder climbing speed in meters per second
   //!
   //! Sets the maximum speed at which entities can climb ladders.
   virtual void setLadderClimbingSpeed(DtReal speed);
 
   //! \brief Factory function to create a new instance of this descriptor
   //! \return Pointer to a newly created descriptor
   //!
   //! Static factory function used by the descriptor creation system to instantiate
   //! new instances of this descriptor type.
   static DtComponentDescriptor* creator();
 
public:
   //! \brief Default ladder climbing speed
   //!
   //! The default value for ladder climbing speed is 0.4 meters per second.
   static double theDefaultLadderClimbingSpeed;
 
protected:
   //! \brief Default constructor (not implemented)
   //!
   //! Default constructor is protected and not implemented to prevent
   //! creation of instances without proper initialization.
   DtLadderClimbingActuatorDescriptor();
 
protected:
   //! \brief Maximum ladder climbing speed
   //!
   //! The maximum speed at which entities can climb ladders.
   //! Parameter name: "ladder-climbing-speed"
   //! Default value: 0.4 meters per second
   DtRwReal myLadderClimbingSpeed;
};
} // namespace makVre