vortexArtPartDescriptorList.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vortexArtPartDescriptorList.h
//! \brief Defines DtVortexSimArtPartDescriptorList for managing collections of Vortex articulated part descriptors
//! \ingroup vreVrfVortexObjparam
 
#pragma once
 
#include "vreVrfVortexObjparam/export.h"
#include <vrfobjparam/simArtPartDescriptorList.h>
 
namespace makVre
{
//! \brief Type identifier string for the DtVortexSimArtPartDescriptorList class
const char DtVortexSimArtPartDescriptorListType[] = "DtVortexSimArtPartDescriptorList";
 
//! \brief Collection of articulated part descriptors for Vortex physics simulation
//!
//! DtVortexSimArtPartDescriptorList manages a collection of DtVortexSimArtPartDescriptor objects,
//! providing methods for adding, removing, and accessing Vortex-specific articulated part descriptors.
//! This class extends the base simulation articulated part descriptor list with Vortex-specific
//! serialization and cloning functionality.
class VREVRFVORTEXOBJPARAM_DLL DtVortexSimArtPartDescriptorList : public DtSimArtPartDescriptorList
{
public:
   //! \brief Default constructor
   //!
   //! Creates an empty descriptor list with default values
   DtVortexSimArtPartDescriptorList();
 
   //! \brief Constructor with list name and registry
   //! \param name Name of the descriptor list
   //! \param parentRegistry Optional parent registry for reader/writer operations
   DtVortexSimArtPartDescriptorList(const DtString& name, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Constructor with symbol list name and registry
   //! \param name Symbol string name of the descriptor list
   //! \param parentRegistry Optional parent registry for reader/writer operations
   DtVortexSimArtPartDescriptorList(const DtSymbolString& name, DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Copy constructor with new list name
   //! \param name New name for the copied descriptor list
   //! \param orig Original descriptor list to copy from
   //! \param parentRegistry Optional parent registry for reader/writer operations
   DtVortexSimArtPartDescriptorList(const DtString& name, const DtVortexSimArtPartDescriptorList& orig,
      DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Copy constructor with new symbol list name
   //! \param name New symbol string name for the copied descriptor list
   //! \param orig Original descriptor list to copy from
   //! \param parentRegistry Optional parent registry for reader/writer operations
   DtVortexSimArtPartDescriptorList(const DtSymbolString& name, const DtVortexSimArtPartDescriptorList& orig,
      DtReaderWriterRegistry* parentRegistry = NULL);
 
   //! \brief Assignment operator
   //! \param orig Original descriptor list to copy from
   //! \return Reference to this descriptor list after assignment
   //!
   //! Removes and deletes all entries in the target list, then clones all entries
   //! from the source list and adds them to the target list.
   DtVortexSimArtPartDescriptorList& operator=(const DtVortexSimArtPartDescriptorList& orig);
 
   //! \brief Virtual destructor
   virtual ~DtVortexSimArtPartDescriptorList() override;
 
   //! \brief Creates a clone of this descriptor list with a new name
   //! \param name New name for the cloned descriptor list
   //! \param parentRegistry Optional parent registry for reader/writer operations
   //! \return Pointer to a new descriptor list that is a copy of this one
   virtual DtVortexSimArtPartDescriptorList* clone(const DtString& name,
      DtReaderWriterRegistry* parentRegistry = NULL) override;
 
   //! \brief Creates a clone of this descriptor list with a new symbol name
   //! \param name New symbol string name for the cloned descriptor list
   //! \param parentRegistry Optional parent registry for reader/writer operations
   //! \return Pointer to a new descriptor list that is a copy of this one
   virtual DtVortexSimArtPartDescriptorList* clone(const DtSymbolString& name,
      DtReaderWriterRegistry* parentRegistry = NULL) override;
 
   //! \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 Deserializes a DtVortexSimArtPartDescriptor from an MTL stream
   //! \param args Arguments for deserialization
   //! \param searchPaths Search paths for resolving references
   //! \param variableBindings Variable bindings for resolving references
   //! \return Deserialized object pointer
   //!
   //! Constructs a DtVortexSimArtPartDescriptor, retrieves it from the MTL stream,
   //! and then adds it to the list.
   virtual DtlObjPtr getData(DtlObjPtr args,
      const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings) override;
};
 
} // namespace makVre