VR-Engage  2.2
Loading...
Searching...
No Matches
makVre::DtCigiViewControlPublisher Class Reference

#include <cigiViewControlPublisher.h>

Inheritance diagram for makVre::DtCigiViewControlPublisher:
[legend]

Public Member Functions

 DtCigiViewControlPublisher ()
 
virtual ~DtCigiViewControlPublisher () override
 
virtual Sptr setDefinition (DtCigiPublisherBase::Sptr)
 
virtual DtCigiPublisherBase::Sptr definition ()
 
virtual void updateFromMessage (VreCigiViewControlMessage *msg)
 
virtual bool init () override
 
virtual void tick (double dt) override
 
virtual DtCigiSimEntityPublisher::Sptr attachedTo ()
 
- Public Member Functions inherited from makVre::DtCigiPublisherTemplate< CigiBaseViewCtrl, DtCigiViewControlPublisher >
 DtCigiPublisherTemplate ()
 
virtual ~DtCigiPublisherTemplate () override
 
CigiDatacigi ()
 
CigiData *const cigi () const
 
CigiDatashared ()
 
CigiData *const shared () const
 
- Public Member Functions inherited from makVre::DtSpSubClass< DtCigiViewControlPublisher, DtCigiPublisherBase >
 DtSpSubClass ()
 
virtual ~DtSpSubClass ()
 
Sptr self ()
 
std::string type () const override
 
- Public Member Functions inherited from makVre::DtCigiPublisherBase
 DtCigiPublisherBase ()
 
virtual ~DtCigiPublisherBase () override
 
DtCigiDataBaseshared ()
 
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 void receiptConfirmed ()
 
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 ()
 
- 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
 
CigiDatacigi ()
 
CigiData *const cigi () const
 
virtual Cigi_uint16 cigiType ()
 
virtual Sptr setSession (DtCigiSession &session)
 
virtual DtCigiSessionsession () 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
 

Protected Types

using ConfigPtr = std::shared_ptr<VreCigiViewControlMessage>
 
using EntityList = std::list<DtCigiSimEntityPublisher::Sptr>
 
- Protected Types inherited from makVre::DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase >
using Wptr
 
using OwnedChildList
 
using UnownedChildList
 
using ChildNameMap
 

Protected Member Functions

virtual void updateCigi () override
 
virtual ConfigPtr config ()
 
virtual void attachTo (DtCigiSimEntityPublisher::Sptr entity)
 
virtual void detach ()
 
virtual void cacheDefinitionConsensus ()
 
virtual void processDetonationEvent (const makVrfEvents::DtEvent &event)
 
virtual void processFireEvent (const makVrfEvents::DtEvent &event)
 
virtual void initCigi () override
 
- Protected Member Functions inherited from makVre::DtCigiPublisherTemplate< CigiBaseViewCtrl, DtCigiViewControlPublisher >
DtCigiDataBasecreateCigi () 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 write (CigiOutgoingMsg &out)
 
virtual void createChildren ()
 
virtual void tickChildren (double dt)
 
virtual void publishChildren (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
DtCigiDataBasecigiBase ()
 
DtCigiDataBase *const cigiBase () const
 
template<typename VALUE_T>
bool updateValue (VALUE_T *value, VALUE_T source)
 

Protected Attributes

DtCigiPublisherBase::Sptr myAssociatedDefinition
 
ConfigPtr myConfigMsg
 
bool myIdsSet
 
DtCigiSimEntityPublisher::Sptr myAttachEntity
 
EntityList myEntitiesInView
 
double myMaxViewDistance
 
double myMaxFireFxDistance
 
- 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
 
DtCigiSessionmySession
 
bool myDirty
 
- Protected Attributes inherited from makVre::DtSpObject
std::string myName
 

Additional Inherited Members

- Public Types inherited from makVre::DtCigiPublisherTemplate< CigiBaseViewCtrl, DtCigiViewControlPublisher >
using Cigi
 
using CigiData
 
- Public Types inherited from makVre::DtSpSubClass< DtCigiViewControlPublisher, 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>
 
- Static Public Member Functions inherited from makVre::DtSpSubClass< DtCigiViewControlPublisher, DtCigiPublisherBase >
static std::string Type ()
 
static std::shared_ptr< DtCigiViewControlPublishercreate ()
 
static void registerCreator ()
 
static std::shared_ptr< DtCigiViewControlPublishercreateVersion (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< DtCigiPublisherBasecreate ()
 
static void registerCreator ()
 
static std::shared_ptr< DtCigiPublisherBasecreateVersion (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< DtCigiPublisherBasecreate ()
 
static void registerCreator ()
 
static std::shared_ptr< DtCigiPublisherBasecreateVersion (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< DtCigiObjectBasecreate ()
 
static void registerCreator ()
 
static std::shared_ptr< DtCigiObjectBasecreateVersion (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)
 
- Static Protected Member Functions inherited from makVre::DtSpSubClass< DtCigiViewControlPublisher, DtCigiPublisherBase >
static std::shared_ptr< DtBaseCreator< DtCigiViewControlPublisher > > & creator ()
 
static std::shared_ptr< DtBaseCreator< DtCigiViewControlPublisher > > & 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)
 

Member Typedef Documentation

◆ ConfigPtr

◆ EntityList

Constructor & Destructor Documentation

◆ DtCigiViewControlPublisher()

makVre::DtCigiViewControlPublisher::DtCigiViewControlPublisher ( )

◆ ~DtCigiViewControlPublisher()

virtual makVre::DtCigiViewControlPublisher::~DtCigiViewControlPublisher ( )
overridevirtual

Member Function Documentation

◆ setDefinition()

virtual Sptr makVre::DtCigiViewControlPublisher::setDefinition ( DtCigiPublisherBase::Sptr )
virtual

◆ definition()

virtual DtCigiPublisherBase::Sptr makVre::DtCigiViewControlPublisher::definition ( )
virtual

◆ updateFromMessage()

virtual void makVre::DtCigiViewControlPublisher::updateFromMessage ( VreCigiViewControlMessage * msg)
virtual

◆ init()

virtual bool makVre::DtCigiViewControlPublisher::init ( )
overridevirtual

Reimplemented from makVre::DtCigiPublisherBase.

◆ tick()

virtual void makVre::DtCigiViewControlPublisher::tick ( double dt)
overridevirtual

Reimplemented from makVre::DtCigiPublisherBase.

◆ attachedTo()

virtual DtCigiSimEntityPublisher::Sptr makVre::DtCigiViewControlPublisher::attachedTo ( )
virtual

◆ updateCigi()

virtual void makVre::DtCigiViewControlPublisher::updateCigi ( )
overrideprotectedvirtual

Derived Publisher classes should override updateCigi() to update values in the CIGI data.

If shared data is used, the expected pattern is to copy values from shared data into CIGI data at this point. updateShared() is called, if necessary, before updateCigi() so that shared data contains the most recent object state.

updateCigi() is called during publish(), before write(). updateCigi() is expected to set the dirty flag true if there are changes to the CIGI data. write() will be called only if this Publisher is marked dirty.

Reimplemented from makVre::DtCigiPublisherBase.

◆ config()

virtual ConfigPtr makVre::DtCigiViewControlPublisher::config ( )
protectedvirtual

◆ attachTo()

virtual void makVre::DtCigiViewControlPublisher::attachTo ( DtCigiSimEntityPublisher::Sptr entity)
protectedvirtual

◆ detach()

virtual void makVre::DtCigiViewControlPublisher::detach ( )
protectedvirtual

◆ cacheDefinitionConsensus()

virtual void makVre::DtCigiViewControlPublisher::cacheDefinitionConsensus ( )
protectedvirtual

◆ processDetonationEvent()

virtual void makVre::DtCigiViewControlPublisher::processDetonationEvent ( const makVrfEvents::DtEvent & event)
protectedvirtual

◆ processFireEvent()

virtual void makVre::DtCigiViewControlPublisher::processFireEvent ( const makVrfEvents::DtEvent & event)
protectedvirtual

◆ initCigi()

virtual void makVre::DtCigiViewControlPublisher::initCigi ( )
overrideprotectedvirtual

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

Reimplemented from makVre::DtCigiPublisherBase.

Member Data Documentation

◆ myAssociatedDefinition

DtCigiPublisherBase::Sptr makVre::DtCigiViewControlPublisher::myAssociatedDefinition
protected

◆ myConfigMsg

ConfigPtr makVre::DtCigiViewControlPublisher::myConfigMsg
protected

◆ myIdsSet

bool makVre::DtCigiViewControlPublisher::myIdsSet
protected

◆ myAttachEntity

DtCigiSimEntityPublisher::Sptr makVre::DtCigiViewControlPublisher::myAttachEntity
protected

◆ myEntitiesInView

EntityList makVre::DtCigiViewControlPublisher::myEntitiesInView
protected

◆ myMaxViewDistance

double makVre::DtCigiViewControlPublisher::myMaxViewDistance
protected

◆ myMaxFireFxDistance

double makVre::DtCigiViewControlPublisher::myMaxFireFxDistance
protected

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