vortexArtPartDescriptor.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vortexArtPartDescriptor.h
//! \brief Defines DtVortexSimArtPartDescriptor for articulated part simulation in Vortex
//! \ingroup vreVrfVortexObjparam
 
#pragma once
 
#include "vreVrfVortexObjparam/export.h"
#include <vrfobjparam/simArtPartDescriptor.h>
#include <readerWriter/rwString.h>
 
namespace makVre
{
//! \brief Type identifier string for the DtVortexSimArtPartDescriptor class
const char DtVortexSimArtPartDescriptorType[] = "DtVortexSimArtPartDescriptor";
 
//! \brief Articulated part descriptor for Vortex physics simulation
//!
//! DtVortexSimArtPartDescriptor extends the base simulation articulated part descriptor
//! with Vortex-specific naming information. This allows articulated parts to be correctly
//! mapped to their corresponding parts in the Vortex physics simulation.
class VREVRFVORTEXOBJPARAM_DLL DtVortexSimArtPartDescriptor : public DtSimArtPartDescriptor
{
public:
   //! \brief Default constructor
   //!
   //! Creates an empty descriptor with default values
   DtVortexSimArtPartDescriptor();
 
   //! \brief Constructor with part name and registry
   //! \param partName Name of the articulated part
   //! \param parentRegistry Optional parent registry for reader/writer operations
   DtVortexSimArtPartDescriptor(const DtString& partName, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Constructor with symbol part name and registry
   //! \param partName Symbol string name of the articulated part
   //! \param parentRegistry Optional parent registry for reader/writer operations
   DtVortexSimArtPartDescriptor(const DtSymbolString& partName, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Copy constructor with new part name
   //! \param partName New name for the copied articulated part
   //! \param orig Original descriptor to copy from
   //! \param parentRegistry Optional parent registry for reader/writer operations
   DtVortexSimArtPartDescriptor(const DtString& partName, const DtVortexSimArtPartDescriptor& orig,
      DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Copy constructor with new symbol part name
   //! \param partName New symbol string name for the copied articulated part
   //! \param orig Original descriptor to copy from
   //! \param parentRegistry Optional parent registry for reader/writer operations
   DtVortexSimArtPartDescriptor(const DtSymbolString& partName, const DtVortexSimArtPartDescriptor& orig,
      DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Assignment operator
   //! \param orig Original descriptor to copy from
   //! \return Reference to this descriptor after assignment
   DtVortexSimArtPartDescriptor& operator=(const DtVortexSimArtPartDescriptor& orig);
 
   //! \brief Virtual destructor
   virtual ~DtVortexSimArtPartDescriptor() override;
 
   //! \brief Creates a clone of this descriptor with a new part name
   //! \param partName New name for the cloned articulated part
   //! \param parentRegistry Optional parent registry for reader/writer operations
   //! \return Pointer to a new descriptor that is a copy of this one
   virtual DtVortexSimArtPartDescriptor* clone(const DtString& partName,
      DtReaderWriterRegistry* parentRegistry = NULL) const override;
 
   //! \brief Creates a clone of this descriptor with a new symbol part name
   //! \param partName New symbol string name for the cloned articulated part
   //! \param parentRegistry Optional parent registry for reader/writer operations
   //! \return Pointer to a new descriptor that is a copy of this one
   virtual DtVortexSimArtPartDescriptor* clone(const DtSymbolString& partName,
      DtReaderWriterRegistry* parentRegistry = NULL) const override;
 
 
   //! \brief Sets the Vortex-specific part name
   //! \param partType The part name used within the Vortex physics simulation
   virtual void setVortexPartName(const std::string& partType);
 
   //! \brief Gets the Vortex-specific part name
   //! \return The part name used within the Vortex physics simulation
   virtual std::string vortexPartName() const;
 
   //! \brief Gets the type identifier for reader/writer operations
   //! \return Type identifier string
   virtual const char* readerWriterType() const override;
 
   //! \brief Gets the XML type identifier for serialization
   //! \return XML type identifier string used when archiving to an XML stream
   static const char* theXmlType();
 
   //! \brief Gets the XML type identifier for this instance
   //! \return XML type identifier string
   virtual const char* xmlType() const override { return theXmlType(); }
 
protected:
   //! \brief The Vortex-specific part name used in the physics simulation
   DtRwString myVortexPartName;
};
} // namespace makVre