#include <cigiFxEntityPublisher.h>

Inheritance diagram for makVre::DtCigiFxPublisher:

Public Member Functions
	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

Public Member Functions inherited from makVre::DtCigiPublisherTemplate< CigiBaseEntityCtrl, DtCigiFxPublisher, DtCigiEntityPublisherBase >
	DtCigiPublisherTemplate ()

virtual	~DtCigiPublisherTemplate () override

CigiData *	cigi ()

CigiData *const	cigi () const

CigiData *	shared ()

CigiData *const	shared () const

Public Member Functions inherited from makVre::DtSpSubClass< DtCigiFxPublisher, DtCigiEntityPublisherBase >
	DtSpSubClass ()

virtual	~DtSpSubClass ()

Sptr	self ()

std::string	type () const override

Public Member Functions inherited from makVre::DtCigiEntityPublisherBase
	DtCigiEntityPublisherBase ()

virtual	~DtCigiEntityPublisherBase () override

virtual Cigi_uint16	cigiId () const

virtual bool	init () override

Public Member Functions inherited from makVre::DtCigiPublisherTemplate< CigiBaseEntityCtrl, DtCigiEntityPublisherBase >
	DtCigiPublisherTemplate ()

CigiData *	cigi ()

CigiData *const	cigi () const

CigiData *	shared ()

CigiData *const	shared () const

Public Member Functions inherited from makVre::DtSpSubClass< DtCigiEntityPublisherBase, DtCigiPublisherBase >
	DtSpSubClass ()

Sptr	self ()

Public Member Functions inherited from makVre::DtCigiPublisherBase
	DtCigiPublisherBase ()

virtual	~DtCigiPublisherBase () override

DtCigiDataBase *	shared ()

DtCigiDataBase *const	shared () const

virtual void	setEnabled (bool enabled)

virtual bool	enabled () const

template<class CHILD_T>
std::shared_ptr< CHILD_T >	addNewChild (const std::string &name="")

virtual bool	addChild (Sptr child) override

virtual void	publish (CigiOutgoingMsg &out)

virtual void	setNeedsReceiptConfirmation (bool needs)

virtual bool	needsReceiptConfirmation () const

virtual double	lastSent ()

virtual void	markDirty (bool childrenToo=false)

virtual void	markClean (bool childrenToo=false)

Public Member Functions inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase > >
	DtSpSubClass ()

Sptr	self ()

std::string	type () const override

Public Member Functions inherited from makVre::DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase >
	DtTreeClass ()

virtual	~DtTreeClass () override

virtual void	setOwnsChildren (bool owns)

virtual bool	ownsChildren ()

virtual bool	removeChild (Sptr child)

virtual void	removeAllChildren ()

virtual bool	forEachChild (ForChildFn fn)

virtual Sptr	findChild (FindChildFn fn)

virtual Sptr	findChild (const std::string &name)

virtual bool	isChild (Sptr child)

virtual unsigned int	numChildren ()

virtual bool	hasChildren ()

virtual Sptr	parent ()

Public Member Functions inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtCigiObjectBase >
	DtSpSubClass ()

Sptr	self ()

Public Member Functions inherited from makVre::DtCigiObjectBase
	DtCigiObjectBase ()

virtual	~DtCigiObjectBase () override

CigiData *	cigi ()

CigiData *const	cigi () const

virtual Cigi_uint16	cigiType ()

virtual Sptr	setSession (DtCigiSession &session)

virtual DtCigiSession &	session () const

virtual unsigned int	sessionVersion () const

virtual void	markDirty ()

virtual void	markClean ()

virtual bool	isDirty () const

Public Member Functions inherited from makVre::DtSpSubClass< DtCigiObjectBase >
	DtSpSubClass ()

Sptr	self ()

Public Member Functions inherited from makVre::DtSpObject
	DtSpObject ()

virtual	~DtSpObject ()

Sptr	self ()

virtual void	setName (const std::string &name)

virtual std::string	name () const

Static Public Member Functions
static void	publishFireEffect (DtCigiPublisherBase::Sptr parent, const makVrfEvents::DtFireEvent &event)

static void	publishDetonationEffect (DtCigiPublisherBase::Sptr parent, const makVrfEvents::DtDetonationEvent &event)

Static Public Member Functions inherited from makVre::DtSpSubClass< DtCigiFxPublisher, DtCigiEntityPublisherBase >
static std::string	Type ()

static std::shared_ptr< DtCigiFxPublisher >	create ()

static void	registerCreator ()

static std::shared_ptr< DtCigiFxPublisher >	createVersion (unsigned int version)

static void	registerCreatorVersion (unsigned int version)

Static Public Member Functions inherited from makVre::DtSpSubClass< DtCigiEntityPublisherBase, DtCigiPublisherBase >
static std::string	Type ()

static std::shared_ptr< DtCigiEntityPublisherBase >	create ()

static void	registerCreator ()

static std::shared_ptr< DtCigiEntityPublisherBase >	createVersion (unsigned int version)

static void	registerCreatorVersion (unsigned int version)

Static Public Member Functions inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase > >
static std::string	Type ()

static std::shared_ptr< DtCigiPublisherBase >	create ()

static void	registerCreator ()

static std::shared_ptr< DtCigiPublisherBase >	createVersion (unsigned int version)

static void	registerCreatorVersion (unsigned int version)

Static Public Member Functions inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtCigiObjectBase >
static std::string	Type ()

static std::shared_ptr< DtCigiPublisherBase >	create ()

static void	registerCreator ()

static std::shared_ptr< DtCigiPublisherBase >	createVersion (unsigned int version)

static void	registerCreatorVersion (unsigned int version)

Static Public Member Functions inherited from makVre::DtSpSubClass< DtCigiObjectBase >
static std::string	Type ()

static std::shared_ptr< DtCigiObjectBase >	create ()

static void	registerCreator ()

static std::shared_ptr< DtCigiObjectBase >	createVersion (unsigned int version)

static void	registerCreatorVersion (unsigned int version)

Static Public Member Functions inherited from makVre::DtSpObject
template<class AS_T>
static std::shared_ptr< AS_T >	cast (Sptr p)

template<class AS_T>
static std::shared_ptr< AS_T >	unsafe_cast (Sptr p)

Protected Member Functions
virtual void	initCigi () override

virtual void	setActive (bool live)

virtual void	createChildren () override

virtual void	tickChildren (double dt) override

virtual void	publishChildren (CigiOutgoingMsg &out) override

virtual void	unpublish () override

Protected Member Functions inherited from makVre::DtCigiPublisherTemplate< CigiBaseEntityCtrl, DtCigiFxPublisher, DtCigiEntityPublisherBase >
DtCigiDataBase *	createCigi () override

bool	verifySharedType () override

Protected Member Functions inherited from makVre::DtCigiPublisherBase
virtual std::string	sharedKey ()

virtual void	setupShared ()

virtual void	initShared ()

virtual void	updateShared ()

virtual void	updateCigi ()

virtual void	write (CigiOutgoingMsg &out)

Protected Member Functions inherited from makVre::DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase >
virtual void	setParent (Sptr parent)

virtual void	pruneChildren ()

Protected Member Functions inherited from makVre::DtCigiObjectBase
DtCigiDataBase *	cigiBase ()

DtCigiDataBase *const	cigiBase () const

template<typename VALUE_T>
bool	updateValue (VALUE_T *value, VALUE_T source)

Static Protected Member Functions
static Sptr	getAvailablePublisher (DtCigiPublisherBase::Sptr parent, Cigi_uint16 &type, bool &created)

Static Protected Member Functions inherited from makVre::DtSpSubClass< DtCigiFxPublisher, DtCigiEntityPublisherBase >
static std::shared_ptr< DtBaseCreator< DtCigiFxPublisher > > &	creator ()

static std::shared_ptr< DtBaseCreator< DtCigiFxPublisher > > &	creatorVersion (unsigned int version)

Static Protected Member Functions inherited from makVre::DtSpSubClass< DtCigiEntityPublisherBase, DtCigiPublisherBase >
static std::shared_ptr< DtBaseCreator< DtCigiEntityPublisherBase > > &	creator ()

static std::shared_ptr< DtBaseCreator< DtCigiEntityPublisherBase > > &	creatorVersion (unsigned int version)

Static Protected Member Functions inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase > >
static std::shared_ptr< DtBaseCreator< DtCigiPublisherBase > > &	creator ()

static std::shared_ptr< DtBaseCreator< DtCigiPublisherBase > > &	creatorVersion (unsigned int version)

Static Protected Member Functions inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtCigiObjectBase >
static std::shared_ptr< DtBaseCreator< DtCigiPublisherBase > > &	creator ()

static std::shared_ptr< DtBaseCreator< DtCigiPublisherBase > > &	creatorVersion (unsigned int version)

Static Protected Member Functions inherited from makVre::DtSpSubClass< DtCigiObjectBase >
static std::shared_ptr< DtBaseCreator< DtCigiObjectBase > > &	creator ()

static std::shared_ptr< DtBaseCreator< DtCigiObjectBase > > &	creatorVersion (unsigned int version)

Protected Attributes
std::shared_ptr< DtCigiFxPositionPublisher >	myPositionPublisher

std::shared_ptr< DtCigiFxVelocityPublisher >	myVelocityPublisher

double	myLifetime

double	myTimeLeft

Protected Attributes inherited from makVre::DtCigiPublisherBase
CigiBasePtr	mySharedData

bool	myEnabled

bool	myNeedsConfirmation

double	myLastSentToIg

Protected Attributes inherited from makVre::DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase >
OwnedChildList	myOwnedChildren

UnownedChildList	myUnownedChildren

ChildNameMap	myChildrenByName

bool	myOwnsChildren

Wptr	myParent

Protected Attributes inherited from makVre::DtCigiObjectBase
CigiBasePtr	myCigiData

DtCigiSession *	mySession

bool	myDirty

Protected Attributes inherited from makVre::DtSpObject
std::string	myName

Additional Inherited Members
Public Types inherited from makVre::DtCigiPublisherTemplate< CigiBaseEntityCtrl, DtCigiFxPublisher, DtCigiEntityPublisherBase >
using	Cigi

using	CigiData

Public Types inherited from makVre::DtSpSubClass< DtCigiFxPublisher, DtCigiEntityPublisherBase >
using	Super

using	Ptr

using	Sptr

using	Wptr

Public Types inherited from makVre::DtCigiPublisherTemplate< CigiBaseEntityCtrl, DtCigiEntityPublisherBase >
using	Cigi

using	CigiData

Public Types inherited from makVre::DtSpSubClass< DtCigiEntityPublisherBase, DtCigiPublisherBase >
using	Super

using	Ptr

using	Sptr

using	Wptr

Public Types inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase > >
using	Super

using	Ptr

using	Sptr

using	Wptr

Public Types inherited from makVre::DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase >
using	Sptr

using	ForChildFn

using	FindChildFn

Public Types inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtCigiObjectBase >
using	Super

using	Ptr

using	Sptr

using	Wptr

Public Types inherited from makVre::DtCigiObjectBase
using	Cigi = CigiBasePacket

using	CigiData = DtCigiDataTemplate<CigiBasePacket, DtCigiObjectBase>

using	CigiBasePtr = std::shared_ptr<DtCigiDataBase>

Public Types inherited from makVre::DtSpSubClass< DtCigiObjectBase >
using	Super

using	Ptr

using	Sptr

using	Wptr

Public Types inherited from makVre::DtSpObject
using	Ptr = DtSpObject*

using	Sptr = std::shared_ptr<DtSpObject>

using	Wptr = std::weak_ptr<DtSpObject>

Protected Types inherited from makVre::DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase >
using	Wptr

using	OwnedChildList

using	UnownedChildList

using	ChildNameMap

Constructor & Destructor Documentation

◆ DtCigiFxPublisher()

makVre::DtCigiFxPublisher::DtCigiFxPublisher ( )

◆ ~DtCigiFxPublisher()

virtual makVre::DtCigiFxPublisher::~DtCigiFxPublisher ( )

inlineoverridevirtual

Member Function Documentation

◆ publishFireEffect()

static void makVre::DtCigiFxPublisher::publishFireEffect	(	DtCigiPublisherBase::Sptr	parent,
		const makVrfEvents::DtFireEvent &	event )

static

References makVre::DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase >::parent().

◆ publishDetonationEffect()

static void makVre::DtCigiFxPublisher::publishDetonationEffect	(	DtCigiPublisherBase::Sptr	parent,
		const makVrfEvents::DtDetonationEvent &	event )

static

References makVre::DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase >::parent().

◆ setLifetime()

virtual Sptr makVre::DtCigiFxPublisher::setLifetime ( double lifetime )

virtual

References lifetime().

◆ lifetime()

virtual double makVre::DtCigiFxPublisher::lifetime ( ) const

virtual

Referenced by setLifetime().

◆ show()

virtual Sptr makVre::DtCigiFxPublisher::show	(	const DtVector &	location,
		const DtVector &	velocity )

virtual

◆ active()

virtual bool makVre::DtCigiFxPublisher::active ( ) const

virtual

◆ tick()

virtual void makVre::DtCigiFxPublisher::tick ( double dt )

overridevirtual

Reimplemented from makVre::DtCigiPublisherBase.

◆ receiptConfirmed()

virtual void makVre::DtCigiFxPublisher::receiptConfirmed ( )

overridevirtual

Called when the IG reports receiving the last frame in which this Pulisher wrote data during publish().

This function is only called if needsReceiptConfirmation() is true.

Reimplemented from makVre::DtCigiPublisherBase.

◆ initCigi()

virtual void makVre::DtCigiFxPublisher::initCigi ( )

overrideprotectedvirtual

Derived Publisher classes should override initCigi() to set initial values in the CIGI data.

Reimplemented from makVre::DtCigiEntityPublisherBase.

Reimplemented in makVre::DtCigiFxPublisherV4.

◆ setActive()

virtual void makVre::DtCigiFxPublisher::setActive ( bool live )

protectedvirtual

◆ getAvailablePublisher()

static Sptr makVre::DtCigiFxPublisher::getAvailablePublisher	(	DtCigiPublisherBase::Sptr	parent,
		Cigi_uint16 &	type,
		bool &	created )

staticprotected

References makVre::DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase >::parent(), and makVre::DtSpSubClass< DtCigiFxPublisher, DtCigiEntityPublisherBase >::type().

◆ createChildren()

virtual void makVre::DtCigiFxPublisher::createChildren ( )

overrideprotectedvirtual

Derived Publisher classes should override createChildre() to create child Publishers, if necessary.

createChildren() is called during init().

Reimplemented from makVre::DtCigiPublisherBase.

◆ tickChildren()

virtual void makVre::DtCigiFxPublisher::tickChildren ( double dt )

overrideprotectedvirtual

Reimplemented from makVre::DtCigiEntityPublisherBase.

◆ publishChildren()

virtual void makVre::DtCigiFxPublisher::publishChildren ( CigiOutgoingMsg & out )

overrideprotectedvirtual

Reimplemented from makVre::DtCigiEntityPublisherBase.

◆ unpublish()

virtual void makVre::DtCigiFxPublisher::unpublish ( )

overrideprotectedvirtual

Invoked from destructor. Should create DtCigiEntityUnpublisher to handle publishing of entity removal flag and cleanup upon receipt.

Reimplemented from makVre::DtCigiEntityPublisherBase.

Member Data Documentation

◆ myPositionPublisher

std::shared_ptr<DtCigiFxPositionPublisher> makVre::DtCigiFxPublisher::myPositionPublisher

protected

◆ myVelocityPublisher

std::shared_ptr<DtCigiFxVelocityPublisher> makVre::DtCigiFxPublisher::myVelocityPublisher

protected

◆ myLifetime

double makVre::DtCigiFxPublisher::myLifetime

protected

◆ myTimeLeft

double makVre::DtCigiFxPublisher::myTimeLeft

protected

The documentation for this class was generated from the following file:

include/vrfExtensions/vreCigiHost/cigiFxEntityPublisher.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ DtCigiFxPublisher()

◆ ~DtCigiFxPublisher()

Member Function Documentation

◆ publishFireEffect()

◆ publishDetonationEffect()

◆ setLifetime()

◆ lifetime()

◆ show()

◆ active()

◆ tick()

◆ receiptConfirmed()

◆ initCigi()

◆ setActive()

◆ getAvailablePublisher()

◆ createChildren()

◆ tickChildren()

◆ publishChildren()

◆ unpublish()

Member Data Documentation

◆ myPositionPublisher

◆ myVelocityPublisher

◆ myLifetime

◆ myTimeLeft