cigiTimePublisher.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
#pragma once
 
//! \file cigiTimePublisher.h
//! \brief Declares DtCigiTimePublisher, a CIGI host publisher for simulation time-of-day.
 
// Delcare new CigiPublisher class for sending simulation date and time using the
// DtCigiPubliher template.
//
// This is an unversioned base Publisher class, from which a CIGI version (4)
// type will be derived. Currently only CIGI version 4 is supported by the
// vreCigiHost, but this design allows for future support of other CIGI versions.
//
// The DtCigiPublisherTemplate is used to composes a CigiPublisherBase-derived
// class, given a CIGI packet type, the new Publisher class name, and the parent
// CigiPublisher type that the new Publisher should be derived from. In this case
// DtCigiTimePublisher will derive directly from the DtCigiPublisherBase class,
// and use a base CIGI packet type of CigiBaseEnvCtrl.
//
// The CIGI packet type used by the unversioned base Publisher class should
// be a superclass for the CIGI packet class used by the versioned Publishers
// that will be derived from this Publisher class.
 
#include "vreCigiHost/cigiPublisherTemplate.h"
 
#include <CigiBaseEnvCtrl.h>
 
namespace makVre
{
class DtCigiSession;
 
//! \brief Unversioned CIGI time publisher used by the CIGI host extension example.
//!
//! This class demonstrates how to derive a publisher from DtCigiPublisherTemplate
//! using the version-agnostic CigiBaseEnvCtrl packet type. It reads simulation time
//! from the VR-Forces environmental state manager and drives celestial control
//! packets for connected image generators.
class DtCigiTimePublisher : public DtCigiPublisherTemplate<CigiBaseEnvCtrl, DtCigiTimePublisher, DtCigiPublisherBase>
{
public:
   //! \brief Instantiates a new time publisher and adds it to a CIGI session.
   //!
   //! This helper is registered as a session-start callback by the example
   //! plugin so that each new CIGI session automatically gets a time-of-day
   //! publisher attached under the root publisher in the publisher tree.
   static void addToSession(DtCigiSession& session);
 
public:
   DtCigiTimePublisher()
      : mySimTime(0.0)
      , myTimeTolerance(1.0)
   {
   }
   virtual ~DtCigiTimePublisher() {}
 
   //! \brief Initializes the publisher and validates required VR-Forces services.
   //!
   //! This override checks that the CGF physical world and environmental state
   //! manager are available, reads the optional timeDeviationTolerance value
   //! from the session configuration, and then delegates to the base publisher
   //! initialization.
   //!
   //! \return true if initialization succeeds and the publisher remains enabled.
   bool init() override;
 
   //! \brief Advances internal simulation time tracking and schedules updates.
   //!
   //! This method accumulates expected simulation time using the frame delta,
   //! compares it against the authoritative time from the environmental state
   //! manager, and marks the publisher dirty when the deviation exceeds the
   //! configured tolerance before calling the base tick implementation.
   //!
   //! \param dt Delta time in seconds since the last tick.
   void tick(double dt) override;
 
protected:
   //! \brief Initializes constant CIGI packet fields that do not change over time.
   //!
   //! Called once by the base publisher; sets up celestial body enable flags,
   //! star intensity, and marks the date/time fields as valid.
   void initCigi() override;
 
   //! \brief Updates dynamic CIGI date/time and ephemeris fields before sending.
   //!
   //! When the publisher is dirty, this method updates the CIGI packet with
   //! the current simulation UTC date and time and controls whether the image
   //! generator advances time based on the simulation play/pause state.
   void updateCigi() override;
 
protected:
   //! \brief Locally tracked simulation time in seconds based on accumulated dt.
   double mySimTime;
 
   //! \brief Maximum allowed deviation between tracked and actual sim time (seconds).
   double myTimeTolerance;
};
 
} // namespace makVre