cigiFxEntityPublisher.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2024 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
#pragma once
 
//! @file cigiFxEntityPublisher.h
//!
//! @brief Publisher for transient special effects, i.e. particle effects, for
//! fire and detonation events.
//!
//!   FxEntityPublishers are intended to be created through ues of the static
//!   publishFireEffect and publishDetonationEffect functions. Internally these
//!   functions maintain a pool of FxEntityPublisher isntances which are reused
//!   to avoid the performance cost of continuous creation and deletion of
//!   FxEntity instnces.
 
#include "vreCigiHost/export.h"
#include "vreCigiHost/cigiEntityPublisherBase.h"
 
#include <vrfMsgTransport/detonationEvent.h>
 
#include <CigiBaseEntityPositionCtrl.h>
#include <CigiBaseRateCtrl.h>
 
namespace makVre
{
 
class CIGIHOST_DLL DtCigiFxPositionPublisher
   : public DtCigiPublisherTemplate<CigiBaseEntityPositionCtrl, DtCigiFxPositionPublisher>
{
public:
   DtCigiFxPositionPublisher() {}
   virtual ~DtCigiFxPositionPublisher() override {}
};
 
class CIGIHOST_DLL DtCigiFxVelocityPublisher
   : public DtCigiPublisherTemplate<CigiBaseRateCtrl, DtCigiFxVelocityPublisher>
{
public:
   DtCigiFxVelocityPublisher() {}
   virtual ~DtCigiFxVelocityPublisher() override {}
};
 
class CIGIHOST_DLL DtCigiFxPublisher
   : public DtCigiPublisherTemplate<CigiBaseEntityCtrl, DtCigiFxPublisher, DtCigiEntityPublisherBase>
{
public:
   static void publishFireEffect(DtCigiPublisherBase::Sptr parent, const makVrfEvents::DtFireEvent& event);
   static void publishDetonationEffect(DtCigiPublisherBase::Sptr parent, const makVrfEvents::DtDetonationEvent& event);
 
public:
   DtCigiFxPublisher();
   virtual ~DtCigiFxPublisher() override {}
 
   virtual Sptr setLifetime(double lifetime);
   virtual double lifetime() const;
 
   virtual Sptr show(const DtVector& location, const DtVector& velocity);
 
   virtual bool active() const;
 
   virtual void tick(double dt) override;
 
   virtual void receiptConfirmed() override;
 
protected:
   virtual void initCigi() override;
 
   virtual void setActive(bool live);
 
   static Sptr getAvailablePublisher(DtCigiPublisherBase::Sptr parent, Cigi_uint16& type, bool& created);
 
   virtual void createChildren() override;
   virtual void tickChildren(double dt) override;
   virtual void publishChildren(CigiOutgoingMsg& out) override;
 
   virtual void unpublish() override;
 
protected:
   std::shared_ptr<DtCigiFxPositionPublisher> myPositionPublisher;
   std::shared_ptr<DtCigiFxVelocityPublisher> myVelocityPublisher;
 
   double myLifetime;
   double myTimeLeft;
};
 
} // namespace makVre