vreVrfEmbarkationPSR.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreVrfEmbarkationPSR.h
//! \ingroup vreVrfobjcore
//! \brief Embarkation process state repository for VREngage
//!
//! This file defines the DtVreVrfEmbarkationPSR class, which extends the basic embarkation PSR
//! to provide VREngage-specific functionality for entity embarkation. It adds support for
//! tracking slot points and other embarkation-related state data.
 
#pragma once
 
#include "vreVrfobjcore/export.h"
 
#include <vrfobjcore/vrfEmbarkationPSR.h>
 
namespace makVre
{
//! \brief Type identifier string for the VREngage embarkation PSR
const char DtVreVrfEmbarkationPSRType[] = "vre-vrf-embarkation-psr";
 
//! \brief Extended embarkation process state repository for VREngage
//!
//! This class extends the basic embarkation PSR to provide VREngage-specific
//! functionality for entity embarkation operations. It adds support for tracking
//! slot points and other embarkation-related state data, which is used to position
//! entities during embarkation and to animate embarkation sequences.
class VREVRFOBJCORE_DLL DtVreVrfEmbarkationPSR : public DtVrfEmbarkationPSR
{
public:
   //! \brief Constructor with VRF object and optional name
   //! \param vrfObject Pointer to the local object this PSR is associated with
   //! \param rwName Optional reader/writer name
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //!
   //! Creates a new embarkation PSR for the specified VRF object.
   DtVreVrfEmbarkationPSR(DtLocalObject* vrfObject, const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Copy constructor
   //! \param orig The source PSR to copy from
   //! \param rwName Optional reader/writer name
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //!
   //! Creates a new embarkation PSR as a copy of the provided original.
   DtVreVrfEmbarkationPSR(const DtVreVrfEmbarkationPSR& orig, const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the PSR.
   virtual ~DtVreVrfEmbarkationPSR() override;
 
   //! \brief Assignment operator
   //! \param orig The source PSR to copy from
   //! \return Reference to this PSR after assignment
   //!
   //! Assigns the contents of the provided PSR to this one.
   DtVreVrfEmbarkationPSR& operator=(const DtVreVrfEmbarkationPSR& orig);
 
   //! \brief Creates a clone of this PSR
   //! \param rwName Optional reader/writer name for the clone
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //! \return Pointer to a new PSR that is a clone of this one
   //!
   //! Creates a new embarkation PSR as a deep copy of this one.
   virtual DtVrfProcessStateRepository* clone(
      const DtString& rwName = DtString::nullString(), DtReaderWriterRegistry* parentRegistry = 0) const override;
 
   //! \brief Gets the type identifier for this PSR
   //! \return String identifying this PSR type
   //!
   //! Returns a unique type identifier string for this PSR type.
   //! Will return DtVreVrfEmbarkationPSRType.
   virtual DtString type() const override;
 
   //! \brief Gets the slot point for embarkation
   //! \return Const reference to the slot point vector
   //!
   //! Returns the slot point where an entity should be positioned during
   //! embarkation. This is the point in local coordinates where the embarking
   //! entity should initially be placed.
   virtual const DtRwVector& slotPoint() const;
 
   //! \brief Sets the slot point for embarkation
   //! \param slotPoint The new slot point vector
   //!
   //! Sets the slot point where an entity should be positioned during
   //! embarkation. This is the point in local coordinates where the embarking
   //! entity should initially be placed.
   virtual void setSlotPoint(const DtRwVector& slotPoint);
 
   //! \brief Factory function to create a new instance of this PSR
   //! \param rwName The reader/writer name for the new instance
   //! \param vrfObject Pointer to the local object this PSR will be associated with
   //! \param parentRegistry Parent registry for reader/writer functionality
   //! \return Pointer to a newly created PSR instance
   //!
   //! Static factory function used by the PSR creation system to instantiate
   //! new instances of this PSR type.
   static DtVrfProcessStateRepository* creator(
      const DtString& rwName, DtLocalObject* vrfObject, DtReaderWriterRegistry* parentRegistry);
 
protected:
   //! \brief Slot point for embarkation
   //!
   //! Stores the slot point where an entity should be positioned during
   //! embarkation. This is the point in local coordinates where the embarking
   //! entity should initially be placed.
   DtRwVector mySlotPoint;
};
 
} // namespace makVre