vortexMovementPSR.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2024 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file    vortexMovementPSR.h
//! \brief   Process state repository for the Vortex movement actuator
//! \ingroup vreVrfVortex
 
#pragma once
 
#include "vreVrfVortex/export.h"
#include <vrfobjcore/vrfProcessStateRepository.h>
#include <readerWriter/rwBoolean.h>
 
namespace makVre
{
//! \brief Default name for the Vortex movement PSR
const char DtVortexMovementPSRDefaultName[] = "vortex-movement-process-state-repository-default";
 
//! \brief Type identifier for the Vortex movement PSR
const char DtVortexMovementPSRType[] = "vortex-movement-psr";
 
//! \brief Process state repository for the Vortex movement actuator
//!
//! Maintains state data for the DtVortexMovementActuator. This state is saved
//! as part of the scenario, ensuring persistence between scenario loads.
//! The primary state maintained is whether high-fidelity collision physics should
//! be used for stationary CGF entities.
class VREVRFVORTEX_DLL DtVortexMovementPSR : public DtVrfProcessStateRepository
{
public:
   //! \brief Constructor
   //!
   //! Creates a process state repository associated with a VR-Forces object.
   //!
   //! \param vrfObject The VR-Forces object this repository is associated with
   //! \param rwName Optional name for the reader/writer
   //! \param parentRegistry Optional parent registry
   DtVortexMovementPSR(DtLocalObject* vrfObject, const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Copy constructor
   //!
   //! Creates a new process state repository as a copy of an existing one.
   //!
   //! \param orig The original repository to copy
   //! \param rwName Optional name for the reader/writer
   //! \param parentRegistry Optional parent registry
   DtVortexMovementPSR(const DtVortexMovementPSR& orig, const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Destructor
   virtual ~DtVortexMovementPSR() override;
 
   //! \brief Assignment operator
   //!
   //! Copies the state from another repository to this one.
   //!
   //! \param orig The original repository to copy from
   //! \return Reference to this repository
   DtVortexMovementPSR& operator=(const DtVortexMovementPSR& orig);
 
   //! \brief Creates a clone of this repository
   //!
   //! \param rwName Optional name for the reader/writer
   //! \param parentRegistry Optional parent registry
   //! \return Pointer to the new repository
   virtual DtVrfProcessStateRepository* clone(const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0) const override;
 
   //! \brief Gets the type of this repository
   //!
   //! \return DtVortexMovementPSRType
   virtual DtString type() const override;
 
   //! \brief Sets whether high-fidelity collisions should be used for stationary CGF entities
   //!
   //! Controls whether entities should model high-fidelity Vortex collisions while in a CGF state
   //! but not currently executing any movement tasks.
   //!
   //! \param value True to enable high-fidelity collisions, false to disable
   virtual void setUseHiFiCollisionsInStationaryCgfState(bool value);
 
   //! \brief Checks if high-fidelity collisions should be used for stationary CGF entities
   //!
   //! \return True if high-fidelity collisions are enabled, false otherwise
   virtual bool useHiFiCollisionsInStationaryCgfState() const;
 
   //! \brief Factory method to create new instances of this class
   //!
   //! \param rwName Name for the reader/writer
   //! \param vrfObject The VR-Forces object to associate with
   //! \param parentRegistry Optional parent registry
   //! \return Pointer to the new repository
   static DtVrfProcessStateRepository* creator(
      const DtString& rwName, DtLocalObject* vrfObject, DtReaderWriterRegistry* parentRegistry);
 
protected:
   DtRwBoolean
      myUseHiFiCollisionsInStationaryCgfState; //!< Flag for using high-fidelity collisions in stationary CGF state
};
} // namespace makVre