commentLogic.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2024 MAK Technologies
** All rights reserved.
******************************************************************************/
 
#pragma once
 
#include "vrePlayerStation/playerComponent.h"
#include "vreMessageManager/vreMessageManager.h"
 
//! String identifier used to register the comment logic component with the
//! player station component factory.
constexpr auto DtCommentLogicType = "DtCommentLogic";
 
namespace makVre
{
class DtMenu;
class DtMenuElement;
 
//! Component that manages displaying incoming comment messages in the
//! player station action menu.
//!
//! DtCommentLogic subscribes to internal CommentMessage traffic and menu
//! action messages. For each received network comment targeted at the
//! local entity, it creates an entry in a dedicated "Comment" menu and
//! drives the menu state so the user can view and dismiss comments.
class DtCommentLogic : public DtPlayerComponent
{
public:
   //! Constructs a new comment logic component with no menu attached yet.
   DtCommentLogic();
 
   //! Virtual destructor to allow safe subclassing.
   virtual ~DtCommentLogic() override;
 
   //! Returns the component type string used during factory registration.
   virtual const char* type() const override;
 
   //! Initializes the component, registers message handlers, and creates
   //! the comment menu if a menu manager is available from the attribute store.
   virtual bool initialize(DtPlayerStation* player, DtInitTable& config) override;
 
   //! Per-frame update hook. This example does not require per-tick work
   //! but keeps the standard component interface.
   virtual void tick(double dt) override;
 
   //! Cleans up message handlers and releases any menu resources on shutdown.
   virtual void shutdown() override;
 
   //! Handles menu action messages generated when the user interacts with
   //! the comment menu (for example, closing a displayed comment).
   virtual DtVreMessageResult handleMenuMessage(makVre::DtVreMessage* msg);
 
   //! Handles internal CommentMessage instances produced by the network
   //! connector and adds corresponding entries to the comment menu.
   virtual DtVreMessageResult handleCommentMessage(makVre::DtVreMessage* msg);
 
protected:
   //! Menu used to present received comments to the player.
   DtMenu* myMenu;
};
 
} // namespace makVre