vreDiGuyIntrinsicAnimationMap.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreDiGuyIntrinsicAnimationMap.h
//! \ingroup vreVrfobjcore
//! \brief Enhanced DiGuy intrinsic animation mapping for VREngage
//!
//! This file defines the DtVreDiGuyIntrinsicAnimationMap class, which extends
//! the base DiGuy animation map to provide improved animation selection logic,
//! particularly for locomotion animations.
 
#pragma once
#include "vreVrfobjcore/export.h"
#include <vrfDiGuy/diGuyIntrinsicAnimationMap.h>
 
namespace makVre
{
//! \brief Enhanced DiGuy intrinsic animation mapping for VREngage
//!
//! This class extends the DtDiGuyIntrinsicAnimationMap to prefer locomotion
//! animations when selecting the best possible match for a given speed, posture,
//! and demeanor set. It provides improved animation selection logic that results
//! in more consistent character animations, particularly during movement.
class VREVRFOBJCORE_DLL DtVreDiGuyIntrinsicAnimationMap : public DtDiGuyIntrinsicAnimationMap
{
public:
   //! \brief Default constructor
   //!
   //! Creates a new animation map with default settings.
   DtVreDiGuyIntrinsicAnimationMap();
 
   //! \brief Constructor with filename
   //! \param name The filename of the animation data to load
   //!
   //! Creates a new animation map and loads animation data from the specified file.
   DtVreDiGuyIntrinsicAnimationMap(const DtFilename& name);
 
   //! \brief Copy constructor
   //! \param orig The source animation map to copy from
   //!
   //! Creates a new animation map as a copy of the provided original map.
   DtVreDiGuyIntrinsicAnimationMap(const DtVreDiGuyIntrinsicAnimationMap& orig);
 
   //! \brief Assignment operator
   //! \param orig The source animation map to copy from
   //! \return Reference to this animation map after assignment
   //!
   //! Assigns the contents of the provided animation map to this map.
   DtVreDiGuyIntrinsicAnimationMap& operator=(const DtVreDiGuyIntrinsicAnimationMap& orig);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the animation map.
   virtual ~DtVreDiGuyIntrinsicAnimationMap() override;
 
   //! \brief Commented-out override for animation selection logic
   //!
   //! This section contains commented-out code that would implement simpler logic
   //! for matching animations with more consistent matching of posture and less
   //! emphasis on animation variants. This would address the issue tracked in
   //! https://jira.mak.com/browse/VRE-3283.
   //!
   //! \note This implementation is not currently active because the fix was deemed
   //! not important enough to risk potential unknown issues from changing the base
   //! VRF behavior. The code is kept for reference and possible future implementation.
   //
   // const DtDiGuyAnimation * findClosestAnimation(DtLifeformStaticPosture posture,
   //   const DtString & demeanor, double speed) const override;
   //
   // virtual double findAnimationSpeedScore(double targetSpeed, DtDiGuyAnimationSharedPtr animation) const;
 
   //! \brief Creates a new instance of the enhanced animation map
   //! \return Pointer to a newly created DtDiGuyIntrinsicAnimationMap instance
   //!
   //! Factory method that creates and returns a new DtVreDiGuyIntrinsicAnimationMap instance.
   //! This method provides a way to create the VREngage-specific animation map through
   //! the base class interface.
   //!
   //! \note The caller is responsible for deleting the returned object when finished with it.
   static DtDiGuyIntrinsicAnimationMap* create();
};
} // namespace makVre