cigiEntityPublisherBase.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2024 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
#pragma once
 
//! @file cigiEntityPublisherBase.h
//!
//! @brief Base class for Publishers creating CIGI entities.
//!
//!   Automatically acquires a CIGI EntityID from the Session.
//!
//!   Instantiates an EntityUnpublisher when destroyed to handle clean removal
//!   of the entity from the IG.
//!
//!   Uses CIGI type CigiBaseEntityCtrl.
//!
//!   Note that a CIGI Entity is not directly analogous to a VR-Forces Entity.
 
#include "vreCigiHost/export.h"
#include "vreCigiHost/cigiPublisherTemplate.h"
 
#include <CigiBaseEntityCtrl.h>
 
namespace makVre
{
 
class CIGIHOST_DLL DtCigiEntityPublisherBase
   : public DtCigiPublisherTemplate<CigiBaseEntityCtrl, DtCigiEntityPublisherBase>
{
public:
   DtCigiEntityPublisherBase() {}
   virtual ~DtCigiEntityPublisherBase() override;
 
   virtual Cigi_uint16 cigiId() const;
 
   virtual bool init() override;
 
protected:
   virtual void initCigi() override;
 
   virtual void tickChildren(double dt) override;
   virtual void publishChildren(CigiOutgoingMsg& out) override;
 
   //! @brief Invoked from destructor. Should create DtCigiEntityUnpublisher
   //! to handle publishing of entity removal flag and cleanup upon receipt.
   virtual void unpublish();
};
 
} // namespace makVre